/public/v3/orders

post

https://api.paack.app/public/v3/orders

Creates an order for Paack. One POST request creates one order.

Optionally, use the query parameters to get a base64-encoded label in the response.

Query Params

include

string

enum

Defaults to label

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

Allowed:

labelFormat

string

enum

Defaults to pdf

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

Allowed:

idempotent

boolean

Defaults to true

Returns a 201 if the external ID already exists.

Body Params

external_id

string

required

length ≤ 128

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.

customer

object

required

Information on the person receiving the parcels.

delivery_address

object

required

Delivery address.

expected_delivery_ts

object

required

Timeslot defined by the objects start and end.

delivery_instructions

string

length ≤ 128

Instructions for the delivery.

delivery_type

string

enum

Type of the delivery. Learn more here.

Allowed:

service_type

string

enum

required

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

parcels

array of objects

Parcels included in the order. As for barcodes, generate them in the same way for both direct and reverse orders so you can use them for tracking.

parcels

order_details

array of objects

length ≤ 1

Properties describing the order. 🚧 Currently only the string property sale_number, assigning the order a custom identifier, is persisted by Paack and can be retrieved through the GET method.

order_details

pick_up_address

object

required

Pickup address. In case of reverse orders, this is the customer's address where the Paack driver should collect the parcels.

❗expected_pick_up_ts

object

Timeslot defined by the objects start and end.

pick_up_instructions

string

Instructions for the pickup.

cod_value

double

≥ 0

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

cod_currency

string

enum

Currency code in ISO 4217 format.

Allowed:

clusters

array of strings

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

clusters

undeliverable_address

null

🚧 Currently input for this information is not persisted by Paack. Value equals the pickup address when retrieved through the GET method.

undeliverable_instructions

null

🚧 Currently input for this information is not persisted by Paack. Value equals the pickup instructions when retrieved through the GET method.

insured_value

null

🚧 Currently input for this information is not persisted by Paack so it cannot be retrieved through the GET method.

insured_currency

null

🚧 Currently input for this information is not persisted by Paack so it cannot be retrieved through the GET method.

Responses

`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.

201Confirms 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.

401Communicates a missing or expired access token for authorization. Currently used also in case of no rights to access the API.

403🚧 Communicates no rights to access the API. Contact our Customer Solutions team for help. While this HTTP error code is currently not supported the API returns 401.

500Returned in case of internal errors, which means the problem is on Paack's side.

`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.