Sign in

v1

latestOpenAPI 3.1.02026-07-14577181.5 KB
Manage orders

Retrieves order data. One GET request retrieves one order. The path parameter specifies the order to retrieve. The 200 response returns information persisted for the order from the POST and PUT requests.<br /><br />Optionally, use the query parameters to get a base64-encoded label in the response.

get/public/v3/orders/{external_id}

Path parameters

external_idstring required

Order's ID assigned by the retailer; unique within all the retailer's orders manifested to Paack.

Can include special characters, excluding a comma, though for further use you need to encode them.

external_id equals tracking_id.

Defines the order to retrieve information for.

Query parameters

include'label'

Defines the label to return in the response. Must be used along with the labelFormat query parameter.

labelFormat'pdf' | 'zpl'

Defines the label format. Must be used along with the include query parameter.

Response

Returns information persisted for the order specified in the path parameter. The label is returned if the request included the query parameters.

status'return_in_progress' | 'cancelled' | 'undelivered' | 'delivered' | 'reached_delivered' | 'picked_up' | 'pending' | 'draft' | 'reached_picked_up' | 'on_course'

Status of the order. draft if just created. Corresponds to the order_status field in the webhook output.

cod_currency'EUR' | 'GBP'

Currency code in ISO 4217 format.

cod_valuenumber double

Amount of cash on delivery. Not persisted if the value equals 0.

delivery_type'direct' | 'reverse'

Type of the delivery. Learn more here.

delivery_instructionsstring

Instructions for the delivery.

external_idstring

Order's ID assigned by the retailer; unique within all the retailer's orders manifested to Paack.

Can include special characters, excluding a comma, though for further use you need to encode them.

external_id equals tracking_id.

pick_up_instructionsstring
service_type'ST2' | 'ST4' | 'STZ' | 'SF2' | 'SF4' | 'SFZ' | 'NT2' | 'NT4' | 'NTH' | 'NTZ' | 'NF2' | 'NF4' | 'NFA' | 'XF4' | 'NFZ' | 'PT2' | 'PT4' | 'PTH' | 'PTA' | 'PTZ' | 'PF2' | 'PF4' | 'PFA' | 'PFZ' | 'CT2' | 'CT4' | 'CTH' | 'CTZ' | 'XFZ' | 'CF2' | 'CF4' | 'CFA' | 'CFZ' | 'WT2' | 'WT4' | 'WTH' | 'WTZ' | 'WF2' | 'WF4' | 'WFA' | 'WFZ' | 'XTZ' | 'XF2' | 'ST3' | 'DDD' | 'ND' | 'SD' | 'UNK' | 'RFA' | 'RT2' | 'RT4'

Code that identifies the delivery day type, timeslot type, and available slot length. Learn more here.

{"stackTrail":"components:schemas:UndeliverableInstructions","oasType":"schema","type":"unknown","description":":construction: Currently input for this information is not persisted by Paack. Value equals the pickup instructions when retrieved through the GET method."}
delivery_model'store_model' | 'warehouse_model'

Paack's delivery model associated with the service type. Currently only warehouse model is used. Learn more about service types here.

labelsstring

base64-encoded label.