Order
The order type. This type represents an order in the system.
type Order {
allocateToExternal: Boolean!
archiveBlockingReasons: [String!]!
archived: Boolean!
archivedAt: ISO8601DateTime
attachments: [File!]
autoFulfill: Boolean!
autoFulfillSettings: JSON
b2bData: OrderB2BData
b2bOrderTemplate: OrderTemplate @deprecated
billToCompany: String
billToEmail: Email
billToName: String
billToPhone: PhoneNumber
billingAddress: Address
brand: Brand @deprecated
brandId: ID @deprecated
canBeArchived: Boolean!
carrierName: String
carrierService: String
createdAt: ISO8601DateTime!
createdBy: Party!
createdById: ID!
customer: Customer
customerId: ID
deliveredDate: ISO8601DateTime
ediDocuments: [EDIDocument!]!
estimatedWeight: Decimal!
expectedDeliveryDate: ISO8601Date
expectedShipDate: ISO8601Date
financial: OrderFinancial!
financialStatus: OrderFinancialStatusEnum!
firstShipDate: ISO8601DateTime
fulfillUnpaid: Boolean!
fulfillmentMethod: OrderFulfillmentMethodEnum!
fulfillments: [OrderFulfillment!]!
giftMessage: String
held: Boolean!
id: ID!
internalOrderNumber: String!
internalVersion: String
isB2bOrder: Boolean!
localRouting: Boolean!
metadata: JSON
notes: [Note!]!
orderErrors: [OrderError!]
orderItems(
includeAll: Boolean = false
): [OrderItem!]!
orderNumber: String!
orderTemplate: OrderTemplate
orderType: OrderTypeEnum!
origin: OrderOriginEnum
originFulfillmentInformation: JSON
originOrderId: String
originUrl: Url
originalCarrierService: String
previousStatus: OrderStatus
receivedCarrierSignals: ExternalCarrierSignals
requestedCarrierServiceId: String
requestedCarrierServiceName: String
responsible: Person
responsibleId: ID
routingStrategy: [RoutingStrategyEnum!]!
salesChannel: SalesChannel!
salesChannelId: ID!
selectedCarrier: Carrier @deprecated
selectedCarrierId: ID @deprecated
selectedCarrierService: CarrierService @deprecated
selectedCarrierServiceId: ID @deprecated
shipToCompany: String
shipToEmail: Email
shipToName: String
shipToPhone: PhoneNumber
shipToSameAsBillTo: Boolean!
shipments: [OrderShipmentUnion!]!
shippedDate: ISO8601DateTime @deprecated
shippingAddress: Address
shippingCarrierService: String
shippingContainers: [ShippingContainer!]!
shippingCost: Decimal @deprecated
shippingCostMonetary: MonetaryValue
signals(
after: String
before: String
first: Int
last: Int
): OrderSignalConnection!
sourceIntegration: Integration
sourceIntegrationId: ID
stats: OrderStats!
status: OrderStatus!
statusAlerts: [OrderStatusAlert!]!
statusName: OrderStatusEnum!
tags: [OrderTag!]!
thirdPartyBilling: Boolean!
units: Int!
updatedAt: ISO8601DateTime!
}
Fields
Order.allocateToExternal ● Boolean! non-null scalar common
Indicates if the order can be allocated to external buildings.
Order.archiveBlockingReasons ● [String!]! non-null scalar common
Human-readable reasons why the record cannot be archived, or empty if it can.
Order.archived ● Boolean! non-null scalar common
Whether the record is archived.
Order.archivedAt ● ISO8601DateTime scalar common
When the record was archived, or null if it is not archived.
Order.attachments ● [File!] list object common
The files associated with the order. This field is only available if the order has attachments.
Order.autoFulfill ● Boolean! non-null scalar common
Indicates if the order should be auto-fulfilled.
Order.autoFulfillSettings ● JSON scalar common
The autofulfill settings that are part of the order.
Order.b2bData ● OrderB2BData object orders
B2B order data for wholesale orders. Will be null for regular orders.
Order.b2bOrderTemplate ● OrderTemplate deprecated object orders
Will be removed in the future. Use orderTemplate instead.
Template applied to this special order, if any.
Order.billToCompany ● String scalar common
Order.billToEmail ● Email scalar common
Order.billToName ● String scalar common
Order.billToPhone ● PhoneNumber scalar common
Order.billingAddress ● Address object common
Order.brand ● Brand deprecated object common
This field will be removed in the future. Brand is becoming a product-only attribute.
The brand object of the order. User must have the read_brand permission.
Order.brandId ● ID deprecated scalar common
This field will be removed in the future. Brand is becoming a product-only attribute.
Order.canBeArchived ● Boolean! non-null scalar common
Whether the record can be archived according to its archiving rules.
Order.carrierName ● String scalar common
The name of the carrier used for the order. This field returns the carrier
name in the last shipment. For a full list of carrier names used in the order,
use shipments field.
Order.carrierService ● String scalar common
The carrier service used for the order. This field returns the carrier service
in the last shipment. For a full list of carrier services used in the order,
use shipments field.
Order.createdAt ● ISO8601DateTime! non-null scalar common
Order.createdBy ● Party! non-null object common
The party that created the order.
Order.createdById ● ID! non-null scalar common
Order.customer ● Customer object common
The linked buying customer, including archived customers.
Order.customerId ● ID scalar common
The buying customer linked to this order.
Order.deliveredDate ● ISO8601DateTime scalar common
Order.ediDocuments ● [EDIDocument!]! non-null object integrations
Ordered list of EDI documents for the order's integration (Endless EDI only).
Order.estimatedWeight ● Decimal! non-null scalar common
The estimated weight of the order. This value is calculated based on the weight of the products.
Order.expectedDeliveryDate ● ISO8601Date scalar common
Order.expectedShipDate ● ISO8601Date scalar common
Order.financial ● OrderFinancial! non-null object orders
The financial information of the order.
Order.financialStatus ● OrderFinancialStatusEnum! non-null enum orders
The financial status of the order.
Order.firstShipDate ● ISO8601DateTime scalar common
The date when the first item of the order was shipped.
Order.fulfillUnpaid ● Boolean! non-null scalar common
Indicates it the order will be fulfilled even if it has not been paid.
Order.fulfillmentMethod ● OrderFulfillmentMethodEnum! non-null enum orders
The fulfillment method of the order. LOCAL means the order is fulfilled by Endless Commerce. PARTIALLY_PROCESSABLE means some items are fulfilled by Endless Commerce and some are fulfilled by a third party. NON_PROCESSABLE means the order is fulfilled by a third party.
Order.fulfillments ● [OrderFulfillment!]! non-null object orders
The fulfillments of the order. An order can have zero or more fulfillments.
Order.giftMessage ● String scalar common
The gift message of the order.
Order.held ● Boolean! non-null scalar common
True while the order has any active hold.
Order.id ● ID! non-null scalar common
Order.internalOrderNumber ● String! non-null scalar common
The auto-generated internal order number. This number is used for internal purposes and is unique per order.
Order.internalVersion ● String scalar common
The internal version of the order (e.g., 'v1', 'v2').
Order.isB2bOrder ● Boolean! non-null scalar common
Indicates if the order has B2B data.
Order.localRouting ● Boolean! non-null scalar common
Indicates if the order should be routed locally.
Order.metadata ● JSON scalar common
The metadata that is part of the order.
Order.notes ● [Note!]! non-null object common
The notes that are part of the order.
Order.orderErrors ● [OrderError!] list object orders
The errors that are part of the order. This field is only available when
through the order query and will return null when no errors are present or
when called through other queries.
Order.orderItems ● [OrderItem!]! non-null object orders
The products that are part of the order.
Order.orderItems.includeAll ● Boolean scalar common
Indicates if all items, including those that don't exists in the system, should be included.
Order.orderNumber ● String! non-null scalar common
Order.orderTemplate ● OrderTemplate object orders
Template applied to this B2B order, if any.
Order.orderType ● OrderTypeEnum! non-null enum orders
The type of the order. This can be either b2b for wholesale orders or standard for regular orders.
Order.origin ● OrderOriginEnum enum orders
The name of the external system where the order originated.
Order.originFulfillmentInformation ● JSON scalar common
The fulfillment information from the external system.
Order.originOrderId ● String scalar common
The order ID from the external system.
Order.originUrl ● Url scalar common
The URL of the order in the external system if available.
Order.originalCarrierService ● String scalar common
Order.previousStatus ● OrderStatus object orders
The previous status object of the order.
Order.receivedCarrierSignals ● ExternalCarrierSignals object orders
External carrier identifiers (name/service/code) this order arrived with,
extracted the same way the carrier matcher reads them. Null for
locally-created orders or integrations that don't expose a preview. Use to
populate the 'map this carrier' modal when requestedCarrierServiceId is null.
Order.requestedCarrierServiceId ● String scalar common
Order.requestedCarrierServiceName ● String scalar common
Order.responsible ● Person object people
The person that is responsible for the order.
Order.responsibleId ● ID scalar common
Order.routingStrategy ● [RoutingStrategyEnum!]! non-null enum common
The routing strategy to use when routing orders from this channel.
Order.salesChannel ● SalesChannel! non-null object sales-channels
The sales channel object of the order, including archived channels. User must have the read_sales_channel permission.
Order.salesChannelId ● ID! non-null scalar common
Order.selectedCarrier ● Carrier deprecated object shipments
Deprecated in favor of shippingCarrierService.
Order.selectedCarrierId ● ID deprecated scalar common
Deprecated in favor of shippingCarrierService.
Order.selectedCarrierService ● CarrierService deprecated object shipments
Deprecated in favor of shippingCarrierService.
Order.selectedCarrierServiceId ● ID deprecated scalar common
Deprecated in favor of shippingCarrierService.
Order.shipToCompany ● String scalar common
Order.shipToEmail ● Email scalar common
Order.shipToName ● String scalar common
Order.shipToPhone ● PhoneNumber scalar common
Order.shipToSameAsBillTo ● Boolean! non-null scalar common
Indicates if the **Ship To** information is the same as the **Bill To** information.
Order.shipments ● [OrderShipmentUnion!]! non-null union shipments
The shipments of the order. An order can have zero or more shipments.
Order.shippedDate ● ISO8601DateTime deprecated scalar common
User firstShipDate instead.
Order.shippingAddress ● Address object common
Order.shippingCarrierService ● String scalar common
Order.shippingContainers ● [ShippingContainer!]! non-null object shipments
The shipping containers of the order. An order can have zero or more shipping containers.
Order.shippingCost ● Decimal deprecated scalar common
Use shippingCostMonetary instead.
Order.shippingCostMonetary ● MonetaryValue object common
Order.signals ● OrderSignalConnection! non-null object common
Active signals on this order, most urgent first.
Order.signals.after ● String scalar common
Returns the elements in the list that come after the specified cursor.
Order.signals.before ● String scalar common
Returns the elements in the list that come before the specified cursor.
Order.signals.first ● Int scalar common
Returns the first _n_ elements from the list.
Order.signals.last ● Int scalar common
Returns the last _n_ elements from the list.
Order.sourceIntegration ● Integration object integrations
The integration object that received this order.
Order.sourceIntegrationId ● ID scalar common
The ID for the integration that received this order.
Order.stats ● OrderStats! non-null object orders
The statistics of the order.
Order.status ● OrderStatus! non-null object orders
The status object of the order.
Order.statusAlerts ● [OrderStatusAlert!]! non-null object orders
The alerts associated with the status.
Order.statusName ● OrderStatusEnum! non-null enum orders
The code name of the order status.
Order.tags ● [OrderTag!]! non-null object orders
The tags assigned to the order. Tags in the order are used to enable processing functionality and to categorize orders.
Order.thirdPartyBilling ● Boolean! non-null scalar common
Indicates if the order shipping is billed to a third party.
Order.units ● Int! non-null scalar common
The total number of units in the order. This is the sum of the quantity of each item in the order.
Order.updatedAt ● ISO8601DateTime! non-null scalar common
Returned By
allocateOrder mutation ● createOrder mutation ● order query ● ordersSaveB2bData mutation ● reportOrderIssue mutation ● shipOrderManually mutation ● unfulfillOrder mutation ● updateOrder mutation
Member Of
OrderB2BData object ● OrderConnection object ● OrderEdge object ● OrderFulfillment object ● OrderStatus object ● OrderStatusAlert object ● ShippingContainer object ● V2OrderB2BData object