Sign in

v1

latestOpenAPI 3.1.02026-07-14577181.5 KB
Manage orders

Creates an order for Paack. One POST request creates one order.<br /><br />Optionally, use the query parameters to get a base64-encoded label in the response.

post/public/v3/orders

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.

idempotentboolean

Returns a 201 if the external ID already exists.

Request body

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.

delivery_instructionsstring

Instructions for the delivery.

delivery_type'direct' | 'reverse'

Type of the delivery. Learn more here.

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' required

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

pick_up_instructionsstring

Instructions for the pickup.

cod_valuenumber double

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

cod_currency'EUR' | 'GBP'

Currency code in ISO 4217 format.

clustersstring[]

:construction: Identifiers that associate orders with each other. Learn more here. Note that, as of now, the array cannot be retrieved through a GET request.

{"stackTrail":"components:schemas:UndeliverableAddressNotPersisted","oasType":"schema","type":"unknown","description":":construction: Currently input for this information is not persisted by Paack. Value equals the pickup address when retrieved through the GET method."}
{"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."}
{"stackTrail":"components:schemas:NotPersisted","oasType":"schema","type":"unknown","description":":construction: Currently input for this information is not persisted by Paack so it cannot be retrieved through the GET method."}
{"stackTrail":"components:schemas:NotPersisted","oasType":"schema","type":"unknown","description":":construction: Currently input for this information is not persisted by Paack so it cannot be retrieved through the GET method."}

Response

Confirms the creation of an order of the external_id that equals the value returned in the success.tracking_id field. The fields status and labels are returned if the request included the query parameters.

All 5 operations