Page cover image

Parcels

The Parcels API allows you to create and manage your parcels.

The Parcel Object

This section describes the different attributes available for a parcel.

Attribute

Type

Description

description

string

Description of items in parcel.

id

string

Unique identifier for parcel.

items

array

Array of parcel item objects representing the items in the parcel.

metadata

object

Provide additional information for a parcel.

parcel_id

string

Unique reference for parcel.

packaging

string

Unique reference for packaging.

total_weight

number

Total weight of items in parcel + packaging weight.

weight

number

Weight of items in parcel.

used

boolean

Indicates if a parcel has been used in an active shipment.

proof_of_payments

array

An array of string containing urls to documents/files

rec_docs

array

An array of string containing urls of images of parcel on a scale or with measuring tape

created_at

datetime

Time parcel created.

updated_at

datetime

Time parcel last updated.

Last updated