OrderState
A customer order
Unique identifier
Tenant ID
orderNumberString!Order number
externalIdStringExternal system reference
poReferenceStringPurchase order reference
Customer ID
Contact ID
Billing address ID
Shipping address ID
Linked estimate ID
Order status
Payment status
Order date (ISO8601)
Required delivery date (ISO8601)
Promised delivery date (ISO8601)
Confirmation timestamp (ISO8601)
Completion timestamp (ISO8601)
Cancellation timestamp (ISO8601)
subtotalAmountFloat!Subtotal amount before tax
taxAmountFloat!Tax amount
totalAmountFloat!Total amount including tax
Currency code
taxRateFloatTax rate percentage
shippingMethodStringShipping method
shippingCostFloatShipping cost
notesStringCustomer-visible notes
internalNotesStringInternal notes
User who created the order
createdAtString!Creation timestamp (ISO8601)
updatedAtString!Last update timestamp (ISO8601)
Customer for this order. Requires customer:read permission.
Contact for this order. Requires contact:read permission.
Billing address. Requires address:read permission.
Shipping address. Requires address:read permission.
Line items for this order. Requires order:read permission.
User who created this order. Requires user:read permission.
View exact SDL
"""A customer order"""
type OrderState {
"""Unique identifier"""
id: OrderID!
"""Tenant ID"""
tenantId: TenantID!
"""Order number"""
orderNumber: String!
"""External system reference"""
externalId: String
"""Purchase order reference"""
poReference: String
"""Customer ID"""
customerId: CustomerID!
"""Contact ID"""
contactId: ContactID
"""Billing address ID"""
billingAddressId: AddressID
"""Shipping address ID"""
shippingAddressId: AddressID
"""Linked estimate ID"""
estimateId: EstimateID
"""Order status"""
status: OrderStatus!
"""Payment status"""
paymentStatus: PaymentStatus!
"""Order date (ISO8601)"""
orderDate: ISO8601!
"""Required delivery date (ISO8601)"""
requiredDeliveryDate: ISO8601
"""Promised delivery date (ISO8601)"""
promisedDeliveryDate: ISO8601
"""Confirmation timestamp (ISO8601)"""
confirmedAt: ISO8601
"""Completion timestamp (ISO8601)"""
completedAt: ISO8601
"""Cancellation timestamp (ISO8601)"""
cancelledAt: ISO8601
"""Subtotal amount before tax"""
subtotalAmount: Float!
"""Tax amount"""
taxAmount: Float!
"""Total amount including tax"""
totalAmount: Float!
"""Currency code"""
currency: CurrencyISO!
"""Tax rate percentage"""
taxRate: Float
"""Shipping method"""
shippingMethod: String
"""Shipping cost"""
shippingCost: Float
"""Customer-visible notes"""
notes: String
"""Internal notes"""
internalNotes: String
"""Tags for categorization"""
tags: [String!]
"""User who created the order"""
createdByUserId: UserID
"""Creation timestamp (ISO8601)"""
createdAt: String!
"""Last update timestamp (ISO8601)"""
updatedAt: String!
"""Customer for this order. Requires customer:read permission."""
customer: CustomerState
"""Contact for this order. Requires contact:read permission."""
contact: ContactState
"""Billing address. Requires address:read permission."""
billingAddress: AddressState
"""Shipping address. Requires address:read permission."""
shippingAddress: AddressState
"""Line items for this order. Requires order:read permission."""
orderLines: [OrderLineState!]!
"""User who created this order. Requires user:read permission."""
createdByUser: UserState
}One stable address across all schema views. Follow a field’s type to explore connections between domains.