CreateOrderInput
Input for creating an order
Fields
Order number
External system reference
HTTP(S) link to this record in the external system. Requires an external identity.
Purchase order reference
Customer ID (required)
Contact ID
Billing address ID
Shipping address ID
Linked estimate ID
Order status (defaults to draft)
Possible values (9)
DRAFTDraft order
CONFIRMEDConfirmed order
IN_PRODUCTIONOrder in production
PARTIALLY_SHIPPEDPartially shipped order
SHIPPEDFully shipped order
DELIVEREDDelivered order
COMPLETEDCompleted order
CANCELLEDCancelled order
ON_HOLDOrder on hold
Payment status (defaults to unpaid)
Possible values (6)
UNPAIDUnpaid
PARTIALLY_PAIDPartially paid
PAIDFully paid
OVERDUEPayment overdue
REFUNDEDRefunded
WRITTEN_OFFWritten off
Order date (ISO8601, defaults to now)
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 (defaults to EUR)
Tax rate percentage
Shipping method
Shipping cost
Customer-visible notes
Internal notes
User who created the order
Override creation timestamp (ISO8601). Defaults to now.
Override update timestamp (ISO8601). Defaults to now.
Referenced by (1)
Exact type SDL
"""Input for creating an order"""
input CreateOrderInput {
"""Order number"""
orderNumber: String!
"""External system reference"""
externalId: String
"""
HTTP(S) link to this record in the external system. Requires an external identity.
"""
externalUrl: String
"""Purchase order reference"""
poReference: String
"""Customer ID (required)"""
customerId: CustomerID!
"""Contact ID"""
contactId: ContactID
"""Billing address ID"""
billingAddressId: AddressID
"""Shipping address ID"""
shippingAddressId: AddressID
"""Linked estimate ID"""
estimateId: EstimateID
"""Order status (defaults to draft)"""
status: OrderStatus
"""Payment status (defaults to unpaid)"""
paymentStatus: PaymentStatus
"""Order date (ISO8601, defaults to now)"""
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 (defaults to EUR)"""
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). Defaults to now."""
createdAt: ISO8601
"""Override update timestamp (ISO8601). Defaults to now."""
updatedAt: ISO8601
}