POST api/v1/APACDespatchConfirm

APAC Specific - Allows updating of Caliq despatch data
API_Key required in header

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
OrderID	ID of the order/pick trip including any prefix	string	None.
DespatchMethodID	If not null or zero this despatch mthod will be set on the shipment	integer	None.
TrackingNumber	Tracking number	string	Max length: 200
TrackingURL	Full tracking URL	string	Max length: 300

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "OrderID": "sample string 2",
  "DespatchMethodID": 1,
  "TrackingNumber": "sample string 3",
  "TrackingURL": "sample string 4"
}

application/xml, text/xml

Sample:

<APACDESPParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <OrderID>sample string 2</OrderID>
  <DespatchMethodID>1</DespatchMethodID>
  <TrackingNumber>sample string 3</TrackingNumber>
  <TrackingURL>sample string 4</TrackingURL>
</APACDESPParams>

Response Information

Resource Description

APACDESPResults

Name	Description	Type	Additional information
APACDESPResultsData		APACDESPResultsData	None.

Response Formats

application/json, text/json

Sample:

{
  "APACDESPResultsData": {
    "OK": true,
    "APACDESPIssues": [
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      },
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<APACDESPResults xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APACDESPResultsData>
    <OK>true</OK>
    <APACDESPIssues>
      <APACDESPIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </APACDESPIssue>
      <APACDESPIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </APACDESPIssue>
    </APACDESPIssues>
  </APACDESPResultsData>
</APACDESPResults>