POST api/v4/Shipments/Ship

This method can be used to Ship (or mark picked up for ISPU) one or more Shipments for one or more Orders.

Request Parameters

shipmentsShipRequest: object of type ShipmentsShipRequest

ShipmentsShipRequest

Name	Description Usage	Type Allowed values	Required?
shipmentEdits	Collection of information about the Shipment(s) to be shipped and/or cancelled	Array of ShipmentEdit	yes

ShipmentEdit

Name	Description Usage	Type Allowed values	Required?
orderNumber	Unique identifier of the order within the Store Fulfillment application	String	yes
orderPackageReference	Reference information about this specific package	String	no
shipmentPackageTrackingNumber	Tracking number, if available/applicable	String	no
shipmentPackageShipMethod	Ship method of this package	String	no
shipmentPackageFreight	Freight of this package	Decimal	no
shipmentPackageWeight	Weight of this package	Decimal	no
shipmentPackageDryIce	Dry ice weight of this package	Decimal	no
shipmentPackageBoxSize	Box size of this package	String	no
shipmentNumber	Unique identifier of the package/shipment	Integer	no
shipmentConfirmPending	Indicates if the request should be processed immediately or in batch mode	Boolean	no
shipmentReasonCode	Header level reason code to justify any partial shipments/cancels	String	no
shipmentItemEdits	Collection of items within this shipment	Array of ShipmentItemEdit	no
shipmentAttributes	not implemented – future use.	Array of Attribute	no

ShipmentItemEdit

Name	Description Usage	Type Allowed values	Required?
orderItemLineId	Unique order line item identifier within Store Fulfillment	Integer	yes
shipmentItemSku	not implemented – future use	String	no
shipmentItemUPC	not implemented – future use	String	no
shipmentItemQuantityShip	Quantity of this item to be shipped	Integer	yes
shipmentItemQuantityHold	not implemented – future use	Integer	no
shipmentItemQuantityCancel	Quantity of this item to be cancelled	Integer	no
shipmentItemCancelReasonCode	Item level reason code to justify any partial shipments/cancels	String	no
shipmentItemSerialNumbers	Serial number of the item being shipped, if applicable	Array of String	no
shipmentItemAttributes	not implemented – future use.	Array of Attribute	no

Response Parameters

shipmentsShipResponse: object of type ShipmentsShipResponse

ShipmentsShipResponse

Name	Description Usage	Type Allowed values	Required?
shipmentEditResults	Collection of information about the Request result of the Shipment(s) to be shipped and/or cancelled	Array of ShipmentEditResult	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

ShipmentEditResult

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
shipmentHasErrors	Indicates if an error occurred processing the request	Boolean	yes
shipmentErrorMessage	If an error occurred in the request processing, that will be detailed here.	String	no
shipmentErrors	Collection of errors relating to this specific pending batch	Array of ShipmentError	no
shipmentReceiptURL	not implemented – future use.	String	no
shipmentAttributes	not implemented – future use.	Array of Attribute	no

Example - Confirm full or partial pickup of an ISPU Order

XML Request

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

<ShipmentShipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <shipments>
      <ShipmentEdit>
         <orderNumber>77ad3c8484724e1a961263428411b866</orderNumber>
         <orderPackageReference i:nil="true" />
         <shipmentAttributes i:nil="true" />
         <shipmentConfirmPending i:nil="true" />
         <shipmentItems>
            <ShipmentItemEdit>
               <orderItemLineId>1</orderItemLineId>
               <shipmentItemAttributes i:nil="true" />
               <shipmentItemCancelReasonCode i:nil="true" />
               <shipmentItemQuantityCancel>0</shipmentItemQuantityCancel>
               <shipmentItemQuantityHold>0</shipmentItemQuantityHold>
               <shipmentItemQuantityShip>4</shipmentItemQuantityShip>
               <shipmentItemSerialNumbers 
                  xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
               <shipmentItemSku i:nil="true" />
               <shipmentItemUPC i:nil="true" />
            </ShipmentItemEdit>
            <ShipmentItemEdit>
               <orderItemLineId>2</orderItemLineId>
               <shipmentItemAttributes i:nil="true" />
               <shipmentItemCancelReasonCode i:nil="true" />
               <shipmentItemQuantityCancel>0</shipmentItemQuantityCancel>
               <shipmentItemQuantityHold>0</shipmentItemQuantityHold>
               <shipmentItemQuantityShip>4</shipmentItemQuantityShip>
               <shipmentItemSerialNumbers 
                  xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
               <shipmentItemSku i:nil="true" />
               <shipmentItemUPC i:nil="true" />
            </ShipmentItemEdit>
         </shipmentItems>
         <shipmentNumber>0</shipmentNumber>
         <shipmentPackageBoxSize i:nil="true" />
         <shipmentPackageDryIce i:nil="true" />
         <shipmentPackageFreight i:nil="true" />
         <shipmentPackageShipMethod i:nil="true" />
         <shipmentPackageTrackingNumber i:nil="true" />
         <shipmentPackageWeight i:nil="true" />
         <shipmentReasonCode i:nil="true" />
      </ShipmentEdit>
   </shipments>
</ShipmentShipRequest>

XML Response

<ShipmentShipResponse 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>EB3M1RP4WCV3O3IR</sessionToken>
   <shipmentEditResults>
      <ShipmentEditResult>
         <orderNumber>77ad3c8484724e1a961263428411b866</orderNumber>
         <shipmentAttributes />
         <shipmentErrorMessage i:nil="true" />
         <shipmentErrors />
         <shipmentHasErrors>false</shipmentHasErrors>
         <shipmentNumber>1</shipmentNumber>
         <shipmentReceiptURL i:nil="true" />
      </ShipmentEditResult>
   </shipmentEditResults>
</ShipmentShipResponse>

JSON Request

Authorization: Basic U2VydmljZTpzZXJ2aWNlOg==

{
   "shipmentEdits": [{
      "orderNumber": "122322e69c544d0fb6d0f48ed9d87c6f",
      "orderPackageReference": null,
      "shipmentPackageTrackingNumber": null,
      "shipmentPackageShipMethod": null,
      "shipmentPackageFreight": null,
      "shipmentPackageWeight": null,
      "shipmentPackageDryIce": null,
      "shipmentPackageBoxSize": null,
      "shipmentNumber": 1,
      "shipmentConfirmPending": null,
      "shipmentReasonCode": null,
      "shipmentItemEdits": [{
         "orderItemLineId": 1,
         "shipmentItemSku": null,
         "shipmentItemUPC": null,
         "shipmentItemQuantityShip": 4,
         "shipmentItemQuantityHold": 0,
         "shipmentItemQuantityCancel": 0,
         "shipmentItemCancelReasonCode": null,
         "shipmentItemSerialNumbers": null,
         "shipmentItemAttributes": null
      },
      {
         "orderItemLineId": 2,
         "shipmentItemSku": null,
         "shipmentItemUPC": null,
         "shipmentItemQuantityShip": 4,
         "shipmentItemQuantityHold": 0,
         "shipmentItemQuantityCancel": 0,
         "shipmentItemCancelReasonCode": null,
         "shipmentItemSerialNumbers": null,
         "shipmentItemAttributes": null
      }],
      "shipmentAttributes": null
   }]
}

JSON Response

{
   "shipmentEditResults": [{
      "orderNumber": "122322e69c544d0fb6d0f48ed9d87c6f",
      "shipmentNumber": 1,
      "shipmentHasErrors": false,
      "shipmentErrorMessage": null,
      "shipmentErrors": [],
      "shipmentReceiptURL": null,
      "shipmentAttributes": []
   }],
   "sessionToken": "I1TRS34M3TESSD5M",
   "baseSystemVersion": "45"
}

Example - Fully cancel ISPU Order at pickup

XML Request

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

<ShipmentShipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <shipments>
      <ShipmentEdit>
         <orderNumber>44592</orderNumber>
         <orderPackageReference i:nil="true" />
         <shipmentAttributes i:nil="true" />
         <shipmentConfirmPending i:nil="true" />
         <shipmentReasonCode>CR</shipmentReasonCode>
         <shipmentItems>
            <ShipmentItemEdit>
               <orderItemLineId>1</orderItemLineId>
               <shipmentItemAttributes i:nil="true" />
               <shipmentItemCancelReasonCode i:nil="true" />
               <shipmentItemQuantityCancel>4</shipmentItemQuantityCancel>
               <shipmentItemQuantityHold>0</shipmentItemQuantityHold>
               <shipmentItemQuantityShip>0</shipmentItemQuantityShip>
               <shipmentItemSerialNumbers 
                  xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
               <shipmentItemSku i:nil="true" />
               <shipmentItemUPC i:nil="true" />
            </ShipmentItemEdit>
            <ShipmentItemEdit>
               <orderItemLineId>2</orderItemLineId>
               <shipmentItemAttributes i:nil="true" />
               <shipmentItemCancelReasonCode i:nil="true" />
               <shipmentItemQuantityCancel>4</shipmentItemQuantityCancel>
               <shipmentItemQuantityHold>0</shipmentItemQuantityHold>
               <shipmentItemQuantityShip>0</shipmentItemQuantityShip>
               <shipmentItemSerialNumbers 
                  xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
               <shipmentItemSku i:nil="true" />
               <shipmentItemUPC i:nil="true" />
            </ShipmentItemEdit>
         </shipmentItems>
         <shipmentNumber>0</shipmentNumber>
         <shipmentPackageBoxSize i:nil="true" />
         <shipmentPackageDryIce i:nil="true" />
         <shipmentPackageFreight i:nil="true" />
         <shipmentPackageShipMethod i:nil="true" />
         <shipmentPackageTrackingNumber i:nil="true" />
         <shipmentPackageWeight i:nil="true" />
         <shipmentReasonCode i:nil="true" />
      </ShipmentEdit>
   </shipments>
</ShipmentShipRequest>

XML Response

<ShipmentShipResponse 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>EB3M1RP4WCV3O3IR</sessionToken>
   <shipmentEditResults>
      <ShipmentEditResult>
         <orderNumber>44592</orderNumber>
         <shipmentAttributes />
         <shipmentErrorMessage i:nil="true" />
         <shipmentErrors />
         <shipmentHasErrors>false</shipmentHasErrors>
         <shipmentNumber>1</shipmentNumber>
         <shipmentReceiptURL i:nil="true" />
      </ShipmentEditResult>
   </shipmentEditResults>
</ShipmentShipResponse>

JSON Request

Authorization: Basic U2VydmljZTpzZXJ2aWNlOg==

{
   "shipmentEdits": [{
      "orderNumber": "41716",
      "shipmentNumber": 1,
      "shipmentConfirmPending": null,
      "shipmentReasonCode": "CR",
      "shipmentItemEdits": [{
         "orderItemLineId": 101,
         "shipmentItemSku": null,
         "shipmentItemUPC": null,
         "shipmentItemQuantityShip": 0,
         "shipmentItemQuantityHold": 0,
         "shipmentItemQuantityCancel": 1,
         "shipmentItemCancelReasonCode": null,
         "shipmentItemSerialNumbers": null,
         "shipmentItemAttributes": null
      }],
      "shipmentAttributes": null
   }]
}

JSON Response

{
       "shipmentEditResults": [
           {
               "orderNumber": "41716",
               "shipmentNumber": null,
               "shipmentHasErrors": false,
               "shipmentErrorMessage": null,
               "shipmentErrors": [],
               "shipmentReceiptURL": null,
               "shipmentAttributes": []
           }
    ],
       "sessionToken": "UCVIN3E17AIXYWAW",
       "baseSystemVersion": "45"
}

Example - Ship complete an SFS Order

XML Request

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

<ShipmentShipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <shipments>
      <ShipmentEdit>
         <orderNumber>234924</orderNumber>
         <orderPackageReference i:nil="true" />
         <shipmentAttributes i:nil="true" />
         <shipmentConfirmPending i:nil="true" />
         <shipmentItems>
            <ShipmentItemEdit>
               <orderItemLineId>1</orderItemLineId>
               <shipmentItemAttributes i:nil="true" />
               <shipmentItemCancelReasonCode i:nil="true" />
               <shipmentItemQuantityCancel>0</shipmentItemQuantityCancel>
               <shipmentItemQuantityHold>0</shipmentItemQuantityHold>
               <shipmentItemQuantityShip>4</shipmentItemQuantityShip>
               <shipmentItemSerialNumbers 
                  xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
               <shipmentItemSku i:nil="true" />
               <shipmentItemUPC i:nil="true" />
            </ShipmentItemEdit>
            <ShipmentItemEdit>
               <orderItemLineId>2</orderItemLineId>
               <shipmentItemAttributes i:nil="true" />
               <shipmentItemCancelReasonCode i:nil="true" />
               <shipmentItemQuantityCancel>0</shipmentItemQuantityCancel>
               <shipmentItemQuantityHold>0</shipmentItemQuantityHold>
               <shipmentItemQuantityShip>4</shipmentItemQuantityShip>
               <shipmentItemSerialNumbers 
                  xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
               <shipmentItemSku i:nil="true" />
               <shipmentItemUPC i:nil="true" />
            </ShipmentItemEdit>
         </shipmentItems>
         <shipmentNumber>0</shipmentNumber>
         <shipmentPackageBoxSize i:nil="true" />
         <shipmentPackageDryIce i:nil="true" />
         <shipmentPackageFreight i:nil="true" />
         <shipmentPackageShipMethod i:nil="true" />
         <shipmentPackageTrackingNumber i:nil="true" />
         <shipmentPackageWeight i:nil="true" />
         <shipmentReasonCode i:nil="true" />
      </ShipmentEdit>
   </shipments>
</ShipmentShipRequest>

XML Response

<ShipmentShipResponse 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>EB3M1RP4WCV3O3IR</sessionToken>
   <shipmentEditResults>
      <ShipmentEditResult>
         <orderNumber>234924</orderNumber>
         <shipmentAttributes />
         <shipmentErrorMessage i:nil="true" />
         <shipmentErrors />
         <shipmentHasErrors>false</shipmentHasErrors>
         <shipmentNumber>1</shipmentNumber>
         <shipmentReceiptURL i:nil="true" />
      </ShipmentEditResult>
   </shipmentEditResults>
</ShipmentShipResponse>

JSON Request

Authorization: Basic MTk4NToxOTg1Og==

{
   "shipmentEdits": [{
      "orderNumber": "999ARSFS1120-06",
      "orderPackageReference": null,
      "shipmentPackageTrackingNumber": null,
      "shipmentPackageShipMethod": null,
      "shipmentPackageFreight": null,
      "shipmentPackageWeight": null,
      "shipmentPackageDryIce": null,
      "shipmentPackageBoxSize": null,
      "shipmentNumber": 1,
      "shipmentConfirmPending": null,
      "shipmentReasonCode": null,
      "shipmentItemEdits": [{
         "orderItemLineId": 10,
         "shipmentItemSku": "900300A",
         "shipmentItemUPC": null,
         "shipmentItemQuantityShip": 5,
         "shipmentItemQuantityHold": 0,
         "shipmentItemQuantityCancel": 0,
         "shipmentItemCancelReasonCode": null,
         "shipmentItemSerialNumbers": null,
         "shipmentItemAttributes": null
      },{
         "orderItemLineId": 20,
         "shipmentItemSku": "2929002",
         "shipmentItemUPC": null,
         "shipmentItemQuantityShip": 1,
         "shipmentItemQuantityHold": 0,
         "shipmentItemQuantityCancel": 0,
         "shipmentItemCancelReasonCode": null,
         "shipmentItemSerialNumbers": null,
         "shipmentItemAttributes": null
      }],
      "shipmentAttributes": null
   }]
}

JSON Response

{
    "shipmentEditResults": [
        {
            "orderNumber": "999ARSFS1120-06",
            "shipmentNumber": 1,
            "shipmentHasErrors": false,
            "shipmentErrorMessage": null,
            "shipmentErrors": [],
            "shipmentReceiptURL": null,
            "shipmentAttributes": []
        }
    ],
    "sessionToken": "D03G3TXASG706YYE",
    "baseSystemVersion": "45"
}