Order
No description
type Order {
id: Int!
media: OrderMedia
userId: Int
accountManagerId: Int
cartId: String
channelId: Int!
shopId: Int!
uuid: String!
externalId: String
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
orderAddresses: [OrderAddress!]!
revisions(
input: OrderRevisionByOrderSearchInput
): OrderRevisionResponse!
revision: OrderRevision
}
Fields
Order.id ● Int! non-null scalar
The auto-incremental id for this order
Order.media ● OrderMedia object
Order.userId ● Int scalar
The userId of the user that placed this order
Order.accountManagerId ● Int scalar
The id of the Owner/Account Manager that will handle this order
Order.cartId ● String scalar
The cartId of the cart that this order is created from.
Order.channelId ● Int! non-null scalar
The channel identifier of the webshop this order originated from
Order.shopId ● Int! non-null scalar
The ID of the shop the Order belongs to
Order.uuid ● String! non-null scalar
Unique identifier for this order
Order.externalId ● String scalar
External identifier for this order from an external source like an ERP system
Order.debtorId ● String scalar
The debtorId of the Customer or Company that placed this Order
Order.status ● String! non-null scalar
The processing status for this order
Order.type ● OrderType! non-null enum
The type of this order
Order.source ● String scalar
The source this order originates from
Order.email ● String! non-null scalar
The email address for transactional emails
Order.emailDate ● DateTime scalar
The date the last transactional email was sent for this order
Order.remarks ● String scalar
Remarks added by the customer about this order
Order.reference ● String scalar
Reference added by the customer about this order
Order.extra3 ● String scalar
extra3: Open text field to add meta data on an Order. The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.
Order.extra4 ● String scalar
extra4: Open text field to add meta data on an Order. The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.
Order.currency ● String! non-null scalar
Currency used to place this order
Order.currencyRatio ● Float! non-null scalar
The currency's exchange rate at the time the order was placed
Order.language ● String! non-null scalar
The selected language on the webshop at the time the order was placed
Order.date ● DateTime! deprecated non-null scalar
Deprecated in favour of createdAt
The date and time the order was placed (deprecated field)
Order.createdAt ● DateTime! non-null scalar
The date and time the order was placed
Order.statusDate ● DateTime scalar
The date and time the status of the order was last changed
Order.postageData ● OrderPostageData! non-null object
The postage data of the order
Order.paymentData ● OrderPaymentData! non-null object
The payment data of the order
Order.total ● OrderTotals! non-null object
The totals of the order
Order.items ● [OrderItem!]! non-null object
The items included in the order
Order.shipments ● [Shipment!] list object
The shipments for the order
Order.addresses ● [Address!] list object
The addresses for the order
Order.addresses.type ● AddressType enum
Order.invoiceUserId ● Int scalar
The id of the User, contact or Customer that should receive the invoice for this Order
Order.validUntil ● DateTime scalar
Date and time until the order is valid
Order.companyId ● Int scalar
The companyId of the company that placed this order
Order.lastModifiedAt ● DateTime! non-null scalar
The date and time the order was last modified
Order.originalOrderId ● Int scalar
Original order id
Order.exportedAt ● DateTime scalar
The date and time the order was exported
Order.exportStatus ● OrderExportStatus! non-null enum
Order export status of this order. One of: [, exported, finished, failed]
Order.exportMessage ● String scalar
Order export message
Order.public ● Boolean! non-null scalar
Indicates whether this order version is visible to customers
Order.revisionNumber ● Int! non-null scalar
Revision number
Order.publicVersionNumber ● Int scalar
Sequential public version number for quotes and quote requests (null for regular orders)
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.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