Parcels

Models

Parcel Model

A model representing a physical package within the system, which can be associated with either a fulfillment or manifest.

object "parcel" The enum value identifying this as a parcel model.

organization_id string Organization ID derived from either the associated fulfillment or manifest prefixed with org_.

id string Unique identifier for the parcel, prefixed with prcl_.

length float The length of the parcel in inches. Defaults to 0.

width float The width of the parcel in inches. Defaults to 0.

height float The height of the parcel in inches. Defaults to 0.

weight float The weight of the parcel in pounds (lbs). Defaults to 0.

type string Package type identifier, either referencing predefined package templates or custom package templates. See Predefined Packages

name string Display name of the parcel.

unpacked boolean Indicates whether parcel has been unpacked. Defaults to false.

location_id string Identifies where the parcel is currently located. The system determines this either from layout, fulfillment, or manifest location. If none are available, defaults to null.

location object The location where the parcel is currently stored. Contains id (the location ID) and name (the location name).

layout Object Layout information for the parcel.

Show Details


layout.id `string` The unique ID of the layout prefixed with `lay_`
layout.nested_name `string` The name of the layout when it is nested inside a parent layout.
layout.location `Object` Location details containing id and name.

Location details include


location.id `string` The unique ID of the location prefixed with `loc_`
Object.name `string` The name of the location.

status string The current status of the parcel. This field indicates the operational state of the parcel within the system. It's default value will be in_storage. See All Parcel Statuses

special_handling_tags string[] An array of tags for special handling of the parcel. These tags are used to indicate specific handling requirements or conditions that need to be considered during the processing and transportation of the parcel. See tags

tracking_number string The unique identifier assigned to the parcel for tracking its movement throughout the shipping process.

defective boolean Indicates whether the parcel is considered defective. Defaults to false.

missing boolean Indicates whether the parcel is reported as missing. Defaults to false.

label_url string The URL that points to the shipping label for the parcel. This link allows users to access and print the label, which is necessary for shipping and tracking the parcel.

contents Content[] An array of contents within the parcel. Each item in this array represents an individual content piece included in the parcel, which can be an item, asset, or any other relevant entity.

inventory Content[] Alias for contents. Returns the same array of content objects.

external_container_id string The ID of the external container associated with the parcel.

container_number string The container number associated with the parcel.

updated_by string The ID of the user or key who last updated this parcel.

manifest_id string The ID of the manifest associated with this parcel.

fulfillment_id string The ID of the fulfillment associated with this parcel.

received boolean Indicates if the parcel has been received.

picked boolean Indicates whether the parcel has been picked for fulfillment. Defaults to false.

order_type string The type of the order associated with the parcel. It is set to fulfillment if the parcel has an associated fulfillment with an order_number; otherwise, it defaults to manifest

order_number string The order number associated with the parcel. It is set to the order_number from the associated fulfillment if available; otherwise, it defaults to the order_number from the associated manifest. If neither is present, it will be null.

updated_at integer
Time in epoch seconds when this resource was last updated.

created_at integer
Time in epoch seconds when this resource was created.

sender Object Details of the sender associated with the parcel.

Show Details


sender.name `string` The name of the sender. This field is populated from the sender_name in the associated fulfillment if available; otherwise, it defaults to the sender_name from the associated manifest.
sender.email `string` The email of the sender. This field is populated from the sender_email in the associated fulfillment if available; otherwise, it defaults to the sender_email from the associated manifest.
sender.phone `string` The phone number of the sender. This field is populated from the sender_phone in the associated fulfillment if available; otherwise, it defaults to the sender_phone from the associated manifest. If neither is present, it will be null.
sender.business `string` The business name of the sender. This field is populated from the sender_business in the associated fulfillment if available; otherwise, it defaults to the sender_business from the associated manifest.
sender.address `Address` The address of the sender, represented as an Address object. This field is populated from the sender_address in the associated fulfillment if available; otherwise, it defaults to the sender_address from the associated manifest. If neither is present, it will be null.
sender.contact_id `string` The contact ID of the sender. This field is populated from the contact_id in the associated fulfillment if available; otherwise, it defaults to the contact_id from the associated manifest.

recipient Object Details of the recipient associated with the parcel.

Show Details


recipient.name `string` The name of the recipient. This field is populated from the recipient_name in the associated fulfillment if available; otherwise, it defaults to the recipient_name from the associated manifest.
recipient.email `string` The email of the recipient. This field is populated from the recipient_email in the associated fulfillment if available; otherwise, it defaults to the recipient_email from the associated manifest.
recipient.phone `string` The phone number of the recipient. This field is populated from the recipient_phone in the associated fulfillment if available; otherwise, it defaults to the recipient_phone from the associated manifest. If neither is present, it will be null.
recipient.business `string` The business name of the recipient. This field is populated from the recipient_business in the associated fulfillment if available; otherwise, it defaults to the recipient_business from the associated manifest.
recipient.address `Address` The address of the recipient, represented as an Address object. This field is populated from the recipient_address in the associated fulfillment if available; otherwise, it defaults to the recipient_address from the associated manifest. If neither is present, it will be null.
recipient.contact_id `string` The contact ID of the recipient. This field is populated from the contact_id in the associated fulfillment if available; otherwise, it defaults to the contact_id from the associated manifest.

easypost_messages string
Easypost messages associated to this parcel.

reason_code object
Reason code associated to this parcel.

max_weight_domestic number
The maximum weight of the parcel allowed for domestic shipments

max_weight_international number
The maximum weight of the parcel allowed for international shipments

form_urls object
URLs of forms associated to the parcel. Available forms are

cn22
cod_return_label
commercial_invoice
high_value_report
label_qr_code
nafta_certificate_of_origin
order_summary
return_packing_slip
rma_qr_code

_search object
A special property that will be included if searching through parcels. This is a flat object that contains various properties related to the search results. Each property may include <mark> tags around characters that have matched the search query, allowing for easy highlighting in the user interface. The properties within this object provide relevant information about the search results, such as tracking numbers, container_number, relevance score, and the original query used for the search.

Show Details


_search.tracking_number `string` The tracking number that matched the search query.
_search.container_number `string` The container number that matched the search query.
_search.relevance_score `number` A numeric value between 0 and 1 that indicates the relevance of a search result to the query, where 1 represents a perfect match and higher values indicate better matches.
_search.query `string` The original search query used to find matching parcels.

checksum string
A hash value computed from the current parcel configuration. This value gets updated whenever the parcel changes.

Content Model

The Content Model represents an individual item contained within a parcel. Each entry in a parcel's contents or inventory array is a Content object.

object "content"
The enum value identifying this as a content model.

id string
Unique identifier for the content item, prefixed with cont_.

organization_id string
The unique identifier for the organization that owns or manages the content item.

item_id string
The unique identifier for the item associated with this content. Links the content to a specific item in the inventory system.

attributes string[]
An array of attributes associated with the content item. Both attributes and tags map to the same underlying special_handling_tags field and will always contain identical values. See attributes

tags string[]
An array of tags for special handling of the content item. Both tags and attributes map to the same underlying special_handling_tags field and will always contain identical values. See tags

is_asset boolean
Indicates whether the content item is considered an asset. Defaults to false.

layout object
An object that contains information about the layout associated with the content item.

Show Details


layout.id `string` The unique ID of the layout prefixed with `lay_`
layout.nested_name `string` The name of the layout when it is nested inside a parent layout.
layout.code `string` The code of the layout.

comment string
A text field that allows users to add additional notes or remarks related to the content item.

damaged_qty number (deprecated)
The quantity of items identified as damaged. Defaults to 0. Deprecated: use defective_qty instead.

verified_qty number
The quantity of items that have been verified. Defaults to 0.

packed_qty number
The quantity of items that have been packed for shipment. Defaults to 0.

defective_qty number
The quantity of items identified as defective. Defaults to 0.

gtin string
The Global Trade Item Number (GTIN) of the content item.

sku string
The Stock Keeping Unit (SKU) of the content item.

harmonized_code string
The Harmonized System (HS) code of the content item.

image_url string
The URL for the primary image of the content item.

image_urls string[]
An array of URLs for additional images of the content item.

name string
The name of the content item.

origin_country string
The country of origin of the content item.

size string
The size of the content item.

color string
The color of the content item.

vendor string
The name of the vendor or supplier associated with the content item.

value number
The monetary value of the content item.

value_added_services object[]
An array of value-added services associated with the content item. See Value Added Services

Show VAS Details


vas.id `string` The identifier of the value-added service (e.g., `gift_wrapping`, `engraving`).
vas.name `string` The human-readable name of the value-added service, derived from the ID.
vas.comment `string` A free-text comment or instruction associated with the service.
vas.completed `boolean` Indicates whether the value-added service has been completed. Defaults to `false`.

manufacturer_numbers string[]
An array of manufacturer numbers associated with the content item.

packaged_length number
The length of the packaged item in inches.

packaged_width number
The width of the packaged item in inches.

packaged_height number
The height of the packaged item in inches.

packaged_weight number
The weight of the packaged item in pounds (lbs).

ship_ready boolean
Indicates whether the item associated with this content is ready to ship.

description string
The description of the item associated with this content.

updated_by string
The ID of the user or key who last updated the content item.

updated_at integer
Time in epoch seconds when this content item was last updated.

Models

# Parcel Model

# Content Model

On this page

Parcel Model

Content Model