← All types
PrepressOb Object

OrderState

A customer order

Fields

id

OrderID!Non-null

Unique identifier

Tenant ID

Order number

External URL for the calling integration, or the primary identity for unscoped callers.

All linked external identities, including identities belonging to other integrations.

Integration instance that originally created this record, when known.

IaC stack that originally created this record, when known.

External system reference

Purchase order reference

Customer ID

Contact ID

Billing address ID

Shipping address ID

Linked estimate ID

Order status

Possible values (9)
DRAFT

Draft order

CONFIRMED

Confirmed order

IN_PRODUCTION

Order in production

PARTIALLY_SHIPPED

Partially shipped order

SHIPPED

Fully shipped order

DELIVERED

Delivered order

COMPLETED

Completed order

CANCELLED

Cancelled order

ON_HOLD

Order on hold

Payment status

Possible values (6)
UNPAID

Unpaid

PARTIALLY_PAID

Partially paid

PAID

Fully paid

OVERDUE

Payment overdue

REFUNDED

Refunded

WRITTEN_OFF

Written off

Order date (ISO8601)

Required delivery date (ISO8601)

Promised delivery date (ISO8601)

Confirmation timestamp (ISO8601)

Completion timestamp (ISO8601)

Cancellation timestamp (ISO8601)

Subtotal amount before tax

Tax amount

Total amount including tax

Currency code

taxRate

FloatNullable

Tax rate percentage

Shipping method

Shipping cost

notes

StringNullable

Customer-visible notes

Internal notes

tags

[String!]Nullable

Tags for categorization

User who created the order

Creation timestamp (ISO8601)

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.

Referenced by (19)
Exact type SDL
"""A customer order"""
type OrderState {
  """Unique identifier"""
  id: OrderID!
  """Tenant ID"""
  tenantId: TenantID!
  """Order number"""
  orderNumber: String!
  """
  External URL for the calling integration, or the primary identity for unscoped callers.
  """
  externalUrl: String @iac_computed
  """
  All linked external identities, including identities belonging to other integrations.
  """
  externalIdentities: [RecordExternalIdentity!]! @iac_computed
  """Integration instance that originally created this record, when known."""
  createdByIntegrationId: IntegrationInstanceID @iac_computed @iac_ref(resource: "integration_instance")
  """IaC stack that originally created this record, when known."""
  createdByStackId: IaCStackID @iac_computed
  """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
}