POST api/v4/Shipments/ClearPending

This method will clear any Order Item(s) that have been marked as packed but not yet confirmed via Shipments/ConfirmPending.

Request Parameters

shipmentClearPendingRequest: object of type ShipmentClearPendingRequest

Name

Description
Usage

Type
Allowed values

Required?

shipmentPendingRecordType

Indicates what type of pending records should be reported in the response

Enum supports integer or string:

Pack = 0

Ship = 1

yes

Response Parameters

shipmentClearPendingResponse: object of type ShipmentClearPendingResponse

Name	Description/usage	Type/allowed values	Required?
shipmentPendingRecordType	Indicates what type of pending records should be reported in the response	Enum supports integer or string: Pack = 0 Ship = 1	yes
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
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

Example - Clear any un-confirmed pack checked items

XML Request

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

<ShipmentClearPendingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <shipmentPendingRecordType>Pack</shipmentPendingRecordType>
</ShipmentClearPendingRequest>

XML Response

<ShipmentClearPendingResponse 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>0YNG0E9W2CC6XUQJ</sessionToken>
   <shipmentErrorMessage i:nil="true" />
   <shipmentHasErrors>false</shipmentHasErrors>
   <shipmentPendingRecordType>Pack</shipmentPendingRecordType>
</ShipmentClearPendingResponse>

JSON Request

Authorization: Basic dGVzdHNuMTp0ZXN0c24xOlhKVlFBNEZOOFBUN0k2SVk=

{
   "shipmentPendingRecordType": "Pack"
}

JSON Response

{
   "shipmentPendingRecordType": "Pack",
   "shipmentHasErrors": false,
   "shipmentErrorMessage": null,
   "sessionToken": "XJVQA4FN8PT7I6IY",
   "baseSystemVersion": "45"
}