POST api/Piece/Update
Request Information
URI Parameters
None.
Body Parameters
UpdateShipmentPieceParmName | Description | Type | Additional information |
---|---|---|---|
auth | string |
None. |
|
ShipmentPieceID | integer |
None. |
|
Contents | string |
None. |
|
Reference | string |
None. |
|
Weight | decimal number |
None. |
|
DimWeight | decimal number |
None. |
|
WeightUOM | string |
None. |
|
Length | integer |
None. |
|
Width | integer |
None. |
|
Height | integer |
None. |
|
SizeUOM | string |
None. |
|
PackagingType | string |
None. |
|
DeclaredValue | decimal number |
None. |
|
DeclaredValueCurrencyID | string |
None. |
|
BagGUID | string |
None. |
|
BagGUID2 | string |
None. |
|
oBagGUID | string |
None. |
|
oBagGUID2 | string |
None. |
|
CountryOfOrigin | string |
None. |
|
HSCode | string |
None. |
|
Quantity | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "auth": "sample string 1", "ShipmentPieceID": 2, "Contents": "sample string 3", "Reference": "sample string 4", "Weight": 1.0, "DimWeight": 1.0, "WeightUOM": "sample string 5", "Length": 1, "Width": 1, "Height": 1, "SizeUOM": "sample string 6", "PackagingType": "sample string 7", "DeclaredValue": 1.0, "DeclaredValueCurrencyID": "sample string 8", "BagGUID": "sample string 9", "BagGUID2": "sample string 10", "oBagGUID": "sample string 11", "oBagGUID2": "sample string 12", "CountryOfOrigin": "sample string 13", "HSCode": "sample string 14", "Quantity": 1 }
application/xml, text/xml
Sample:
<UpdateShipmentPieceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <BagGUID>sample string 9</BagGUID> <BagGUID2>sample string 10</BagGUID2> <Contents>sample string 3</Contents> <CountryOfOrigin>sample string 13</CountryOfOrigin> <DeclaredValue>1</DeclaredValue> <DeclaredValueCurrencyID>sample string 8</DeclaredValueCurrencyID> <DimWeight>1</DimWeight> <HSCode>sample string 14</HSCode> <Height>1</Height> <Length>1</Length> <PackagingType>sample string 7</PackagingType> <Quantity>1</Quantity> <Reference>sample string 4</Reference> <ShipmentPieceID>2</ShipmentPieceID> <SizeUOM>sample string 6</SizeUOM> <Weight>1</Weight> <WeightUOM>sample string 5</WeightUOM> <Width>1</Width> <auth>sample string 1</auth> <oBagGUID>sample string 11</oBagGUID> <oBagGUID2>sample string 12</oBagGUID2> </UpdateShipmentPieceParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBaseName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful | boolean |
None. |
|
ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>