POST api/v4/Shipments/ConfirmPending

This method will commit any Order Item(s) that have been marked as packed.

Request Parameters

shipmentConfirmPendingRequest: object of type ShipmentConfirmPendingRequest

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

shipmentIgnoreWarnings

Indicates if errors that are only warnings should be ignored when confirming

Boolean

Response Parameters

shipmentConfirmPendingResponse: object of type ShipmentConfirmPendingResponse

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
shipmentErrors	Collection of errors relating to this specific Shipment Item	Array of ShipmentError	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 - Confirm all pack-checked items pending confirmation

XML Request

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

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

XML Response

<ShipmentConfirmPendingResponse 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>
   <shipmentErrorMessage i:nil="true" />
   <shipmentErrors />
   <shipmentHasErrors>false</shipmentHasErrors>
   <shipmentPendingRecordType>Pack</shipmentPendingRecordType>
</ShipmentConfirmPendingResponse>

JSON Request

Authorization: Basic dGVzdHNuMTp0ZXN0c24xOkdXNDdHMUZBQkM3OFlBWjc=

{
   "shipmentPendingRecordType": 0,
   "shipmentIgnoreWarnings": false
}

JSON Response

{
   "shipmentPendingRecordType": 0,
   "shipmentHasErrors": false,
   "shipmentErrorMessage": null,
   "shipmentErrors": [],
   "sessionToken": "GW47G1FABC78YAZ7",
   "baseSystemVersion": "45"
}