Consignment

Updated on ยท 2 min read

Fulfilment processes from retailer to retailer can be drastically different depending on the setup of the retailer. At Parcelpoint we acknowledge that not every fulfilment process is the same and we have developed our system to be flexible to cater for the uniqueness of each process.

A typical fulfilment process, is a follows:

  1. Pack the item
  2. Manifest and attach a tracking label
  3. Sort the parcels
  4. Pack parcels into consignments
  5. Dispatch consignments

Depending on the setup you may be able to manifest the consignment at Step 2 (recommended). For retailers who are unable to manifest a consignment at this stage you have the ability to update the consignment at a later stage.

Generating a 'fake' consignment at packing

When manifesting Pickup Freight or Doorstep Delivery parcels, it is mandatory that a consignment_reference is sent at the time of manifest. If you are unable to supply a real consignment reference at this stage, it is recommended that you send us a 'fake' consignment_reference the references:

  • date of manifest
  • port of arrival (SYD or MEL)
  • prefix FAKE, to identify that the consignment has not been updated

An example of a 'fake' consignment_reference using the recommendations above: FAKE12042021SYD.

Updating the consignment

When you have information on the consignment, you can update the consignment_reference using the Update Consignment API.

Request

Staging Endpoint
POST https://trustedapi.staging.parcelpoint.com.au/api/v4/order/consignment
Production Endpoint
POST https://trustedapi.parcelpoint.com.au/api/v4/order/consignment
Body
{
	"consignment_reference": "4019377779330591933020",
	"orders": [
		{
			"tracking_label": "00993499689484595001"
		},
		{
			"tracking_label": "00993499689484595002"
		},
		{
			"tracking_label": "00993499689484595003"
		},
		{
			"tracking_label": "00993499689484595004"
		}
	]
}

Parameters

Name Type Required Description
consignment_reference String Yes The consignment reference you want to update the following orders
Name Type Required Description
orders Array Yes List of all the orders that is being updated to the new consignment_reference
tracking_label String Yes The tracking_label of all the parcels that will be updated to the new consignment_reference

Response

Parameters

{
	"orders": [
		{
			"parcel_code": "PMJJGHZ4",
	    "consignment_reference": "4019377779330591933020",
	    "tracking_label": "00993499689484595001",
	    "tracking_url": "https://track.staging.parcelpoint.com.au/PMJJGHZ4"
		},
		{
			"parcel_code": "PMJELZZ4",
	    "consignment_reference": "4019377779330591933020",
	    "tracking_label": "00993499689484595002",
	    "tracking_url": "https://track.staging.parcelpoint.com.au/PMJELZZ4"
		},
		{
			"parcel_code": "PMJJMPG4",
	    "consignment_reference": "4019377779330591933020",
	    "tracking_label": "00993499689484595003",
	    "tracking_url": "https://track.staging.parcelpoint.com.au/PMJJMPG4"
		},
		{
			"parcel_code": "PMJPMNZ4",
	    "consignment_reference": "4019377779330591933020",
	    "tracking_label": "001934996809484595004",
	    "tracking_url": "https://track.staging.parcelpoint.com.au/PMJPMNZ4"
		},
  ]
}
Name Type Required
orders Array List of all the orders that was referenced in the
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
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
tracking_url String Public URL used to track the package