OrderUpdateInput
No description
input OrderUpdateInput {
userId: Int
accountManagerId: Int
channelId: Int
debtorId: String
debtorFirstName: String
debtorLastName: String
debtorCompany: String
recipientFirstName: String
recipientLastName: String
recipientCompany: String
externalId: String
status: String
type: OrderType
source: String
email: String
remarks: String
reference: String
extra3: String
extra4: String
currency: String
currencyRatio: Float
language: String
actionCode: String
invoiceUserId: Int
validUntil: String
companyId: Int
companySource: SourceInput
originalOrderId: Int
exportedAt: String
exportStatus: OrderExportStatus
exportMessage: String
sources: [SourceInput!]
items: [CreateOrUpdateOrderItemInput!]
paymentData: OrderPaymentUpdateInput
postageData: OrderPostageUpdateInput
total: OrderTotalUpdateInput
addresses: [OrderAddressBulkInput!]
}
Fields
OrderUpdateInput.userId
● Int
scalar
Identifier of the user who placed the order.
References the customer account that initiated this order. Can be null for guest orders or orders placed on behalf of customers.
OrderUpdateInput.accountManagerId
● Int
scalar
Identifier of the account manager responsible for this order.
References the staff member or owner who will handle order processing, customer communication, and order fulfillment coordination.
OrderUpdateInput.channelId
● Int
scalar
Sales channel identifier where the order originated.
Distinguishes between different sales channels like webshop, mobile app, marketplace, or point-of-sale systems for reporting and processing rules.
OrderUpdateInput.debtorId
● String
scalar
Financial identifier of the customer or company responsible for payment.
Used in accounting and billing systems to identify the party responsible for payment and invoice generation.
OrderUpdateInput.debtorFirstName
● String
scalar
First name of the Debtor [USED FOR ORDER SEARCH ONLY]
OrderUpdateInput.debtorLastName
● String
scalar
Last name of the Debtor [USED FOR ORDER SEARCH ONLY]
OrderUpdateInput.debtorCompany
● String
scalar
Company name of the Debtor [USED FOR ORDER SEARCH ONLY]
OrderUpdateInput.recipientFirstName
● String
scalar
First name of the Recipient [USED FOR ORDER SEARCH ONLY]
OrderUpdateInput.recipientLastName
● String
scalar
Last name of the Recipient [USED FOR ORDER SEARCH ONLY]
OrderUpdateInput.recipientCompany
● String
scalar
Company name of the Recipient [USED FOR ORDER SEARCH ONLY]
OrderUpdateInput.externalId
● String
scalar
[DEPRECATED] ID of the Order in an external system
OrderUpdateInput.status
● String
scalar
Status of the Order
OrderUpdateInput.type
● OrderType
enum
Type of the Order
OrderUpdateInput.source
● String
scalar
Source of the Order i.e. webshop, internal, external or api
OrderUpdateInput.email
● String
scalar
Email address used for communication about this Order
OrderUpdateInput.remarks
● String
scalar
Remarks by the customer
OrderUpdateInput.reference
● String
scalar
Reference by the customer
OrderUpdateInput.extra3
● String
scalar
Custom metadata field for order extensions.
Open text field for storing additional order information that can be used in frontend displays or system integrations. Not visible to system administrators but available for custom implementations.
OrderUpdateInput.extra4
● String
scalar
Additional custom metadata field for order extensions.
Second open text field for storing supplementary order information for frontend customization or integration purposes. Provides flexibility for custom order data requirements.
OrderUpdateInput.currency
● String
scalar
Order currency - ISO 4217 currency code => https://www.xe.com/iso4217.php
OrderUpdateInput.currencyRatio
● Float
scalar
Currency conversion ratio compared the the Order's Shop's base currency
OrderUpdateInput.language
● String
scalar
Order language - ISO 639-1 language code => https://localizely.com/iso-639-1-list/
OrderUpdateInput.actionCode
● String
scalar
Active actioncode that was applied to this Order
OrderUpdateInput.invoiceUserId
● Int
scalar
Invoice recipient identifier.
Specifies the user, contact, or customer who should receive the invoice for this order, which may differ from the person who placed the order.
OrderUpdateInput.validUntil
● String
scalar
Order validity expiration.
Date and time until which the order remains valid, particularly relevant for quotations and orders with time-sensitive pricing or availability.
OrderUpdateInput.companyId
● Int
scalar
ID of the Company of the Order
OrderUpdateInput.companySource
● SourceInput
input
A company source
OrderUpdateInput.originalOrderId
● Int
scalar
Source order reference for related orders.
Links to the original order when this order is a modification, return, or related transaction, maintaining order relationship history.
OrderUpdateInput.exportedAt
● String
scalar
External system export timestamp.
Date and time when the order was last exported to external systems like ERP, accounting software, or fulfillment systems.
OrderUpdateInput.exportStatus
● OrderExportStatus
enum
External system synchronization status.
Indicates the current state of order export to external systems, tracking successful exports, failures, or pending synchronization.
OrderUpdateInput.exportMessage
● String
scalar
Export process status message.
Detailed message about the export process, including success confirmations or error descriptions for troubleshooting integration issues.
OrderUpdateInput.sources
● [SourceInput!]
list input
List of order sources
Identifies how the order was created in the system.
OrderUpdateInput.items
● [CreateOrUpdateOrderItemInput!]
list input
The OrderItem to create or update with the Order as a single bulk request
OrderUpdateInput.paymentData
● OrderPaymentUpdateInput
input
Order's payment data
OrderUpdateInput.postageData
● OrderPostageUpdateInput
input
Order's postage data
OrderUpdateInput.total
● OrderTotalUpdateInput
input
Order's totals, tax and global discount
OrderUpdateInput.addresses
● [OrderAddressBulkInput!]
list input
Expected 1 invoice and/or 1 delivery type of address
Member Of
orderUpdate
mutation