Skip to main content

New Parcel field 'internal_reference'

· One min read

We have introduced a new field named internal_reference on the parcel objects.

internal_reference allows you to assign a reference to track and identify each parcel within your shipment.

You can specify this field in the request body when creating a shipment. It will be stored with the parcel object and accessible via the API.

info

internal_reference will neither be displayed on any label nor be transmitted to the carrier.

Example - Create shipment​

Request body​
{
  ...
  "parcels": [
    {
      "quantity": 1,
      "weight": 750,
      "length": 20,
      "width": 30,
      "height": 40,
      "internal_reference": "parcel-1"
    },
    {
      "quantity": 1,
      "weight": 1500,
      "length": 30,
      "width": 40,
      "height": 50,
      "internal_reference": "parcel-2"
    }
  ]
  ...
}
Response body​
[
  {
    "quantity": 1,
    "weight": 750,
    "content": null,
    "package_type": null,
    "pkg_no": "XXXXYYYYZZZZ",
    "pkg_nos": [
      "XXXXYYYYZZZZ"
    ],
    "weight_kg": "0.5",
    "dangerous_goods": [],
    "stackable": true,
    "internal_reference": "parcel-1",
    "height": 20,
    "width": 20,
    "length": 20,
    ...
  },
  {
    "quantity": 1,
    "weight": 1500,
    "content": null,
    "package_type": null,
    "pkg_no": "XXXXYYYYZZZZ",
    "pkg_nos": [
      "XXXXYYYYZZZZ"
    ],
    "weight_kg": "0.5",
    "dangerous_goods": [],
    "stackable": true,
    "internal_reference": "parcel-2",
    "height": 20,
    "width": 20,
    "length": 20,
    ...
  }
]