Skip to main content

Order

The order type. This type represents an order in the system.

type Order {
  autoFulfill: Boolean!
  billToCompany: String
  billToEmail: Email
  billToName: String
  billToPhone: PhoneNumber
  billingAddress: Address
  brand: Brand!
  brandId: ID!
  createdAt: ISO8601DateTime!
  createdBy: Party!
  createdById: ID!
  deliveredDate: ISO8601DateTime
  estimatedWeight: Decimal!
  expectedDeliveryDate: ISO8601DateTime
  expectedShipDate: ISO8601DateTime
  financial: OrderFinancial!
  financialStatus: OrderFinancialStatusEnum!
  firstShipDate: ISO8601DateTime
  fulfillmentMethod: OrderFulfillmentMethodEnum!
  fulfillments: [OrderFulfillment!]!
  giftMessage: String
  id: ID!
  internalOrderNumber: String!
  localRouting: Boolean!
  metadata: JSON
  notes: [Note!]!
  orderErrors: [OrderError!]
  orderItems(
    includeAll: Boolean = false
  ): [OrderItem!]!
  orderNumber: String!
  origin: OrderOriginEnum
  originFulfillmentInformation: JSON
  originOrderId: String
  originUrl: Url
  previousStatus: OrderStatus
  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
  shippingCost: Decimal
  stats: OrderStats!
  status: OrderStatus!
  statusAlerts: [OrderStatusAlert!]!
  statusName: OrderStatusEnum!
  tags: [OrderTag!]!
  thirdPartyBilling: Boolean!
  units: Int!
  updatedAt: ISO8601DateTime!
}

Fields​

Order.autoFulfill ● Boolean! non-null scalar​

Indicates if the order should be auto-fulfilled.

Order.billToCompany ● String scalar​

Order.billToEmail ● Email scalar​

Order.billToName ● String scalar​

Order.billToPhone ● PhoneNumber scalar​

Order.billingAddress ● Address object​

Order.brand ● Brand! non-null object​

The brand object of the order. User must have the read_brand permission.

Order.brandId ● ID! non-null scalar​

Order.createdAt ● ISO8601DateTime! non-null scalar​

Order.createdBy ● Party! non-null object​

The party that created the order.

Order.createdById ● ID! non-null scalar​

Order.deliveredDate ● ISO8601DateTime scalar​

Order.estimatedWeight ● Decimal! non-null scalar​

The estimated weight of the order. This value is calculated based on the weight of the products.

Order.expectedDeliveryDate ● ISO8601DateTime scalar​

Order.expectedShipDate ● ISO8601DateTime scalar​

Order.financial ● OrderFinancial! non-null object​

The financial information of the order.

Order.financialStatus ● OrderFinancialStatusEnum! non-null enum​

The financial status of the order.

Order.firstShipDate ● ISO8601DateTime scalar​

The date when the first item of the order was shipped.

Order.fulfillmentMethod ● OrderFulfillmentMethodEnum! non-null enum​

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​

The fulfillments of the order. An order can have zero or more fulfillments.

Order.giftMessage ● String scalar​

The gift message of the order.

Order.id ● ID! non-null scalar​

Order.internalOrderNumber ● String! non-null scalar​

The auto-generated internal order number. This number is used for internal purposes and is unique per order.

Order.localRouting ● Boolean! non-null scalar​

Indicates if the order should be routed locally.

Order.metadata ● JSON scalar​

The metadata that is part of the order.

Order.notes ● [Note!]! non-null object​

The notes that are part of the order.

Order.orderErrors ● [OrderError!] list object​

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​

The products that are part of the order.

Order.orderItems.includeAll ● Boolean scalar​

Indicates if all items, including those that don't exists in the system, should be included.

Order.orderNumber ● String! non-null scalar​

Order.origin ● OrderOriginEnum enum​

The name of the external system where the order originated.

Order.originFulfillmentInformation ● JSON scalar​

The fulfillment information from the external system.

Order.originOrderId ● String scalar​

The order ID from the external system.

Order.originUrl ● Url scalar​

The URL of the order in the external system if available.

Order.previousStatus ● OrderStatus object​

The previous status object of the order.

Order.responsible ● Person object​

The person that is responsible for the order.

Order.responsibleId ● ID scalar​

Order.routingStrategy ● [RoutingStrategyEnum!]! non-null enum​

The routing strategy to use when routing orders from this channel.

Order.salesChannel ● SalesChannel! non-null object​

The sales channel object of the order. User must have the read_sales_channel permission.

Order.salesChannelId ● ID! non-null scalar​

Order.selectedCarrier ● Carrier deprecated object​

DEPRECATED

Deprecated in favor of shippingCarrierService.

Order.selectedCarrierId ● ID deprecated scalar​

DEPRECATED

Deprecated in favor of shippingCarrierService.

Order.selectedCarrierService ● CarrierService deprecated object​

DEPRECATED

Deprecated in favor of shippingCarrierService.

Order.selectedCarrierServiceId ● ID deprecated scalar​

DEPRECATED

Deprecated in favor of shippingCarrierService.

Order.shipToCompany ● String scalar​

Order.shipToEmail ● Email scalar​

Order.shipToName ● String scalar​

Order.shipToPhone ● PhoneNumber scalar​

Order.shipToSameAsBillTo ● Boolean! non-null scalar​

Indicates if the Ship To information is the same as the Bill To information.

Order.shipments ● [OrderShipmentUnion!]! non-null union​

The shipments of the order. An order can have zero or more shipments.

Order.shippedDate ● ISO8601DateTime deprecated scalar​

DEPRECATED

User firstShipDate instead.

Order.shippingAddress ● Address object​

Order.shippingCarrierService ● String scalar​

Order.shippingCost ● Decimal scalar​

Order.stats ● OrderStats! non-null object​

The statistics of the order.

Order.status ● OrderStatus! non-null object​

The status object of the order.

Order.statusAlerts ● [OrderStatusAlert!]! non-null object​

The alerts associated with the status.

Order.statusName ● OrderStatusEnum! non-null enum​

The code name of the order status.

Order.tags ● [OrderTag!]! non-null object​

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​

Indicates if the order shipping is billed to a third party.

Order.units ● Int! non-null scalar​

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​

Returned By​

allocateOrder mutation ● createOrder mutation ● order query ● shipOrderManually mutation ● unfulfillOrder mutation ● updateOrder mutation

Member Of​

OrderConnection object ● OrderEdge object ● OrderFulfillment object ● OrderStatus object ● OrderStatusAlert object

Implemented By​

Notable union