Orders

Save Goodsout Shipment Tracking Update

Receives goodsout shipment tracking update.

POST

/v1/shipping/tracking_update

curl --request POST \
  --url https://public-api.bladepro.io/v1/shipping/tracking_update \
  --header 'Content-Type: application/json' \
  --data '
{
  "location": "<string>",
  "message": "<string>",
  "timestamp_utc": "<any>",
  "tracking_number": "<string>"
}
'

{
  "data": {
    "location": "Christchurch",
    "message": "Shipment has arrived at regional facility.",
    "timestamp": "2024-10-07T14:52:56.000Z",
    "tracking_number": "123ABC"
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::ORDERS::MANAGE

Body

locationstringrequired

A text summary of where (location) the update has occurred.

messagestringrequired

A summary text that describes the tracking event.

timestamp_utcanyrequired

The date/time of when the update was created (UTC format only).

tracking_numberstringrequired

The specific tracking number for the update.

Response

successful operation

locationstring

A text summary of where (location) the update has occurred.

messagestring

A summary text that describes the tracking event.

timestampany

The date/time of when the update was created (UTC format only).

tracking_numberstring

The specific tracking number for the update.

Still need help? Share an idea