POST api/v1/Despatch

Retrieve a list of despatches for a specific order or time frame
You can send either order number or order ID dending on what you have stored

Request Information

URI Parameters

None.

Body Parameters

DespatchParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
DespatchedSince	List despatches on and since YYYYMMDD. If supplied empty then all despatches will be returned	string	None.
OnlyNewOnes	If true, only include despatches made since last call to this API	boolean	None.
OrderID	Return all despatches for a specific order ID	integer	None.
OrderNo	Return all despatches for a specific order number	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "DespatchedSince": "sample string 1",
  "OnlyNewOnes": true,
  "OrderID": 3,
  "OrderNo": 4,
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample:

<DespatchParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DespatchedSince>sample string 1</DespatchedSince>
  <OnlyNewOnes>true</OnlyNewOnes>
  <OrderID>3</OrderID>
  <OrderNo>4</OrderNo>
  <apiKey>sample string 1</apiKey>
</DespatchParams>

Response Information

Resource Description

Returns:
200 OK Returns a collection of despatches
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if the requested filters dont match any data 503 Service Unavailable

Despatches

Name	Description	Type	Additional information
DespatchList		Collection of Despatch	None.

Response Formats

application/json, text/json

Sample:

{
  "DespatchList": [
    {
      "DespatchNo": 1,
      "OrderID": 2,
      "OrderNo": 3,
      "AccountNo": "sample string 4",
      "AccountID": 5,
      "ChannelID": 6,
      "WebOrderRef": "sample string 7",
      "DespatchMethodID": 8,
      "DespatchMethodName": "sample string 9",
      "CarrierRef": "sample string 10",
      "CarrierName": "sample string 11",
      "TrackingURL": "sample string 12",
      "DespDate": "sample string 13",
      "DocID": 14,
      "DespLines": {
        "DespLine": [
          {
            "ID": 1,
            "Code": "sample string 2",
            "Description": "sample string 3",
            "Qty": 4
          },
          {
            "ID": 1,
            "Code": "sample string 2",
            "Description": "sample string 3",
            "Qty": 4
          }
        ]
      }
    },
    {
      "DespatchNo": 1,
      "OrderID": 2,
      "OrderNo": 3,
      "AccountNo": "sample string 4",
      "AccountID": 5,
      "ChannelID": 6,
      "WebOrderRef": "sample string 7",
      "DespatchMethodID": 8,
      "DespatchMethodName": "sample string 9",
      "CarrierRef": "sample string 10",
      "CarrierName": "sample string 11",
      "TrackingURL": "sample string 12",
      "DespDate": "sample string 13",
      "DocID": 14,
      "DespLines": {
        "DespLine": [
          {
            "ID": 1,
            "Code": "sample string 2",
            "Description": "sample string 3",
            "Qty": 4
          },
          {
            "ID": 1,
            "Code": "sample string 2",
            "Description": "sample string 3",
            "Qty": 4
          }
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:

<Despatches xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Despatch>
    <DespatchNo>1</DespatchNo>
    <OrderID>2</OrderID>
    <OrderNo>3</OrderNo>
    <AccountNo>sample string 4</AccountNo>
    <AccountID>5</AccountID>
    <ChannelID>6</ChannelID>
    <WebOrderRef>sample string 7</WebOrderRef>
    <DespatchMethodID>8</DespatchMethodID>
    <DespatchMethodName>sample string 9</DespatchMethodName>
    <CarrierRef>sample string 10</CarrierRef>
    <CarrierName>sample string 11</CarrierName>
    <TrackingURL>sample string 12</TrackingURL>
    <DespDate>sample string 13</DespDate>
    <DocID>14</DocID>
    <DespLines>
      <DespLine>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Qty>4</Qty>
      </DespLine>
      <DespLine>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Qty>4</Qty>
      </DespLine>
    </DespLines>
  </Despatch>
  <Despatch>
    <DespatchNo>1</DespatchNo>
    <OrderID>2</OrderID>
    <OrderNo>3</OrderNo>
    <AccountNo>sample string 4</AccountNo>
    <AccountID>5</AccountID>
    <ChannelID>6</ChannelID>
    <WebOrderRef>sample string 7</WebOrderRef>
    <DespatchMethodID>8</DespatchMethodID>
    <DespatchMethodName>sample string 9</DespatchMethodName>
    <CarrierRef>sample string 10</CarrierRef>
    <CarrierName>sample string 11</CarrierName>
    <TrackingURL>sample string 12</TrackingURL>
    <DespDate>sample string 13</DespDate>
    <DocID>14</DocID>
    <DespLines>
      <DespLine>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Qty>4</Qty>
      </DespLine>
      <DespLine>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Qty>4</Qty>
      </DespLine>
    </DespLines>
  </Despatch>
</Despatches>