The tracking web service is a public service available for retailers where they can retrieve the status of their orders, including all of their order history details. Tracking web service is alternatively called the Pull API, where a request from a retailer is queried against Paack’s system. The API returns the relevant information based on the request made.
Request types
There are several requests that a retailer can make at any point in time, including:
-
The last order status of any single order.
-
The last order status of a list of orders.
-
The order status history of a single order.
-
All order changes of a single order in a specific time frame (ISO format).
-
All order changes of a list of orders in a specific time frame (ISO format).
-
All order changes of all orders in a specific time frame (ISO format).
Sending a request
To get started sending requests to Paack:
-
Retrieve your external id, which you need to start making requests. Your external id is the globally unique identifier that you give to an order when creating it.
-
Set up the following API requests in your application of choice, for example, Postman.
To query the last order status of an order retailers can use the following endpoint:
GET /TrackingService/OrderStatusGet/{external_id}
To use the last five request types retailers can use the following endpoint:
GET /TrackingService/OrderStatusList?externalIds={external_id},{external_id},{etc...}&start={start_date}&end={end_date}
The endpoint above takes a list of up to ten (10) external ids, as well as an optional start date and end date in ISO format and returns the order status history and changes for these orders.
To begin using the Pull API, you will first need to authenticate to the service.