POST api/v4/Shipments/Pack

This method enables recording information about a single Order Item to be packed in a specific Shipment.

Request Parameters

shipmentPackRequest: object of type ShipmentPackRequest

ShipmentPackRequest

Name	Description Usage	Type Allowed values	Required?
shipmentItemPackEdit	Details about the item to be packed	Object of type ShipmentItemPackEdit	yes

ShipmentItemPackEdit

Name	Description Usage	Type Allowed values	Required?
orderNumber	Unique identifier of the Order	String	yes
shipmentNumber	Unique identifier of the package/shipment to which the item being packed should be assigned.	Integer	yes
shipmentCreateNew	If set to true, this will create a new package and pack the requested item in that new package, returning the shipmentNumber that identifies the new package in the response	Boolean	no
shipmentItemLocator	Information to be used in locating the item being packed	Object of type ShipmentItemLocator	yes
shipmentItemSerialNumber	Serial number of the item being packed, if applicable	String	no
shipmentItemQuantity	Quantity to be packed. If not supplied, will default to 1.	Integer	no

ShipmentItemLocator

Name	Description Usage	Type Allowed values	Required?
shipmentItemSku	SKU of the item	String	no
shipmentItemHostSku	SKU of the item	String	no
shipmentItemGTIN	Global Trade Item Number	String	no

Response Parameters

shipmentPackResponse: object of type ShipmentPackResponse

ShipmentPackResponse

Name	Description Usage	Type Allowed values	Required?
shipmentItemPackEditResult	Details about the result of the pack request for an item	Object of type ShipmentItemPackEditResult	yes
sessionToken	Session token to be used for maintaining session state across batch operations.	String	yes
baseSystemVersion	Indicates the version of the underlying Store Fulfillment core application.	String	yes

ShipmentItemPackEditResult

Name	Description Usage	Type Allowed values	Required?
orderNumber	Unique identifier of the Order	String	yes
shipmentNumber	Unique identifier of the package/shipment to which the item being packed was assigned.	Integer	no
orderItemLineId	Unique identifier of the Order Line to which the packed item was linked.	Integer	no
shipmentItemHasErrors	Indicates if an error occurred processing the request	Boolean	yes
shipmentItemErrorMessage	If an error occurred in the request processing, that will be detailed here.	String	no
shipmentItemErrors	Collection of errors relating to this specific Shipment Item	Array of ShipmentError	no

ShipmentError

Name	Description Usage	Type Allowed values	Required?
shipmentErrorNumber	Error number	Integer	no
shipmentErrorMessage	Description of the error	String	yes
shipmentErrorIsWarning	Boolean indicator (in string format) if the error severity is only a warning	String	yes

Example - Pack-check an item

XML Request

Authorization: Basic dGVzdHNuMTp0ZXN0c24xOkFZMTA1TVVQODdROTBRU0Q=
Content-Type: application/xml; charset=utf-8
Accept: application/xml

<ShipmentPackRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <shipmentItemPackEdit>
      <orderNumber>abb75866ea09449a8d661678c8049c8f</orderNumber>
      <shipmentCreateNew>false</shipmentCreateNew>
      <shipmentItemLocator>
         <shipmentItemGTIN i:nil="true" />
         <shipmentItemHostSku i:nil="true" />
         <shipmentItemSku>GNUNQGDLV</shipmentItemSku>
      </shipmentItemLocator>
      <shipmentItemQuantity i:nil="true" />
      <shipmentItemSerialNumber i:nil="true" />
      <shipmentNumber>1</shipmentNumber>
   </shipmentItemPackEdit>
</ShipmentPackRequest>

XML Response

<ShipmentPackResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <baseSystemVersion>45</baseSystemVersion>
   <sessionToken>AY105MUP87Q90QSD</sessionToken>
   <shipmentItemPackEditResult>
      <orderItemLineId>1</orderItemLineId>
      <orderNumber>abb75866ea09449a8d66</orderNumber>
      <shipmentItemErrorMessage i:nil="true" />
      <shipmentItemErrors />
      <shipmentItemHasErrors>false</shipmentItemHasErrors>
      <shipmentNumber>1</shipmentNumber>
   </shipmentItemPackEditResult>
</ShipmentPackResponse>

JSON Request

Authorization: Basic dGVzdHNuMTp0ZXN0c24xOkdXNDdHMUZBQkM3OFlBWjc=

{
   "shipmentItemPackEdit": {
      "orderNumber": "031de848760d4be18b86430751b0ef29",
      "shipmentNumber": 1,
      "shipmentCreateNew": false,
      "shipmentItemLocator": {
         "shipmentItemSku": "SYHXERUXGHNCOGNLX",
         "shipmentItemHostSku": null,
         "shipmentItemGTIN": null
      },
      "shipmentItemSerialNumber": null,
      "shipmentItemQuantity": null
   }
}

JSON Response

{
   "orderNumber": "031de848760d4be18b86",
   "shipmentNumber": 1,
   "orderItemLineId": 1,
   "shipmentItemHasErrors": false,
   "shipmentItemErrorMessage": null,
   "shipmentItemErrors": []
},
"sessionToken": "GW47G1FABC78YAZ7",
"baseSystemVersion": "45"
}