Skip to content

UpsertOrderInput ​

Type: Input

Input for creating or updating an order

Fields ​

NameTypeDefaultDescription
billingAddressIdAddressIDBilling address ID
cancelledAtISO8601Cancellation timestamp (ISO8601)
completedAtISO8601Completion timestamp (ISO8601)
confirmedAtISO8601Confirmation timestamp (ISO8601)
contactIdContactIDContact ID
createdAtISO8601Override creation timestamp (ISO8601). Honored only on create — passing on update is rejected.
createdByUserIdUserIDUser who created the order
currencyCurrencyISOCurrency code
customerIdCustomerIDCustomer ID
estimateIdEstimateIDLinked estimate ID
externalIdStringExternal system reference
idOrderIDOptional ID for updates
internalNotesStringInternal notes
notesStringCustomer-visible notes
orderDateISO8601Order date (ISO8601)
orderNumberString!Order number
paymentStatusPaymentStatusPayment status
poReferenceStringPurchase order reference
promisedDeliveryDateISO8601Promised delivery date (ISO8601)
requiredDeliveryDateISO8601Required delivery date (ISO8601)
shippingAddressIdAddressIDShipping address ID
shippingCostFloatShipping cost
shippingMethodStringShipping method
statusOrderStatusOrder status
subtotalAmountFloatSubtotal amount before tax
tags[String!]Tags for categorization
taxAmountFloatTax amount
taxRateFloatTax rate percentage
totalAmountFloatTotal amount including tax
updatedAtISO8601Override update timestamp (ISO8601). Honored on create or update; defaults to now.

Connect machines, automate workflows, and build custom apps for print production.