Paack APIs
Log In
Paack APIs

/public/v3/orders

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

Creates an order for Paack. One POST request to the Order Management API creates one order.

The body of the call to the Order Management API uses a structured JSON format with mandatory and optional fields. The JSON must have the appropriate structure for processing without errors and it is also necessary to populate the mandatory fields. Each property in the request has a specific data type for the value; all values must conform to the required data type.

Body Params

Defines the request to create an order.

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 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 for external IDs.

customer
object
required

Information on the person receiving the parcels.

delivery_address
object
required

Address definition.

expected_delivery_ts
object
required

Timeslot defined by the objects start and end.

string
length ≤ 128

Instructions for the delivery.

string
length ≤ 128

Type of the delivery.

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.

parcels
order_details
array

Specifies additional properties of the order. A property called sale_number stores the order's custom identifier. Note that the properties are persisted by Paack although you cannot retrieve them through the GET method.

The supported types are string, number, boolean, object, array, and null. For better user experience, only string, number, and boolean are displayed in this documentation.

order_details
pick_up_address
object
required

Address definition.

expected_pick_up_ts
object

Timeslot defined by the objects start and end.

string

Instructions for the pick-up.

double
≥ 0

Amount of money insured.

string
enum

Currency code in ISO 4217 format.

Allowed:
double
≥ 0

Amount of cash on delivery.

string
enum

Currency code in ISO 4217 format.

Allowed:
undeliverable_address
object

Address definition.

string
length ≤ 128

Instructions for the undeliverable order.

Responses

external_id.

message.body.message.cms.body.data.message field.

To ensure a correct validation of a request:
- Body of the request must use a structured JSON format.
- All mandatory fields must be defined.
- Values for fields in the request must match the specific data type and format, including all limitations (e.g., external_id must be unique).

Updated over 3 years ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 3 years ago