GET orders/changelog/{token}

GET orders/changelog/{token}

Returns the list of orders modified from a token

Request

URL parameters

NameDescriptionTypeAdditionnal InformationIntro version
token Token corresponding to the previous call of this API bigint Required

Response

OrderChangeLogResult
NameDescriptionTypeAdditionnal InformationIntro version
order Modified order list Collection of OrderChangeLog
token Token of the last entry of this result. This token can be passed to the next call to this API to get the subsequent modified data string
count Number of entries in this lot integer
queuecount Number of remaining prices to retrieve integer
returncode Return code: 0 for success integer
returnmsg Return message string
warnings Warnings (the instruction was successfull but verify warnings. May cause partial lost of data (troncated) Collection of string
version API version string
apiSystemVersion API system version (internal use only) string

Return format

application/json, text/json, application/x-www-form-urlencoded

Sample:
{
  "order": [
    {
      "orderId": 1,
      "orderNo": "sample string 2",
      "webOrderId": "sample string 3",
      "status": "sample string 4",
      "trackingNumber": "sample string 5",
      "trackingURL_fr": "sample string 6",
      "trackingURL_en": "sample string 7",
      "documentCode": "sample string 8",
      "tags": [
        "sample string 1",
        "sample string 2"
      ],
      "carrierCode": "sample string 9"
    },
    {
      "orderId": 1,
      "orderNo": "sample string 2",
      "webOrderId": "sample string 3",
      "status": "sample string 4",
      "trackingNumber": "sample string 5",
      "trackingURL_fr": "sample string 6",
      "trackingURL_en": "sample string 7",
      "documentCode": "sample string 8",
      "tags": [
        "sample string 1",
        "sample string 2"
      ],
      "carrierCode": "sample string 9"
    }
  ],
  "token": "sample string 1",
  "count": 2,
  "queuecount": 3,
  "returncode": 4,
  "returnmsg": "sample string 5",
  "warnings": [
    "sample string 1",
    "sample string 2"
  ],
  "version": "sample string 6",
  "apiSystemVersion": "2.0"
}

application/xml, text/xml

Sample:
<result returncode="4" returnmsg="sample string 5" version="sample string 6" token="sample string 1" count="2" queuecount="3">
  <warnings>sample string 1</warnings>
  <warnings>sample string 2</warnings>
  <order>
    <orderId>1</orderId>
    <orderNo>sample string 2</orderNo>
    <webOrderId>sample string 3</webOrderId>
    <status>sample string 4</status>
    <trackingNumber>sample string 5</trackingNumber>
    <trackingURL_fr>sample string 6</trackingURL_fr>
    <trackingURL_en>sample string 7</trackingURL_en>
    <documentCode>sample string 8</documentCode>
    <tags>sample string 1</tags>
    <tags>sample string 2</tags>
    <carrierCode>sample string 9</carrierCode>
  </order>
  <order>
    <orderId>1</orderId>
    <orderNo>sample string 2</orderNo>
    <webOrderId>sample string 3</webOrderId>
    <status>sample string 4</status>
    <trackingNumber>sample string 5</trackingNumber>
    <trackingURL_fr>sample string 6</trackingURL_fr>
    <trackingURL_en>sample string 7</trackingURL_en>
    <documentCode>sample string 8</documentCode>
    <tags>sample string 1</tags>
    <tags>sample string 2</tags>
    <carrierCode>sample string 9</carrierCode>
  </order>
</result>

© 2024 - Acceo Solutions inc.