← All types
Sales & CRMIn Input object

UpdateOrderInput

Input for updating an order. Only provided fields are changed.

Fields

Order number

External system reference

HTTP(S) link to this record in the external system. Requires an external identity. Omit to preserve the existing link, or pass null to clear it. Removing the external identity also removes its link.

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

FloatOptional

Tax rate percentage

Shipping method

Shipping cost

notes

StringOptional

Customer-visible notes

Internal notes

tags

[String!]Optional

Tags for categorization

User who created the order

Override update timestamp (ISO8601). Defaults to now.

Referenced by (1)
Exact type SDL
"""Input for updating an order. Only provided fields are changed."""
input UpdateOrderInput {
  """Order number"""
  orderNumber: String
  """External system reference"""
  externalId: String
  """
  HTTP(S) link to this record in the external system. Requires an external identity. Omit to preserve the existing link, or pass null to clear it. Removing the external identity also removes its link.
  """
  externalUrl: 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 update timestamp (ISO8601). Defaults to now."""
  updatedAt: ISO8601
}