/api/v3/tracking/events

get

https://tracking.paack.io/api/v3/tracking/events

Retrieves the list of events. Querying is available with external IDs, sale numbers, time, and pagination. No query parameters returns all orders, 10 per response.

Query Params

externalIds

string

Comma-separated IDs of the orders for which to retrieve the events for.

saleNumbers

string

Comma-separated IDs of the orders for which to retrieve the events for.

barcodes

string

Comma-separated barcodes of the orders for which to retrieve the events for. Note that you cannot receive an individual parcel querying by barcode because tracking is always done at order level. This query returns the order(s) that include this barcode.

deliveryDetails

boolean

Sends detailed events for a delivery or a delivery attempt. For example if you use deliveryDetails you will get SP004 - DELIVERED THIRD PARTY for orders delivered to a third party, otherwise you will always get SP003 - DELIVERED for all orders. The same will happen for delivery attempts, if you use deliveryDetails you will get further details about the delivery attempts, otherwise you'll recieve SA005 - ATTEMPTED OTHER. Existing events for delivery which you can get in case of using this parameter: SP004 Delivered to 3rd party Events that will be available in the future for delivery: SP022 Delivered in safe place SP027 Delivered to household member Existing events for delivery attempts which you can get using this parameter: SA012 - ATTEMPTED DAMAGED , SA013 - ATTEMPTED POD NOT PROVIDED , SA014 - ATTEMPTED WEATHER OR DISTURBANCE , SA015 - ATTEMPTED BUSINESS IS CLOSED

start

string

UTC start date in ISO format to retrieve orders for a specific time period. Dates must be written like: 2022-08-01T13:00:00+00:00. Note that no other date format will be accepted.

end

string

UTC end date in ISO format to retrieve orders for a specific time period. Dates must be written like: 2022-08-01T13:00:00+00:00. Note that no other date format will be accepted.

before

string

To construct your pagination request, use the value of the before query parameter from the links.prev.href object in the response.

after

string

To construct your pagination request, use the value of the after query parameter from the links.next.href object in the response.

count

integer

10 to 100

Defaults to 100

Number of events to return in a single response. Minimum is 10, maximum is 100.

Responses

`externalId` must be unique).

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Confirms the success of the request. If the correct parameters have been specified and the data exists, it has been retrieved.

400Returned in case of validation errors.To ensure a correct validation of a request:- All mandatory query parameters must be defined.- Values for query parameters in the request must match the specific data type and format, including all limitations (e.g., externalId must be unique).

401Unauthorized because of a missing or expired token.

404The order for the specified parameters could not be found.

500Returned in case of an internal server error.

`externalId` must be unique).