POST api/{ext}/shipmentpiece/Update

Use this method to update a Shipment Piece

Request Information

URI Parameters

Name	Description	Type	Additional information
ext		string	None.

Body Parameters

PieceParm

Name	Description	Type	Additional information
oBagGUID		string	None.
oBagGUID2		string	None.
ShipmentPieceID	The shipment piece id of the piece	integer	None.
ShipmentGUID	The shipment GUID of the piece	string	None.
OrderPieceGUID	The weight of the piece	string	None.
OrderGUID	The order guid of the piece	string	None.
Weight		decimal number	None.
DimWeight	The dim weight of the piece	decimal number	None.
WeightUOM	The weight unit (LB, KG)	string	Required Max length: 2
Length	The length of the piece	integer	None.
Width	The width of the piece	integer	None.
Height	The height of the piece	integer	None.
SizeUOM	The size of the piece (IN,CM)	string	Required Max length: 2
Contents	The contents of the piece	string	Max length: 50
Reference	The reference identifier for this piece (customer defined)	string	Max length: 50
ItemSKU	The declared value amount for this piece	string	None.
ItemValue	The item value for piece	decimal number	None.
DeclaredValue	The declared value for piece	decimal number	None.
DeclaredValueCurrencyID	The currency of the declared value (ie. EUR, USD, etc)	string	Required Max length: 3
HSCode	The harmonized code for this piece	string	None.
CountryOfOrigin	The origin country of manufacture for this piece (ie. US, GB, CH)	string	None.
TemperatureType	The temperature type (A=Ambient, D=dry ice, W=wet ice/gel pack)	string	None.
IsDangerousGoods	Is piece considered dangerous goods (true, false)	boolean	None.
IsRadioactive	Is piece considered radioactive (true, false)	boolean	None.
DgUNNumber	UN # for dangerous goods	string	None.
DgCommodityClass	Commodity class for dangerous goods	string	None.
DgProperName	Commodity proper name for dangerous goods	string	None.
Quantity		integer	None.
Count		integer	None.
PackagingType		string	None.
BagGUID		string	None.
BagGUID2		string	None.
OBagGUID		string	None.
OBagGUID2		string	None.

Request Formats

application/json, text/json

Sample:

{
  "oBagGUID": "sample string 1",
  "oBagGUID2": "sample string 2",
  "ShipmentPieceID": 3,
  "ShipmentGUID": "sample string 4",
  "OrderPieceGUID": "sample string 5",
  "OrderGUID": "sample string 6",
  "Weight": 1.0,
  "DimWeight": 1.0,
  "WeightUOM": "sample string 7",
  "Length": 1,
  "Width": 1,
  "Height": 1,
  "SizeUOM": "sample string 8",
  "Contents": "sample string 9",
  "Reference": "sample string 10",
  "ItemSKU": "sample string 11",
  "ItemValue": 12.0,
  "DeclaredValue": 1.0,
  "DeclaredValueCurrencyID": "sample string 13",
  "HSCode": "sample string 14",
  "CountryOfOrigin": "sample string 15",
  "TemperatureType": "sample string 16",
  "IsDangerousGoods": true,
  "IsRadioactive": true,
  "DgUNNumber": "sample string 19",
  "DgCommodityClass": "sample string 20",
  "DgProperName": "sample string 21",
  "Quantity": 1,
  "Count": 22,
  "PackagingType": "sample string 23",
  "BagGUID": "sample string 24",
  "BagGUID2": "sample string 25",
  "OBagGUID": "sample string 26",
  "OBagGUID2": "sample string 27"
}

application/xml, text/xml

Sample:

<PieceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.ShipperPortal.Models">
  <BagGUID>sample string 24</BagGUID>
  <BagGUID2>sample string 25</BagGUID2>
  <Contents>sample string 9</Contents>
  <Count>22</Count>
  <CountryOfOrigin>sample string 15</CountryOfOrigin>
  <DeclaredValue>1</DeclaredValue>
  <DeclaredValueCurrencyID>sample string 13</DeclaredValueCurrencyID>
  <DgCommodityClass>sample string 20</DgCommodityClass>
  <DgProperName>sample string 21</DgProperName>
  <DgUNNumber>sample string 19</DgUNNumber>
  <DimWeight>1</DimWeight>
  <HSCode>sample string 14</HSCode>
  <Height>1</Height>
  <IsDangerousGoods>true</IsDangerousGoods>
  <IsRadioactive>true</IsRadioactive>
  <ItemSKU>sample string 11</ItemSKU>
  <ItemValue>12</ItemValue>
  <Length>1</Length>
  <OBagGUID>sample string 26</OBagGUID>
  <OBagGUID2>sample string 27</OBagGUID2>
  <OrderGUID>sample string 6</OrderGUID>
  <OrderPieceGUID>sample string 5</OrderPieceGUID>
  <PackagingType>sample string 23</PackagingType>
  <Quantity>1</Quantity>
  <Reference>sample string 10</Reference>
  <ShipmentGUID>sample string 4</ShipmentGUID>
  <ShipmentPieceID>3</ShipmentPieceID>
  <SizeUOM>sample string 8</SizeUOM>
  <TemperatureType>sample string 16</TemperatureType>
  <Weight>1</Weight>
  <WeightUOM>sample string 7</WeightUOM>
  <Width>1</Width>
  <oBagGUID>sample string 1</oBagGUID>
  <oBagGUID2>sample string 2</oBagGUID2>
</PieceParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.