Appearance
OrderState
Type: Object
A customer order
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| billingAddress | AddressState | Billing address. Requires address:read permission. | ||
| billingAddressId | AddressID | Billing address ID | ||
| cancelledAt | ISO8601 | Cancellation timestamp (ISO8601) | ||
| completedAt | ISO8601 | Completion timestamp (ISO8601) | ||
| confirmedAt | ISO8601 | Confirmation timestamp (ISO8601) | ||
| contact | ContactState | Contact for this order. Requires contact:read permission. | ||
| contactId | ContactID | Contact ID | ||
| createdAt | String! | Creation timestamp (ISO8601) | ||
| createdByUser | UserState | User who created this order. Requires user:read permission. | ||
| createdByUserId | UserID | User who created the order | ||
| currency | CurrencyISO! | Currency code | ||
| customer | CustomerState | Customer for this order. Requires customer:read permission. | ||
| customerId | CustomerID! | Customer ID | ||
| estimateId | EstimateID | Linked estimate ID | ||
| externalId | String | External system reference | ||
| id | OrderID! | Unique identifier | ||
| internalNotes | String | Internal notes | ||
| notes | String | Customer-visible notes | ||
| orderDate | ISO8601! | Order date (ISO8601) | ||
| orderLines | [OrderLineState!]! | Line items for this order. Requires order:read permission. | ||
| orderNumber | String! | Order number | ||
| paymentStatus | PaymentStatus! | Payment status | ||
| poReference | String | Purchase order reference | ||
| promisedDeliveryDate | ISO8601 | Promised delivery date (ISO8601) | ||
| requiredDeliveryDate | ISO8601 | Required delivery date (ISO8601) | ||
| shippingAddress | AddressState | Shipping address. Requires address:read permission. | ||
| shippingAddressId | AddressID | Shipping address ID | ||
| shippingCost | Float | Shipping cost | ||
| shippingMethod | String | Shipping method | ||
| status | OrderStatus! | Order status | ||
| subtotalAmount | Float! | Subtotal amount before tax | ||
| tags | [String!] | Tags for categorization | ||
| taxAmount | Float! | Tax amount | ||
| taxRate | Float | Tax rate percentage | ||
| tenantId | TenantID! | Tenant ID | ||
| totalAmount | Float! | Total amount including tax | ||
| updatedAt | String! | Last update timestamp (ISO8601) |