Shipments can be split into two or more parcels, that get tracked by the shipping carrier. For cross-border shipments, you can fill in a customs form. The related documentation is automatically generated and attached to the parcel.
The parcel unique identifier
The parcel endpoint URL
Unique identifier for the parcel
The parcel weight, used to automatically calculate the tax rates from the available carrier accounts.
The unit of weight. Can be one of 'gr', or 'oz'.
When shipping outside the US, you need to provide either an Exemption and Exclusion Legend (EEL) code or a Proof of Filing Citation (PFC). Which you need is based on the value of the goods being shipped. Value can be one of "EEL" o "PFC".
The type of item you are sending. Can be one of 'merchandise', 'gift', 'documents', 'returned_goods', 'sample', or 'other'.
If you specify 'other' in the 'contents_type' attribute, you must supply a brief description in this attribute.
Indicates if the provided information is accurate
This is the name of the person who is certifying that the information provided on the customs form is accurate. Use a name of the person in your organization who is responsible for this.
In case the shipment cannot be delivered, this option tells the carrier what you want to happen to the parcel. You can pass either 'return', or 'abandon'. The value defaults to 'return'. If you pass 'abandon', you will not receive the parcel back if it cannot be delivered.
Describes if your parcel requires any special treatment or quarantine when entering the country. Can be one of 'none', 'other', 'quarantine', or 'sanitary_phytosanitary_inspection'.
If you specify 'other' in the restriction type, you must supply a brief description of what is required.
Indicates if the parcel requires customs info to get the shipping rates.
The shipping label url, ready to be downloaded and printed.
The shipping label file type. One of 'application/pdf', 'application/zpl', 'application/epl2', or 'image/png'.
The shipping label size.
The shipping label resolution.
The tracking number associated to this parcel.
The tracking status for this parcel, automatically updated in real time by the shipping carrier.
Additional information about the tracking status, automatically updated in real time by the shipping carrier.
Time at which the parcel's tracking status was last updated.
The parcel's full tracking history, automatically updated in real time by the shipping carrier.
The weight of the parcel as measured by the carrier in ounces (if available)
The name of the person who signed for the parcel (if available)
The type of Incoterm (if available).
Time at which the resource was created.
Time at which the resource was last updated.
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
Any identifier of the third party system that defines the reference code
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
The associated shipment.
The associated package.
The line items in this parcel (a subset of the shipment line items)
The resource environment (can be one of