1. Parcels
  2. Model

Parcels

Model

Parcel Model

object "parcel"
The description of the model.

id string
Unique identifier for the parcel.

length number
The length of the parcel in units.

width number
The width of the parcel in units.

height number
The height of the parcel in units.

weight number
The weight of the parcel in units.

type string
The type of the parcel.

unpacked boolean
Indicates if the parcel is unpacked.

layout Object
The layout details of the parcel.

Show Details
Object.id string
The ID of the layout.
Object.nested_name string
The nested name of layout.
Object.location Object
The location details.

Location details include

Object.id string
The ID of the location.
Object.name string
The name of the location.

status string
The current status of the parcel.

special_handling_tags string[]
Tags for special handling of the parcel.

tracking_number string
The tracking number of the parcel.

defective boolean
Indicates if the parcel is defective.

missing boolean
Indicates if the parcel is missing.

label_url string
The URL for the parcel label.

contents Content[]
An array of contents within the parcel.

Show Details

object "content"
The description of the content model.

id string
Unique identifier for the content.

organization_id string
The ID of the organization associated with this content.

attributes string[]
Attributes associated with the content.

tags string[]
Tags for the content.

is_asset boolean
Indicates whether the content is an asset.

layout Object
The layout details for the content.

Object.id string
The ID of the layout.
Object.nested_name string
The nested name.

comment string
A comment associated with the content.

damaged_qty number
The quantity of damaged items.

verified_qty number
The verified quantity of the content.

packed_qty number
The packed quantity of the content.

defective_qty number
The defective quantity of the content.

item_id string
The ID of the item associated with this content.

gtin string
The Global Trade Item Number of the content.

sku string
The Stock Keeping Unit of the content.

harmonized_code string
The harmonized code of the content.

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

image_urls string[]
An array of image URLs for the content.

name string
The name of the item.

origin_country string
The country of origin of the item.

size string
The size of the item.

color string
The color of the item.

vendor string
The vendor of the item.

value number
The monetary value of the item.

value_added_services Object[]
Additional value-added services for the content.

manufacturer_numbers string[]
An array of serial numbers for the incoming assets in the parcel.

packaged_length number
The length of the packaged content.

packaged_width number
The width of the packaged content.

packaged_height number
The height of the packaged content.

packaged_weight number
The weight of the packaged content.

updated_by string
The ID of the user who last updated this content.

updated_at Date
The timestamp when the content was last updated.


inventory Content[]
Same as content

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 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.

order_type string
The type of the order associated with the parcel. Can be fulfillment or manifest.

order_number string
The order number associated with the parcel.

sender Object
Details of the sender.

Show Details
Object.name string
The name of the sender.
Object.email string
The email of the sender.
Object.phone string
The phone number of the sender.
Object.business string
The business name.
Object.address Address
The address of the sender.
Object.contact_id string
The contact ID.

recipient Object
Details of the recipient.

Show Details
Object.name string
The name of the recipient.
Object.email string
The email of the recipient.
Object.phone string
The phone number of the recipient.
Object.business string
The business name.
Object.address Address
The address of the recipient.
Object.contact_id string
The contact ID.