OrderCreateInput
No description
input OrderCreateInput {
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!]
shopId: Int
cartId: String
items: [OrderItemCreateInput!]!
paymentData: OrderPaymentInput!
postageData: OrderPostageInput!
total: OrderTotalInput!
addresses: [OrderCreateAddressInput!]
}
Fields
OrderCreateInput.userId ● Int! non-null 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.
OrderCreateInput.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.
OrderCreateInput.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.
OrderCreateInput.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.
OrderCreateInput.debtorFirstName ● String scalar
First name of the Debtor [USED FOR ORDER SEARCH ONLY]
OrderCreateInput.debtorLastName ● String scalar
Last name of the Debtor [USED FOR ORDER SEARCH ONLY]
OrderCreateInput.debtorCompany ● String scalar
Company name of the Debtor [USED FOR ORDER SEARCH ONLY]
OrderCreateInput.recipientFirstName ● String scalar
First name of the Recipient [USED FOR ORDER SEARCH ONLY]
OrderCreateInput.recipientLastName ● String scalar
Last name of the Recipient [USED FOR ORDER SEARCH ONLY]
OrderCreateInput.recipientCompany ● String scalar
Company name of the Recipient [USED FOR ORDER SEARCH ONLY]
OrderCreateInput.externalId ● String scalar
[DEPRECATED] ID of the Order in an external system
OrderCreateInput.status ● String! non-null scalar
Status of the Order
OrderCreateInput.type ● OrderType! non-null enum
Type of the Order
OrderCreateInput.source ● String scalar
Source of the Order
OrderCreateInput.email ● String! non-null scalar
Email address used for communication about this Order
OrderCreateInput.remarks ● String scalar
Remarks by the customer
OrderCreateInput.reference ● String scalar
Reference by the customer
OrderCreateInput.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.
OrderCreateInput.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.
OrderCreateInput.currency ● String! non-null scalar
Order currency - ISO 4217 currency code => https://www.xe.com/iso4217.php
OrderCreateInput.currencyRatio ● Float scalar
Currency conversion ratio compared the Order's base currency
OrderCreateInput.language ● String! non-null scalar
Order language - ISO 639-1 language code => https://localizely.com/iso-639-1-list/
OrderCreateInput.actionCode ● String scalar
Active actioncode that was applied to this Order
OrderCreateInput.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.
OrderCreateInput.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.
OrderCreateInput.companyId ● Int scalar
ID of the Company of the Order
OrderCreateInput.companySource ● SourceInput input
A company source
OrderCreateInput.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.
OrderCreateInput.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.
OrderCreateInput.exportStatus ● OrderExportStatus enum
External system synchronization status.
Indicates the current state of order export to external systems, tracking successful exports, failures, or pending synchronization.
OrderCreateInput.exportMessage ● String scalar
Export process status message.
Detailed message about the export process, including success confirmations or error descriptions for troubleshooting integration issues.
OrderCreateInput.sources ● [SourceInput!] list input
List of order sources
Identifies how the order was created in the system.
OrderCreateInput.shopId ● Int scalar
[DEPRECATED] Shop is deprecated and will be removed in a future version. Use channelId instead.
OrderCreateInput.cartId ● String scalar
The ID of the Cart the Order belongs to
OrderCreateInput.items ● [OrderItemCreateInput!]! non-null input
The OrderItem to create with the Order as a single bulk request
OrderCreateInput.paymentData ● OrderPaymentInput! non-null input
Order's payment data
OrderCreateInput.postageData ● OrderPostageInput! non-null input
Order's postage data
OrderCreateInput.total ● OrderTotalInput! non-null input
Order's totals, tax and global discount
OrderCreateInput.addresses ● [OrderCreateAddressInput!] list input
Order Addresses. Expected exactly 1 invoice and 1 delivery type of address. Default empty addresses will be created if not provided
Member Of
orderCreate mutation