Once the parcel is ready to be sent, manifest each parcel using the API endpoint below. If a customer's order is made up of multiple packages, a manifest is needed for each of those packages.
Request
Staging Endpoint
POST https://trustedapi.staging.parcelpoint.com.au/api/v4/order
Production Endpoint
POST https://trustedapi.parcelpoint.com.au/api/v4/order
Body
{
"product": {
"group": "pickup",
"type": "address"
},
"sender":[
{
"retailer_name": "JoJam"
}
],
"receiver": [
{
"first_name": "John",
"last_name": "Lightman",
"mobile": "0439403920",
"email": "john.lightman@email.com",
"primary_receiver": true
},
{
"first_name": "Krystal",
"last_name": "Ling",
"mobile": "0439485938",
"email": "krystal.ling@email.com",
"primary_receiver": false
}
],
"origin": {
"address":{
"addressee": "JoJam Distribution Centre",
"address_line_1": "1 Distribution Parade",
"address_line_2": "Unit 5, Building 20",
"suburb": "YENNORA",
"state": "NSW",
"postcode": "2161",
"country": "Australia",
"lat": 37.793274,
"lng": -122.395934
},
"notes": "Ring the bell, meow loudly."
},
"destination":{
"location_id": "2010-22",
"notes": "Ring the bell, meow loudly."
},
"order":{
"consignment_reference": "4019377779330591933020",
"tracking_label": "00199349968019350729817",
"order_reference": "DFK07DWwV",
"carrier": "AusPost",
"value": 100.00,
"width": 20,
"height": 5,
"length": 40,
"cubic_weight": 258,
"dead_weight": 367,
"dangerous_goods": false,
"description": "A pair of fine sports shoes"
},
"test_mode": false
}
Parameters
| Name |
Type |
Required |
Description |
| product |
Map |
Yes |
Details about the Parcelpoint product you want to create an order with |
| group |
String |
Yes |
The Parcelpoint product you want to create an order, for Pickup use pickup |
| type |
String |
Yes |
The Parcelpoint product type that you will use to great the order. For Pickup Address use address |
| Name |
Type |
Required |
Description |
| sender |
Array |
Yes |
Details about the sender of the package. You will need at least one sender for the order to be successful |
| retailer_name |
String |
Yes |
Name of the retailer. This will be shown in all customer notifications and tracking |
| Name |
Type |
Required |
Description |
| receiver |
Array |
Yes |
Details about the receiver of the package. You will need at least one receiver for the order to be successful |
| first_name |
String |
Yes |
The first name of the receiver |
| last_name |
String |
Yes |
The last name of the receiver |
| email |
String |
No |
The email address of the receiver. This is used to provide updates to the receiver on the status of the package. Required if mobile is not provided |
| mobile |
String |
No |
The mobile phone number of the receiver. This is used to provide updates to the receiver on the status of the package. Required if email is not provided |
| primary_receiver |
Boolean |
Yes |
Determines if this receiver is an authorised receiver or the primary receiver |
| Name |
Type |
Required |
Description |
| origin |
Map |
Yes |
Details about the origin of the package |
| address |
Map |
Yes |
Address of the origin |
| addressee |
String |
Yes |
The addressee of the origin |
| address_line_1 |
String |
Yes |
The full street address of the origin |
| address_line_2 |
String |
No |
Optional address details of the origin |
| suburb |
String |
Yes |
The suburb of the origin |
| state |
String |
Yes |
The state code of the origin |
| postcode |
String |
Yes |
The postcode of the origin |
| country |
String |
Yes |
The country of the origin |
| lat |
Integer |
No |
The latitude coordinates of the origin |
| lng |
Integer |
No |
The longitude coordinates of the origin |
| notes |
String |
No |
Any delivery instructions or communication that needs to be relay to the driver |
| Name |
Type |
Required |
Description |
| destination |
Map |
Yes |
Details about the destination of the package |
| location_id |
String |
Yes |
Location ID of the origin as provided by Parcelpoint in the store feed or the location widget |
| verification |
String |
Yes |
Determines if the parcel needs a signature or can be left in a safe place. Use atl for Authority to Leave and signature for requiring a signature (charges may apply) |
| notes |
String |
No |
Any delivery instructions or communication that needs to be relay to the driver |
| Name |
Type |
Required |
Description |
| order |
Map |
Yes |
Details of the package. Our system is designed on the basis that 1 parcel is 1 order |
| consignment_reference |
String |
Yes |
The consignment reference that the package is located within. eg. A pallet, large box , or other 'container' that contains the parcel when moving between locations |
| tracking_label |
String |
Yes |
The reference used to identify the package. This is often the barcode that is scanned by the carrier |
| order_reference |
String |
Yes |
The reference used by the retailer to identify the customer, commonly known as the Order ID that is sent in the invoice or purchase confirmation to the customer |
| carrier |
String |
Yes |
The name of the carrier that is sending the parcel |
| value |
Integer |
No |
The dollar value of the order in Australian dollars (AU$) |
| height |
Integer |
Yes |
The height of the package in centremetres |
| width |
Integer |
Yes |
The width of the package in centremetres |
| length |
Integer |
Yes |
The length of the package in centremetres |
| cubic_weight |
Integer |
Yes |
The cubic weight of the package in kilograms This is calculated using the formula: Height x Weight x Length x 250 |
| dead_weight |
Integer |
Yes |
The dead weight of the package in grams |
| dangerous_goods |
Boolean |
Yes |
Declare whether this package contains dangerous goods |
| description |
String |
No |
A short description about the package, often used by carriers and customs to understand what's in the package |
| Name |
Type |
Required |
Description |
| test_mode |
Boolean |
Yes |
Indicates if this is live package or a test package |
Response
{
"parcel_code": "PFMDCJF3",
"status": "booked",
"group": "pickup",
"type": "address",
"sender":[
{
"retailer_name": "JoJam"
}
],
"receiver": [
{
"first_name": "Michael",
"last_name": "Sherer",
"mobile": "0439403920",
"email": "michael.sherer@email.com",
"primary_receiver": true
},
{
"first_name": "Steve",
"last_name": "Adams",
"mobile": "0439485938",
"email": "steve.adams@email.com",
"primary_receiver": false
}
],
"origin": {
"address":{
"addressee": "JoJam Distribution Centre",
"address_line_1": "1 Distribution Parade",
"address_line_2": "Unit 5, Building 20",
"suburb": "YENNORA",
"state": "NSW",
"postcode": "2161",
"country": "Australia"
},
"notes": "Ring the bell, meow loudly."
},
"destination":{
"address":{
"addressee": "Terry White Chatswood Chase Parcelpoint",
"address_line_1": "345 Victoria Street",
"address_line_2": "Shop B025",
"suburb": "Chatswood",
"state": "NSW",
"postcode": "2067",
"country": "Australia"
},
"notes": "Ring the bell, meow loudly."
},
"order":{
"consignment_reference": "4019377779330591933020",
"tracking_label": "00199349968019350729817",
"order_reference": "DFK07DWwV",
"carrier": "AusPost",
"tracking_url": "https://track.parcelpoint.com.au/PFMDCJF3"
},
"test_mode": false
}
Parameters
| Name |
Type |
Description |
| parcel_code |
String |
Parcelpoint parcel code for referencing the parcel. This can also be referred to as the 'Waybill' and can be used to track the parcel at track.parcelpoint.com.au |
| status |
String |
Current status of the parcel |
| group |
String |
The Parcelpoint product used when creating the order |
| type |
String |
The Parcelpoint product type used when creating the order |
| Name |
Type |
Description |
| sender |
Array |
Details about the sender of the package |
| retailer_name |
String |
Name of the retailer who is sending the order |
| Name |
Type |
Description |
| receiver |
Array |
Details about the receiver of the package |
| first_name |
String |
The first name of the receiver |
| last_name |
String |
The last name of the receiver |
| email |
String |
The email address of the receiver |
| mobile |
String |
The mobile phone number of the receiver |
| primary_receiver |
Boolean |
Determines if this receiver is an authorised receiver or the primary receiver |
| Name |
Type |
Description |
| origin |
Map |
Yes |
| address |
Map |
Address of the origin |
| addressee |
String |
The addressee of the origin |
| address_line_1 |
String |
The full street address of the origin |
| address_line_2 |
String |
Optional address details of the origin |
| suburb |
String |
The suburb of the origin |
| state |
String |
The state code of the origin |
| postcode |
String |
The postcode of the origin |
| country |
String |
The country of the origin |
| lat |
Integer |
The latitude coordinates of the origin |
| lng |
Integer |
The longitude coordinates of the origin |
| notes |
String |
Any delivery instructions or communication that needs to be relay to the driver |
| Name |
Type |
Description |
| destination |
Map |
Yes |
| address |
Map |
Address of the destination |
| addressee |
String |
The addressee of the destination |
| address_line_1 |
String |
The full street address of the destination |
| address_line_2 |
String |
Optional address details of the destination |
| suburb |
String |
The suburb of the destination |
| state |
String |
The state code of the destination |
| postcode |
String |
The postcode of the destination |
| country |
String |
The country of the destination |
| verification |
String |
Determines if the parcel needs a signature or can be left in a safe place |
| notes |
String |
Any delivery instructions or communication that needs to be relay to the driver |
| Name |
Type |
Description |
| order |
Map |
Details of the package. Our system is designed on the basis that 1 parcel is 1 order. |
| consignment_reference |
String |
The consignment reference that the package is located within. eg. A pallet, large box , or other 'container' that contains the parcel when moving between locations |
| tracking_label |
String |
The reference used to identify the package. This is often the barcode that is scanned by the carrier |
| order_reference |
String |
The reference used by the retailer to identify the customer, commonly known as the Order ID that is sent in the invoice or purchase confirmation to the customer |
| carrier |
String |
The name of the carrier that is sending the parcel |
| tracking_url |
String |
Public URL used to track the package |
| Name |
Type |
Description |
| test_mode |
Boolean |
Indicates if this is live package or a test package |