POST orders/{orderKey}/courier-despatch

Despatch an order with a courier

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderKey Unique identifier - either OrderNumber or OrderGuid string Required

Body Parameters

CourierDespatchSettings

None.

Request Formats

application/json, text/json

Sample: 
{}

application/xml, text/xml

Sample: 
<CourierDespatchSettings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />

Response Information

Resource Description

Despatch an order with a courier

CourierDespatchResponse
NameDescriptionTypeAdditional information
CourierLabelUrl If successful, the courier label will be here string None.
Cn22Url If successful, and necessary, the URL of the CN22 will show here string None.
Cn23Url If successful, and necessary, the URL of the CN23 will show here string None.
TrackingNumbers If any, tracking numbers will show here Collection of string None.
TrackingUrls If any, tracking URLs will show here Collection of string None.
ErrorMessages If anything goes wrong with the operation, error messages will appear here in a human readable format Collection of string None.
Message A single human readable message string None.
ErrorCode A machine readable error code string None.

Response Formats

application/json, text/json

Sample: 
{
  "CourierLabelUrl": "https://example.com/123456/label.pdf",
  "Cn22Url": "https://example.com/123456/cn22.pdf",
  "Cn23Url": "https://example.com/123456/cn23.pdf",
  "TrackingNumbers": [
    "1234abcd",
    "4567efgh"
  ],
  "TrackingUrls": [
    "https://example.com/track/1234abcd",
    "https://example.com/track/4567efgh"
  ],
  "ErrorMessages": [
    "Human readable error message 1",
    "Human readable error message 2"
  ],
  "Message": "Order despatched successfully",
  "ErrorCode": "ERROR_CODE"
}