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
Related Types
- FulfillmentOrder - Parent fulfillment order containing this parcel
- Order - The root order
Schema Definition
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | Unique parcel identifier | |
| orderId | ID! | ID of the parent order | |
| trackingId | String! | Carrier tracking number | |
| trackingURL | String | URL to track the parcel on the carrier website | |
| labelURL | String! | URL to download the shipping label | |
| customsDeclarationURL | String | URL to download the customs declaration document | |
| invoiceUrl | String | URL to the parcel invoice | |
| status | ParcelStatus! | Current parcel status | |
| carrierService | CarrierService! | Carrier and service used for this parcel | |
| carrierStatus | String | Raw status string returned by the carrier | |
| isReturn | Boolean! | Whether this is a return parcel | |
| createdAt | DateTime! | Timestamp when the parcel was created | |
| organizationExpeditorId | ID! | ID of the expeditor used for this parcel | |
| organizationExpeditor | OrganizationExpeditor! | Expeditor object associated with this parcel | |
| order | Order! | 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 | |
| returnProcessedAt | DateTime | Timestamp when the return was processed | |