FulfillmentOrder Object Definition
Complete reference for the FulfillmentOrder type in the GraphQL schema.
Overview
Represents a fulfillment order that contains parcels to be shipped to a customer. Each order can have multiple fulfillment orders, and each fulfillment order can contain multiple parcels with different shipment configurations.
Use Cases
- Track fulfillment status - Monitor the progress of order fulfillment
- Manage parcels - View and organize parcels within each fulfillment order
- Return management - Create and manage return fulfillment orders
- Order consolidation - Merge multiple fulfillment orders into a single shipment
- Warehouse migration - Move fulfillment orders between warehouses
- Order splitting - Split orders for partial shipments
Related Types
- Order - Parent order containing this fulfillment
- Parcel - Individual parcels within the fulfillment
- FulfillmentOrdersProduct - Products in the fulfillment
Schema Definition
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | Unique identifier for the fulfillment order | |
| orderId | ID! | ID of the parent order | |
| wingRef | String! | Wing system reference for the fulfillment order | |
| linkedFulfillmentOrderId | String | ID of a linked/related fulfillment order if applicable | |
| createdAt | DateTime! | Timestamp when the fulfillment order was created | |
| status | FulfillmentOrderStatus! | Current status of the fulfillment order (OPEN, IN_PROGRESS, SHIPPED, DELIVERED, etc.) | |
| order | Order! | The parent order object | |
| service | WingService! | Wing service used for this fulfillment | |
| parcels | [Parcel!]! | Parcels associated with this fulfillment order | |
| fulfillmentOrdersProducts | [FulfillmentOrdersProduct!]! | Products included in this fulfillment order | |
| collectOrderProducts | [CollectOrderProduct!]! | Products for collection from the warehouse | |
| isReturn | Boolean! | Whether this is a return fulfillment order | |
| isInsuranceEnabled | Boolean! | Whether insurance is enabled for this fulfillment | |
| isSignatureEnabled | Boolean! | Whether signature is required on delivery | |
| isSaturdayDeliveryEnabled | Boolean! | Whether Saturday delivery is enabled | |
| carrierPickupId | ID | Carrier pickup point ID if using pickup delivery | |
| carrierPickupName | String | Name of the carrier pickup point | |
| carrierPickupInfos | JSON | Additional information about the pickup point | |
| invoiceUrl | String | URL to the fulfillment order invoice | |
| customLocation | String | Custom location information for delivery | |
| claim | Claim | Associated claim if applicable | |
| anomalies | [Anomaly!]! | Any anomalies detected during fulfillment | |
| warehouseAnomalyToProcessStatus | WarehouseAnomalyToProcessStatus | Status of warehouse anomalies to be processed | |