Skip to main content

Parcel Object Definition

Complete reference for the Parcel type in the GraphQL schema.

Overview

A parcel represents a physical shipment unit associated with a fulfillment order. Each fulfillment order can contain one or multiple parcels, each with its own tracking number and shipping label.

Use Cases

  • Track shipments - Monitor parcel status and carrier tracking
  • Download labels - Access generated shipping label URLs
  • Return management - Identify return parcels via isReturn
  • Anomaly handling - View anomalies detected on a parcel

Schema Definition

FieldArgumentTypeDescription
idID!Unique parcel identifier
orderIdID!ID of the parent order
trackingIdString!Carrier tracking number
trackingURLStringURL to track the parcel on the carrier website
labelURLString!URL to download the shipping label
customsDeclarationURLStringURL to download the customs declaration document
invoiceUrlStringURL to the parcel invoice
statusParcelStatus!Current parcel status
carrierServiceCarrierService!Carrier and service used for this parcel
carrierStatusStringRaw status string returned by the carrier
isReturnBoolean!Whether this is a return parcel
createdAtDateTime!Timestamp when the parcel was created
organizationExpeditorIdID!ID of the expeditor used for this parcel
organizationExpeditorOrganizationExpeditor!Expeditor object associated with this parcel
orderOrder!The parent order object
parcelProducts[ParcelProduct!]!Products included in this parcel
anomalies[Anomaly!]!Anomalies detected for this parcel
parcelEvents[ParcelEvent]!Tracking events for this parcel
returnProcessedAtDateTimeTimestamp when the return was processed