v1
latestOpenAPI 3.1.02026-07-1422428.2 KBRetrieves 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 parameters
Order's ID assigned by the retailer; unique within all the retailer's orders manifested to Paack. Can include special characters but excluding a comma. Note that if you use special characters in an external ID, you will have to convert them to retrieve the order through our tracking. For this reason, we recommend not using special characters.
Comma-separated IDs of the orders for which to retrieve the events for.
Sale ID assigned by the retailer; unique within all the retailer's orders manifested to Paack. Can include special characters but excluding a comma. Note that if you use special characters in a sale number, you will have to convert them to retrieve the order through our tracking. For this reason, we recommend not using special characters.
Comma-separated IDs of the orders for which to retrieve the events for.
Barcode identifier of a parcel within an order.
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.
Option to show delivery events in details.
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
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.
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.
To construct your pagination request, use the value of the before query parameter from the links.prev.href object in the response.
To construct your pagination request, use the value of the after query parameter from the links.next.href object in the response.
Number of events to return in a single response. Minimum is 10, maximum is 100.
Response
Confirms the success of the request. If the correct parameters have been specified and the data exists, it has been retrieved.
Example response
{
"data": [
{
"attributes": {
"id": "e0ef7ce2-c15d-46b5-88f7-2cb5356e96cd",
"external_id": "5ml54_p7sd353a",
"event_id": "SP001",
"event_name": "IN PROGRESS",
"is_open": true,
"parcels": [
{
"barcode": "034724878233029421",
"height": 28.2,
"length": 38,
"weight": 12.1,
"width": 48.2
}
],
"delivery_attempt": 1,
"delivery_type": "direct",
"updated_at": "2022-08-11 06:43:38.795153872 +0000 UTC",
"service_type": "ST2",
"customer": {
"first_name": "Martín Fierro",
"email": "martin.fierro@example.es"
},
"delivery_address": {
"city": "Barcelona",
"country": "ES",
"line1": "Via Augusta 17, Principal",
"post_code": "08006"
},
"expected_delivery_ts": {
"start": "2022-07-08T16:11:00+00:00",
"end": "2022-07-08T18:22:00+00:00"
},
"expected_pickup_ts": {
"start": "2022-07-08T16:00:00+00:00",
"end": "2022-07-08T16:01:00+00:00"
},
"pick_up_address": {
"city": "Barcelona",
"country": "ES",
"line1": "Avinguda Diagonal 1234",
"post_code": "08021"
},
"order_details": [
{
"name": "sale_number",
"type": "string",
"value": "g_328294984981"
},
{
"name": "paack_order_number",
"type": "string",
"value": "7812e798a28a5ml54_p7sd353a"
},
{
"name": "retailer_order_number",
"type": "string",
"value": "5ml54_p7sd353a"
}
],
"delivery_instructions": "Leave at the door",
"pick_up_instructions": "Check opening hours",
"tracking_url": "https://t.paack.co/order_tracking?postal_code=08006&tracking_number=5ml54_p7sd353a",
"tracking_id": "419dfffc-b2dc-557f-85c9-025d254a3ae8"
}
},
{
"attributes": {
"id": "0e5a1edf-456e-4a74-a9b5-ddef1ddb2d9a",
"external_id": "5CVB4l54_p7sd353a",
"event_id": "SP003",
"event_name": "DELIVERED",
"is_open": true,
"parcels": [
{
"barcode": "034724878233029421",
"height": 28.2,
"length": 38,
"weight": 12.1,
"width": 48.2
}
],
"delivery_attempt": 1,
"delivery_type": "direct",
"updated_at": "2022-08-11 06:31:21.508207777 +0000 UTC",
"service_type": "ST2",
"customer": {
"first_name": "Ramon Llull",
"email": "ramon1232@example.es"
},
"delivery_address": {
"city": "Palma de Mallorca",
"country": "ES",
"line1": "Calle de Aragón, 1232",
"post_code": "07009"
},
"expected_delivery_ts": {
"start": "2022-09-28T08:00:00+00:00",
"end": "2022-09-28T10:00:00+00:00"
},
"expected_pickup_ts": {
"start": "2022-09-01T16:00:00+00:00",
"end": "2022-09-011T16:01:00+00:00"
},
"pick_up_address": {
"city": "Barcelona",
"country": "ES",
"line1": "Avinguda Diagonal 1234",
"post_code": "08021"
},
"order_details": [
{
"name": "sale_number",
"type": "string",
"value": "g_328294984981"
},
{
"name": "paack_order_number",
"type": "string",
"value": "c348446eee4e5CVB4l54_p7sd353a"
},
{
"name": "retailer_order_number",
"type": "string",
"value": "5CVB4l54_p7sd353a"
}
],
"delivery_instructions": "Leave at the door",
"pick_up_instructions": "Check opening hours",
"tracking_url": "https://t.paack.co/order_tracking?postal_code=08006&tracking_number=5CVB4l54_p7sd353a",
"tracking_id": "4d44aff8-c4d7-5459-8544-d357a1b7c5ab"
}
}
],
"error": [],
"links": {
"next": {},
"prev": {}
}
}