Description - The Shipment Dispatch API marks order items inside shipment as “Ready to Dispatch” and communicates to the logistics partners that the shipment is ready for pick up.

Request and Response Parameters



Request Body Parameter

Parameter/Attribute Type Requirement Description
shipmentIds List<String> Mandatory List of shipment ids
locationId String Mandatory Seller’s location id from where item is dispatched


ShipmentIds and location Id are mandatory

Response Body Parameters

Parameter/Attribute Type Description
shipments. shipmentId String Primary identifier for a specific shipment.
shipments. processingStatus String SUCCESS or FAILURE
shipments. errorCode String Error code for any error
shipments. errorMessage String Error message

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED This error occurs if an internal system fails during v3/shipments/dispatch call