Question 1

What is the purpose of the setShipmentTracking API endpoint?

Accepted Answer

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

Question 2

What is the HTTPS request format for the setShipmentTracking API endpoint?

Accepted Answer

The HTTPS request is a POST method with the Endpoint URL as https://api.iglobalstores.com/v2/setShipmentTracking. The protocol is HTTPS and the message format is JSON. The Accept HTTP header is Accept: application/json and the Content-Type HTTP header is Content-Type: application/json.

Question 3

What are the required JSON key/value pairs in the request body for the setShipmentTracking API endpoint?

Accepted Answer

The required JSON key/value pairs in the request body are orderId, secret, store, and trackingList.

Question 4

What is the format of the HTTPS response for the setShipmentTracking API endpoint?

Accepted Answer

The HTTPS response is in JSON format. A successful response will return a success message with the updated order number. An error response will return an error message describing the error.

Field↕	notes↕
`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 / thank you page hosted on your domain. The URL will contain a querystring parameter `orderId` that will contain this value.`integer / string`
`secret` REQUIRED	API secret GUID provided by Zonos.`string`
`store` REQUIRED	Store ID provided by Zonos.`integer`
`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.

Update tracking

Endpoint

HTTPS request

JSON key/value pairs in the request body

HTTPS response

Was this page helpful?