Skip to main content

V2Order

The V2 order type. This type represents a V2 order in the system with only the fields necessary for draft creation and details.

type V2Order {
  acceptedAt: ISO8601DateTime
  billToCompany: String
  billToEmail: Email
  billToName: String
  billToPhone: PhoneNumber
  billingAddress: Address
  brand: Brand!
  brandId: ID!
  committedAt: ISO8601DateTime
  completedAt: ISO8601DateTime
  createdAt: ISO8601DateTime!
  enrichmentData: EnrichmentOrderData
  expectedShipDate: ISO8601DateTime
  financialStatus: OrderFinancialStatusEnum!
  firstShipDate: ISO8601DateTime
  fulfillments: [OrderFulfillment!]!
  giftMessage: String
  id: ID!
  orderItems(
    includeAll: Boolean = false
  ): [OrderItem!]!
  orderNumber: String!
  orderType: OrderTypeEnum!
  origin: OrderOriginEnum
  originFulfillmentInformation: JSON
  originUrl: Url
  previousStatus: OrderStatus
  salesChannel: SalesChannel!
  salesChannelId: ID!
  shipToCompany: String
  shipToEmail: Email
  shipToName: String
  shipToPhone: PhoneNumber
  shipToSameAsBillTo: Boolean!
  shipments: [OrderShipmentUnion!]!
  shippingAddress: Address
  shippingCost: Decimal
  sourceIntegration: Integration
  sourceIntegrationId: ID
  state: OrderStateEnum
  statusAlerts: [OrderStatusAlert!]!
  statusName: OrderStatusEnum!
  subtotalPrice: Decimal!
  tags: [OrderTag!]!
  totalDiscount: Decimal!
  totalPrice: Decimal!
  totalTax: Decimal!
  updatedAt: ISO8601DateTime!
}

Fields​

V2Order.acceptedAt ● ISO8601DateTime scalar​

The date when the order was accepted (set when order transitions to accepted state).

V2Order.billToCompany ● String scalar​

V2Order.billToEmail ● Email scalar​

V2Order.billToName ● String scalar​

V2Order.billToPhone ● PhoneNumber scalar​

V2Order.billingAddress ● Address object​

V2Order.brand ● Brand! non-null object​

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

V2Order.brandId ● ID! non-null scalar​

V2Order.committedAt ● ISO8601DateTime scalar​

The date when the order was committed (transitioned from draft to accepted).

V2Order.completedAt ● ISO8601DateTime scalar​

The date when the order was completed (transitioned from accepted to completed).

V2Order.createdAt ● ISO8601DateTime! non-null scalar​

V2Order.enrichmentData ● EnrichmentOrderData object​

Enriched order data for wholesale orders. Will be null for regular orders.

V2Order.expectedShipDate ● ISO8601DateTime scalar​

V2Order.financialStatus ● OrderFinancialStatusEnum! non-null enum​

The financial status of the order.

V2Order.firstShipDate ● ISO8601DateTime scalar​

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

V2Order.fulfillments ● [OrderFulfillment!]! non-null object​

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

V2Order.giftMessage ● String scalar​

The gift message of the order.

V2Order.id ● ID! non-null scalar​

V2Order.orderItems ● [OrderItem!]! non-null object​

The products that are part of the order.

V2Order.orderItems.includeAll ● Boolean scalar​

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

V2Order.orderNumber ● String! non-null scalar​

V2Order.orderType ● OrderTypeEnum! non-null enum​

The type of the order. This can be either B2B for wholesale orders or DTC for regular orders.

V2Order.origin ● OrderOriginEnum enum​

The name of the external system where the order originated.

V2Order.originFulfillmentInformation ● JSON scalar​

The fulfillment information from the external system.

V2Order.originUrl ● Url scalar​

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

V2Order.previousStatus ● OrderStatus object​

The previous status object of the order.

V2Order.salesChannel ● SalesChannel! non-null object​

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

V2Order.salesChannelId ● ID! non-null scalar​

V2Order.shipToCompany ● String scalar​

V2Order.shipToEmail ● Email scalar​

V2Order.shipToName ● String scalar​

V2Order.shipToPhone ● PhoneNumber scalar​

V2Order.shipToSameAsBillTo ● Boolean! non-null scalar​

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

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

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

V2Order.shippingAddress ● Address object​

V2Order.shippingCost ● Decimal scalar​

The shipping cost paid by the customer.

V2Order.sourceIntegration ● Integration object​

The integration object that received this order.

V2Order.sourceIntegrationId ● ID scalar​

The ID for the integration that received this order.

V2Order.state ● OrderStateEnum enum​

The current state of the V2 order (draft, accepted, completed).

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

The alerts associated with the status.

V2Order.statusName ● OrderStatusEnum! non-null enum​

The code name of the order status (mapped from state for compatibility).

V2Order.subtotalPrice ● Decimal! non-null scalar​

The subtotal amount of the order.

V2Order.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.

V2Order.totalDiscount ● Decimal! non-null scalar​

The total discount applied to the order.

V2Order.totalPrice ● Decimal! non-null scalar​

The total price of the order.

V2Order.totalTax ● Decimal! non-null scalar​

The total tax paid by the customer.

V2Order.updatedAt ● ISO8601DateTime! non-null scalar​

Returned By​

acceptPendingOrder mutation ● commitDraftOrder mutation ● completeOrder mutation ● createDraftOrder mutation ● createFulfillmentsByRoutingStrategy mutation ● createPendingOrder mutation ● saveDraftOrder mutation ● updateOrderCustomerInformation mutation ● updateOrderFinancialInformation mutation ● updateOrderGiftMessage mutation ● updateOrderItems mutation ● updateOrderRoutingInstructions mutation ● updateOrderShippingInstructions mutation ● updateOrderSpecialInstructions mutation ● v2Order query