CLcloudkitchens
inventory_endpoints

List shipments

List shipments by the requested parameters. Rate limit: 8 requests per minute.

get/inventories/v1/shipments

Request

Query parameters

limitstring

Max number of entities to retrieve

tokenstring

Opaque token used for paging. Query parameters must be URL encoded.

Example:CgwI09+kjQYQwOvF2AM=/(urlencoded:CgwI09%2BkjQYQwOvF2AM%3D)

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier

Response

The shipments were successfully retrieved

nextTokenstring

Opaque token used to fetch the following page. If set, pass the value of nextToken to the next request. If not set, no more results are available.

Example response

{
  "shipments": [
    {
      "id": "18695c43-c670-4c57-a714-e0d7b215db20",
      "deliveryInfo": {
        "deliveryWindow": {
          "start": "2007-12-03T09:15:30.000Z",
          "end": "2007-12-03T09:15:30.000Z"
        },
        "courierName": "Express Local Delivery Services",
        "trackingId": "18492b99ad000"
      },
      "lineItems": [
        {
          "id": "1b8aec80-21aa-43f1-b510-2199ac54156a",
          "manifestQuantity": 5,
          "receivedSellableQuantity": 5,
          "receivedUnsellableQuantity": 5
        }
      ],
      "stateChanges": [
        {
          "timestamp": "2007-12-03T09:15:30.000Z"
        }
      ]
    }
  ],
  "nextToken": "H12MAF2fFaFFFa"
}

Changes

No recorded changes to this operation across all 1 revision of this API.