On this page, we will explain all the endpoints that will let you manage Orders in our system. An Order in our system consists of the action of delivering a parcel from the store to your end consumers.
On this section of the documentation we will explain you everything about Orders in our system. An Order in our system stands for a single shipment. This shipment contains all the information from pick-up address and drop-off address to information related to the parcel and it's planned timeframe.
The Order body parameters are:
| Name | Type | Description |
|---|---|---|
| externalId | string | Id that is unique in your system and identifies the order ID or so called order number. This will be used by our riders to identify which orders the rider needs to pick-up at the store. |
| dropoff | object | Object containing all the necessary information of the order drop-off location. |
| dropoff - address | string | This is the address and house number of the street where the Order needs to be dropped off. This string is the Streetname, housenumber and addition. |
| dropoff - city | string | This is the name of the city where the Order needs to be dropped-off. |
| dropoff - country | string | The country of the Orders drop-off location. |
| dropoff - email | string | This is the email address of the receiver of the Order to send communication like track and trace email to. |
| dropoff - name | string | The name of the receiver of the Order. |
| dropoff - zipcode | string | The 6 digit postal code that is connected to the address string to set the location where the Order needs to be dropped off. |
| dropoff - phonenumber | string | The phone number of the receiver of the Order. Note: The regexp for the phone number can only contain: /^+?\d{6,15}$/ |
| pickup | object | Object containing all the necessary information of the order pickup location. This field is not required if storeId field is provided. |
| pickup - address | string | This is the address and house number of the street where the Order needs to be picked up. This string is the Streetname, housenumber and addition. |
| pickup - city | string | This is the name of the city where the Order needs to be picked up. |
| pickup - country | string | The country of the Orders pick-up location. |
| pickup - email | string | This is the email address of the sender of the Order to send communication like track and trace email to if applicable. |
| pickup - name | string | The name of the sender of the Order. |
| pickup - zipcode | string | The 6 digit postal code that is connected to the address string to set the location where the Order needs to be picked up. |
| pickup - phonenumber | string | This is the phone number from the person our riders will call if any problem arises. Note: The regexp for the phone number can only contain: /^+?\d{6,15}$/ |
| storeId | string | Unique identifier of the store created in the Packaly Dashboard. You can extract the id of all your company stores using the Get Stores endpoint. This field is not required if the pickup field is provided. |
| scheduledStartTime | date | Timestamp indication the start time of a scheduled order. The timestamp needs to be a string in ISO 8601 format in UTC. NOTE: If this field is not provided the order will be created as an on-demand order. |
| packages | array of objects | The Array containing all the packages that will be delivered within the order. Minimum of one package is required. |
| packages - height | object - int32 | Height of the package in CM |
| packages - length | object - int32 | Length of the package in CM |
| packages - width | object - int32 | Width of the package in CM |
| packages - weight | object - int32 | Weight of the package in grams |
| sourceMetadata | object | Object container for metadata of the order. |
| barCode | string | String containing the barcode that will be scanned by the rider at pick-up and drop-off for security reasons. (BETA) |
| notes | object | This object can be used to fill in a note on the delivery. |
In the above table you will find all the information to create an Order.
Make sure to format the phone number correctly
Our phone number format is created with a certain regexp. These are the values that are allowed: /^+?\d{6,15}$/