---
description: A comprehensive list of the parcel resource's attributes and relationships
---

# The parcel object

A parcel object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/parcels` endpoint.

## Fields

| Field                                        | Type       | Description                                                                                                                                                                                                                                                                       |
| -------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                     | `string`   | `parcels`                                                                                                                                                                                                                                                                         |
| **id**                                       | `string`   | The parcel unique identifier                                                                                                                                                                                                                                                      |
| links.**self**                               | `string`   | The parcel endpoint URL                                                                                                                                                                                                                                                           |
| attributes.**number**                        | `string`   | Unique identifier for the parcel.                                                                                                                                                                                                                                                 |
| attributes.**weight**                        | `float`    | The parcel weight, used to automatically calculate the tax rates from the available carrier accounts.                                                                                                                                                                             |
| attributes.**unit\_of\_weight**              | `string`   | The unit of weight. One of 'gr', 'oz', or 'lb'.                                                                                                                                                                                                                                   |
| attributes.**eel\_pfc**                      | `string`   | 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".                                    |
| attributes.**contents\_type**                | `string`   | The type of item you are sending.                                                                                                                                                                                                                                                 |
| attributes.**contents\_explanation**         | `string`   | If you specify 'other' in the 'contents\_type' attribute, you must supply a brief description in this attribute.                                                                                                                                                                  |
| attributes.**customs\_certify**              | `boolean`  | Indicates if the provided information is accurate.                                                                                                                                                                                                                                |
| attributes.**customs\_signer**               | `string`   | 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.                                                                                        |
| attributes.**non\_delivery\_option**         | `string`   | 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. |
| attributes.**restriction\_type**             | `string`   | 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'.                                                                                           |
| attributes.**restriction\_comments**         | `string`   | If you specify 'other' in the restriction type, you must supply a brief description of what is required.                                                                                                                                                                          |
| attributes.**customs\_info\_required**       | `boolean`  | Indicates if the parcel requires customs info to get the shipping rates.                                                                                                                                                                                                          |
| attributes.**shipping\_label\_url**          | `string`   | The shipping label url, ready to be downloaded and printed.                                                                                                                                                                                                                       |
| attributes.**shipping\_label\_file\_type**   | `string`   | The shipping label file type. One of 'application/pdf', 'application/zpl', 'application/epl2', or 'image/png'.                                                                                                                                                                    |
| attributes.**shipping\_label\_size**         | `string`   | The shipping label size.                                                                                                                                                                                                                                                          |
| attributes.**shipping\_label\_resolution**   | `string`   | The shipping label resolution.                                                                                                                                                                                                                                                    |
| attributes.**tracking\_number**              | `string`   | The tracking number associated to this parcel.                                                                                                                                                                                                                                    |
| attributes.**tracking\_status**              | `string`   | The tracking status for this parcel, automatically updated in real time by the shipping carrier.                                                                                                                                                                                  |
| attributes.**tracking\_status\_detail**      | `string`   | Additional information about the tracking status, automatically updated in real time by the shipping carrier.                                                                                                                                                                     |
| attributes.**tracking\_status\_updated\_at** | `datetime` | Time at which the parcel's tracking status was last updated.                                                                                                                                                                                                                      |
| attributes.**tracking\_details**             | `array`    | The parcel's full tracking history, automatically updated in real time by the shipping carrier.                                                                                                                                                                                   |
| attributes.**carrier\_weight\_oz**           | `string`   | The weight of the parcel as measured by the carrier in ounces (if available).                                                                                                                                                                                                     |
| attributes.**signed\_by**                    | `string`   | The name of the person who signed for the parcel (if available).                                                                                                                                                                                                                  |
| attributes.**incoterm**                      | `string`   | The type of Incoterm (if available).                                                                                                                                                                                                                                              |
| attributes.**delivery\_confirmation**        | `string`   | The type of delivery confirmation option upon delivery.                                                                                                                                                                                                                           |
| attributes.**created\_at**                   | `datetime` | Time at which the resource was created.                                                                                                                                                                                                                                           |
| attributes.**updated\_at**                   | `datetime` | Time at which the resource was last updated.                                                                                                                                                                                                                                      |
| attributes.**reference**                     | `string`   | 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.                                                                               |
| attributes.**reference\_origin**             | `string`   | Any identifier of the third party system that defines the reference code.                                                                                                                                                                                                         |
| attributes.**metadata**                      | `object`   | 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.                                                                                                                      |
| relationships.**shipment**                   | `object`   | The associated shipment.                                                                                                                                                                                                                                                          |
| relationships.**package**                    | `object`   | The associated package.                                                                                                                                                                                                                                                           |
| relationships.**parcel\_line\_items**        | `array`    | The line items in this parcel.                                                                                                                                                                                                                                                    |
| relationships.**attachments**                | `array`    | The associated attachments.                                                                                                                                                                                                                                                       |
| relationships.**events**                     | `array`    | The associated events.                                                                                                                                                                                                                                                            |
| relationships.**versions**                   | `array`    | The associated changes.                                                                                                                                                                                                                                                           |
| meta.**mode**                                | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                                                                                                         |
