Order
Type: Object
Represents a confirmed customer order, the central document that drives all production and fulfillment activities in a print facility. An order is the commercial agreement to produce and deliver specific goods or services. This resource captures all critical order-level information, including the customer, order number, key dates (order, requested delivery, promised delivery), payment status, and any special instructions. It serves as the primary container for 'Order Lines', which detail the specific products to be produced, making it the cornerstone of the entire manufacturing and commercial workflow.
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| actualDeliveryDate | Date | The date the order was actually delivered. | ||
| addresses | [OrderAddress!]! | filter: OrderAddressFilterInputlimit: Intoffset: Intsort: [OrderAddressSortInput] | Addresses related to the order. | |
| contact | Contact | Primary contact related to the order. | ||
| contactId | ID | |||
| createdAt | DateTime! | |||
| customer | Customer | The customer who placed the order. | ||
| customerId | ID | |||
| deliveryStatus | OrderDeliveryStatusEnum | The status of the order delivery. | ||
| discountAmount | Money | The total discount amount calculated from all order lines | ||
| id | ID! | |||
| lines | [OrderLine!]! | filter: OrderLineFilterInputlimit: Intoffset: Intsort: [OrderLineSortInput] | Lines related to the order. | |
| notes | [Note!]! | filter: NoteFilterInputlimit: Intoffset: Intsort: [NoteSortInput] | Notes related to the order. | |
| orderDate | Date! | |||
| orderNumber | String! | |||
| paymentMethod | OrderPaymentMethodEnum | The payment method used for the order. | ||
| paymentStatus | OrderPaymentStatusEnum | The status of the payment for the order. | ||
| promisedDeliveryDate | Date | The date the order was promised to be delivered. | ||
| requestedDeliveryDate | Date | The date the customer requested the order to be delivered. | ||
| rushFee | Money | The fee charged for rush order. | ||
| rushOrder | Boolean | Indicates whether the order is a rush order. | ||
| shippingAmount | Money | The total shipping amount calculated from all order lines | ||
| shippingInstructions | [OrderShippingInstruction!]! | filter: OrderShippingInstructionFilterInputlimit: Intoffset: Intsort: [OrderShippingInstructionSortInput] | Shipping instructions related to the order. | |
| specialInstructions | String | Special instructions for the order. | ||
| state | OrderStateEnum | |||
| subtotal | Money | The subtotal of the order calculated from line totals | ||
| taxAmount | Money | The total tax amount calculated from all order lines | ||
| totalAmount | Money | The total amount of the order including taxes, shipping, and discounts | ||
| updatedAt | DateTime! |