Orders

Bulk List All Open Orders

List all the 'open' orders for a given channel. Can be used to do a pre-cursive check when importing to filter quickly filter out known references.

PUT

/v1/orders/open

curl --request PUT \
  --url 'https://public-api.bladepro.io/v1/orders/open?expand=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_channel_id": 123
}
'

{
  "data": [
    {
      "goodsouts": [
        {
          "metadata": [
            {
              "key": "import_data",
              "value": "..."
            }
          ],
          "order_goodsout_id": "2333",
          "status": "awaiting_picking"
        }
      ],
      "order_id": "2333",
      "reference": "8674-7893278932798-68723"
    }
  ],
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::ORDERS::READ

Query Parameters

expandstringquery

Usage: expand=*

Expand goodsouts, goodsouts.metadata

Body

order_channel_idintegerrequired

Order channel to check against.

Response

successful operation

goodsoutsany

List of related goodsouts.

order_idnumber

Order id.

referencestring

Order reference.

Still need help? Share an idea