Orders

Bulk List Tracking Numbers by Reference

Fetches all the tracking numbers for a set list of order goodsouts. This endpoint always expands all expandables.

PUT

/v1/orders/goodsouts/bulk_tracking_numbers/by_reference

curl --request PUT \
  --url 'https://public-api.bladepro.io/v1/orders/goodsouts/bulk_tracking_numbers/by_reference?expand=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "references": "<any>",
  "statuses": "<any>"
}
'

{
  "data": [
    {
      "courier": "Royal Mail",
      "despatch_date": "2021-01-26T14:52:56.000Z",
      "external_tracking_enabled": true,
      "order_goodsout_id": 1049789,
      "reference": "#154254",
      "service": "Tracked 48H Hour",
      "status": "despatched",
      "tracking_numbers": [
        {
          "code": "RMTN1134905823GB",
          "courier": "Royal Mail",
          "url": "http://www.royalmail.com/trackdetails?trackNumber=RMTN1134905823GB"
        }
      ]
    }
  ],
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

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

Query Parameters

expandstringquery

Usage: expand=*

Expand tracking_numbers

Body

referencesanyrequired

List of order references.

statusesany

Limit to certain goodsout statuses.

Response

successful operation

courierstring

Courier name.

despatch_dateany

Despatch date.

external_tracking_enabledboolean

Trackable flag.

order_goodsout_idnumber

Order goodsout ID.

referencestring

Order reference.

servicestring

Shipping service name.

statusenum<string>

Goodsout status.

Available options: draft, awaiting_allocation, hung, returned, awaiting_payment, awaiting_picking, awaiting_despatch, backorder_release, backorder, cancelled, return_open, item_refunded, item_replaced, awaiting_collection, despatched

tracking_numbersany

List of tracking numbers.

Still need help? Share an idea