Manifest a Doorstep Return Order

Customers who prefer to have their package picked up from a specific location will need to attach the Doorstep Return label to their package. Create a Doorstep Return label for each parcel using the API endpoint below. If a customer's order is made up of multiple packages, a label 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": "returns",
   	  "type": "doorstep",
      "service": "standard"
   },
   "sender": [
      {
         "first_name": "John",
         "last_name": "Lightman",
         "mobile": "0439403920",
         "email": "john.lightman@email.com"
      }
   ],
   "receiver": [
   	  {
      	 "retailer_name": "JoJam"
      }
   ],
   "origin": {
      "address": {
      	 "addressee": "John Lightman",
         "address_line_1": "Unit 5",
         "address_line_2": "38-40 Aurora Street",
         "suburb": "WILLOUGHBY",
         "state": "NSW",
         "postcode": "2067",
         "country": "Australia"
      },
      "notes": "Ring the bell, meow loudly."
   },
   "destination": {
      "hub_code": "SYD",
	  "notes": "Ring the bell, meow loudly."
   },
   "order": {
      "order_reference": "DFK07DWwV",
      "pickup_datetime": "2021-03-24 16:00"
   },
   "test_mode": false
}

Parameters

Name	Type	Required	Description
product	Map	Yes	Details about the Parcelpoint product you want to use to create an order
group	String	Yes	The Parcelpoint product you want to use to create an order, for Returns use `returns`
type	String	Yes	The Parcelpoint product type that you will use to create the order. For Return Doorstep use `doorstep`
service	String	Yes	The service to be used for this order. This often refers to the speed of delivery. For Return Doorstep use `standard`

Name	Type	Required	Description
sender	Array	Yes	Details about the sender of the package
first_name	String	Yes	The first name of the sender
last_name	String	Yes	The last name of the sender
email	String	No	The email address of the sender. This is used to provide updates to the sender on the status of the package. Required if `mobile` is not provided
mobile	String	No	The mobile phone number of the sender. This is used to provide updates to the sender on the status of the package. Required if `email` is not provided

Name	Type	Required	Description
receiver	Map	Yes	Details about the receiver of the package
retailer_name	String	Yes	Name of the retailer. This will be shown in all customer notifications and tracking

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 for the place of origin
address_line_1	String	Yes	Optional address details for the place of origin
address_line_2	String	Yes	The full street address for the place of origin
suburb	String	Yes	The suburb for the place of origin
state	String	Yes	The state code for the place of origin
postcode	String	Yes	The postcode for the place of origin
country	String	Yes	The country for the place of 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
hub_code	String	Yes	The code of the closest hub to your customer. Use `MEL` for customers located in VIC or SA. Use `SYD` for everywhere else.
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
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
pickup_datetime	String	Yes	A date (YYYY-MM-DD) and time (24:00), between 8am - 5pm, that is no more than 3 days into the future and not a weekend or public holiday

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": "returns",
   "type": "dropoff",
   "service": "standard",
   "sender": [
      {
         "first_name": "John",
         "last_name": "Lightman",
         "mobile": "0439403920",
         "email": "john.lightman@email.com"
      }
   ],
   "receiver": [
   	  {
      	 "retailer_name": "JoJam"
      }
   ],
   "origin": {
      "address":{
      	 "addressee": "John Lightman",
         "address_line_1": "38-40 Aurora Street",
         "address_line_2": "Unit 5",
         "suburb": "WILLOUGHBY",
         "state": "NSW",
         "postcode": "2067",
         "country": "Australia"
      },
	  "notes": "Ring the bell, meow loudly."
   },
   "destination": {
      "address":{
      	 "addressee": "Parcelpoint SYD HUB",
         "address_line_1": "347 Waterloo Road",
         "address_line_2": "",
         "suburb": "GREENACRE",
         "state": "NSW",
         "postcode": "2190",
         "country": "Australia"
      },
	  "notes": "Ring the bell, meow loudly."
   },
   "order": {
      "consignment_reference": "4019377779330591933020",
      "tracking_label": "00199349968019350729817",
      "order_reference": "DFK07DWwV",
      "tracking_url": "https://track.parcelpoint.com.au/PFMDCJF3",
      "label_url": "https://api.parcelpoint.com.au/api/v3/parcel/return/label/PFMDCJF3"
   },
   "test_mode": false
}

Parameters

Name	Type	Description
parcel_code	String	The Parcelpoint UUID for the parcel. The customer is required to show this to the Parcelpoint location to return their parcel
status	String	Current status of the return
type	String	Defines the Parcelpoint product for the order
service	String	Defines the type of return that will be used

Name	Type	Description
sender	Array	Details about the sender of the package
first_name	String	The first name of the sender
last_name	String	The last name of the sender
email	String	The email address of the sender
mobile	String	The mobile phone number of the sender

Name	Type	Description
receiver	Array	Details about the receiver of the package
retailer	String	Name of the retailer that will be receiving the parcel

Name	Type	Description
origin	Map	Details about the origin of the package
address	Map	Address of the origin
addressee	String	The addressee for the place of origin
address_line_1	String	The full street address for the place of origin
address_line_2	String	Optional address details for the place of origin
suburb	String	The suburb for the place of origin
state	String	The state code for the place of origin
postcode	String	The postcode for the place of origin
country	String	The country for the place of origin
notes	String	A place for delivery instructions or other notes to that will passed to the courier

Name	Type	Description
destination	Map	Details about the destination of the package
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

Name	Type	Description
order	Map	Details of the package
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
tracking_url	String	Unique URL used to track the package
label_url	String	Temporary URL to the label that needs to be attached to the parcel before taking it to the Parcelpoint location

Name	Type	Description
test_mode	Boolean	Indicates if this is live package or a test package