Dispatch Shipment

Shipment Dispatched(shipped)

POST https://wms.eshopbox.com/api//unicommerce/orders/dispatch

This endpoint allows you to mark the shipment status dispatch.

Headers

Name	Type	Description
Authentication	string	The Bearer token which grants access to the API

Request Body

Name	Type	Description
orderItems	array	the order items detailed array
selfShipping	object	courier details object

200 Cake successfully retrieved.

{
    "status": "SUCCESS",
    "orderItems": [
        {
            "orderItemID": "408-3131237-0000110-67"
        },
        {
            "orderItemID": "408-3131237-0000110-68"
        }
    ]
}

The orderItems array[object]

Attribute	Type	Description
orderItemId	string	unique generated id by eshopbox
quantity	number	item quantity
taxRate	number	the tax rate on the item
centralGstPercentage	number	central GST percentage on the item
compensationCessPercentage	number	compensation cess percentage
integratedGstPercentage	number	integrated GST percentage
stateGstPercentage	number	state GST percentage
unionTerritoryGstPercentage	number	union territory GST percentage

The selfShipping object

Attribute	Type	Description
deliveryPartner	string	courier name
dispatchDate	string	shipment dispatch date
invoiceDate	string	date on which invoice is generated
invoiceNumber	string	invoice number of a shipment (generated at the time of packed )
tentativeDeliveryDate	string	tentative delivery date
trackingId	string	shipment tracking id

curl --location --request POST 'https://wms.eshopbox.com/api//unicommerce/orders/dispatch' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--data-raw '{
  "orderItems": [
    
    {
      "orderItemId": "408-3131237-0000110-67",
      "quantity": 1,
      "centralGstPercentage": 0,
      "compensationCessPercentage": 0,
      "integratedGstPercentage": 0,
      "stateGstPercentage": 0,
      "taxRate": 0,
      "unionTerritoryGstPercentage": 0
    },{
      "orderItemId": "408-3131237-0000110-68",
      "quantity": 1,
      "centralGstPercentage": 0,
      "compensationCessPercentage": 0,
      "integratedGstPercentage": 0,
      "stateGstPercentage": 0,
      "taxRate": 0,
      "unionTerritoryGstPercentage": 0
    }
  ],
  "selfShipping": {
    "deliveryPartner": "ecomExpress",
    "dispatchDate": "2017-01-02T08:12:53",
    "invoiceDate": "2017-01-02T08:12:53",
    "invoiceNumber": "string",
    "tentativeDeliveryDate": "2017-01-02T08:12:53",
    "trackingId": "123455"
  }
}'