Order
No description
type Order {
id: Int!
media: OrderMedia
userId: Int
accountManagerId: Int
cartId: String
channelId: Int!
shopId: Int!
uuid: String!
externalId: String @deprecated
debtorId: String
status: String!
type: OrderType!
source: String
email: String!
emailDate: DateTime
remarks: String
reference: String
extra3: String
extra4: String
currency: String!
currencyRatio: Float!
language: String!
date: DateTime! @deprecated
createdAt: DateTime!
statusDate: DateTime
postageData: OrderPostageData!
paymentData: OrderPaymentData!
total: OrderTotals!
items: [OrderItem!]!
shipments: [Shipment!]
addresses(
type: AddressType
): [Address!]
invoiceUserId: Int
validUntil: DateTime
companyId: Int
lastModifiedAt: DateTime!
originalOrderId: Int
exportedAt: DateTime
exportStatus: OrderExportStatus!
exportMessage: String
public: Boolean!
revisionNumber: Int!
publicVersionNumber: Int
invalid: Boolean!
invalidationReason: String
sources: [Source!]!
orderAddresses: [OrderAddress!]!
revisions(
input: OrderRevisionByOrderSearchInput
): OrderRevisionResponse!
revision: OrderRevision
}
Fields
Order.id ● Int! non-null scalar
Unique numeric identifier for the order.
This is the primary key used to reference the order throughout the system and serves as the main identifier for order operations.
Order.media ● OrderMedia object
Order.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.
Order.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.
Order.cartId ● String scalar
Identifier of the shopping cart that generated this order.
Links the order back to the original cart session, useful for tracking conversion and cart abandonment analysis.
Order.channelId ● Int! non-null 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.
Order.shopId ● Int! non-null scalar
Identifier of the shop where the order was placed.
References the specific storefront or sales channel configuration that processed this order, used for shop-specific settings and branding.
Order.uuid ● String! non-null scalar
Universally unique identifier for the order.
Provides a globally unique reference that can be safely shared externally and used for order tracking across different systems.
Order.externalId ● String deprecated scalar
Use sources instead
[DEPRECATED] External system identifier for order integration.
Used to link this order with records in external systems like ERP, accounting software, or third-party marketplaces for synchronization purposes.
Order.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.
Order.status ● String! non-null scalar
Current processing status of the order.
Indicates the order's position in the fulfillment workflow, such as 'pending', 'processing', 'shipped', or 'delivered'.
Order.type ● OrderType! non-null enum
Classification of the order type.
Defines the order's business purpose and processing requirements.
Order.source ● String scalar
Origin source of the order.
Identifies how the order was created in the system.
Order.email ● String! non-null scalar
Primary email address for order communications.
Used for sending order confirmations, shipping notifications, and other transactional emails related to this order.
Order.emailDate ● DateTime scalar
Timestamp of the last transactional email sent.
Tracks when the most recent order-related email was sent, useful for communication history and follow-up scheduling.
Order.remarks ● String scalar
Customer-provided comments about the order.
Free-form text where customers can add special instructions, delivery preferences, or other notes relevant to order fulfillment.
Order.reference ● String scalar
Customer reference number or identifier.
Allows customers to associate their own reference numbers or project codes with the order for their internal tracking purposes.
Order.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.
Order.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.
Order.currency ● String! non-null scalar
Currency code used for order pricing.
ISO 4217 currency code (e.g., 'EUR', 'USD', 'GBP') that determines the monetary unit for all order amounts and pricing calculations.
Order.currencyRatio ● Float! non-null scalar
Exchange rate applied at order creation.
The conversion rate between the order currency and the system's base currency at the time the order was placed, used for multi-currency reporting and calculations.
Order.language ● String! non-null scalar
Language preference for order communications.
ISO 639-1 language code (e.g., 'en', 'nl', 'de') selected during order placement, used for localized emails, documents, and customer communications.
Order.date ● DateTime! deprecated non-null scalar
Deprecated in favour of createdAt
Order placement timestamp (deprecated).
Legacy field for order creation date and time. This field is deprecated and 'createdAt' should be used instead for current implementations.
Order.createdAt ● DateTime! non-null scalar
Order creation timestamp.
Precise date and time when the order was initially created in the system, used for order sequencing, reporting, and audit trails.
Order.statusDate ● DateTime scalar
Status change timestamp.
Date and time when the order status was last modified, useful for tracking order progression and processing times.
Order.postageData ● OrderPostageData! non-null object
Shipping and delivery information.
Comprehensive shipping details including method, costs, carrier information, delivery preferences, and shipping addresses.
Order.paymentData ● OrderPaymentData! non-null object
Payment processing information.
Complete payment details including method, status, transaction costs, tax calculations, and payment processing metadata.
Order.total ● OrderTotals! non-null object
Order financial totals and calculations.
Comprehensive breakdown of order amounts including subtotals, taxes, discounts, shipping costs, and final totals.
Order.items ● [OrderItem!]! non-null object
Products and services included in the order.
Complete list of order items with quantities, pricing, product details, and item-specific configurations.
Order.shipments ● [Shipment!] list object
Shipping and fulfillment records.
Tracking information for all shipments associated with this order, including carrier details, tracking numbers, and delivery status.
Order.addresses ● [Address!] list object
Delivery and billing address information.
Collection of addresses associated with the order including delivery, billing, and any additional address types required for fulfillment.
Order.addresses.type ● AddressType enum
Order.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.
Order.validUntil ● DateTime 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.
Order.companyId ● Int scalar
Company identifier for business orders.
References the company account that placed this order, used for B2B transactions and company-specific pricing and terms.
Order.lastModifiedAt ● DateTime! non-null scalar
Last modification timestamp.
Date and time when any aspect of the order was last updated, including status changes, item modifications, or address updates.
Order.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.
Order.exportedAt ● DateTime scalar
External system export timestamp.
Date and time when the order was last exported to external systems like ERP, accounting software, or fulfillment systems.
Order.exportStatus ● OrderExportStatus! non-null enum
External system synchronization status.
Indicates the current state of order export to external systems, tracking successful exports, failures, or pending synchronization.. One of: [, exported, finished, failed]
Order.exportMessage ● String scalar
Export process status message.
Detailed message about the export process, including success confirmations or error descriptions for troubleshooting integration issues.
Order.public ● Boolean! non-null scalar
Customer visibility flag for order versions.
Indicates whether this specific version of the order is visible to customers, particularly important for quotations and order revisions.
Order.revisionNumber ● Int! non-null scalar
Revision number
Order.publicVersionNumber ● Int scalar
Customer-facing version number.
Sequential version number shown to customers for quotes and quote requests, providing clear version tracking while maintaining internal revision control.
Order.invalid ● Boolean! non-null scalar
Whether this order revision has been invalidated and cannot become an order
Order.invalidationReason ● String scalar
Reason why this order revision was invalidated
Order.sources ● [Source!]! non-null object
List of order sources
Identifies how the order was created in the system.
Order.orderAddresses ● [OrderAddress!]! non-null object
Order.revisions ● OrderRevisionResponse! non-null object
All revisions of this order
Order.revisions.input ● OrderRevisionByOrderSearchInput input
Order.revision ● OrderRevision object
The current revision of this order
Returned By
order query ● orderCreate mutation ● orderRevisionRestore mutation ● orderSetStatus mutation ● orderUpdate mutation
Member Of
CartProcessResponse object ● OrderResponse object ● OrderRevision object