← API reference
CANONICAL TYPE REFERENCE

UpsertOrderInput

Input for creating or updating an order

Optional ID for updates

Order number

External system reference

Purchase 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)

Subtotal amount before tax

Tax amount

Total amount including tax

Currency code

taxRateFloat

Tax rate percentage

Shipping method

Shipping cost

notesString

Customer-visible notes

Internal notes

tags[String!]

Tags for categorization

User who created the order

Override creation timestamp (ISO8601). Honored only on create — passing on update is rejected.

Override update timestamp (ISO8601). Honored on create or update; defaults to now.

View exact SDL
"""Input for creating or updating an order"""
input UpsertOrderInput {
  """Optional ID for updates"""
  id: OrderID
  """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
  """
  Override creation timestamp (ISO8601). Honored only on create — passing on update is rejected.
  """
  createdAt: ISO8601
  """
  Override update timestamp (ISO8601). Honored on create or update; defaults to now.
  """
  updatedAt: ISO8601
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.