Update Tracking Information

Service endpoint - setShipmentTracking

This API endpoint is used to update an order in the Zonos™ system with tracking numbers.

HTTPS request

Information Detail
HTTP method POST
Endpoint URL https://api.iglobalstores.com/v2/setShipmentTracking
Protocol HTTPS
Message Format JSON
Accept HTTP header Accept: application/json
Content-Type HTTP header Content-Type: application/json

Request parameters

Message format: JSON

{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-99999",
  "trackingList": [
    {"number": "1Z204E380338943508"}
  ]
}

store

Required

Store ID provided by Zonos.

Integer

secret

Required

API secret GUID provided by Zonos.

String

orderId

Required

The Zonos order ID - can be passed with or without your store ID and hyphen (Example: 123-45678 or 45678).

After order completion and payment, the customer will be redirected to an Order Completion / Order Thank You page hosted on your domain. The URL will contain a querystring parameter orderId that will contain this value.

Integer / String

trackingList

Required

This is a list of objects. Each object should have a key/value pair with at least one key named “number” and the value of that key is one of the tracking numbers. You must have a separate object with the key/value pair for each tracking number.

HTTPS response

Message format: JSON

{
    "success": "Updated Order: 99999 with new tracking info."
}

Example error response

{
    "error": "A specific message describing the error."
}