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 @deprecated
brandId: ID @deprecated
committedAt: ISO8601DateTime
completedAt: ISO8601DateTime
createdAt: ISO8601DateTime!
enrichmentData: EnrichmentOrderData
expectedShipDate: ISO8601Date
financialStatus: OrderFinancialStatusEnum!
firstShipDate: ISO8601DateTime
fulfillments: [OrderFulfillment!]!
giftMessage: String
held: Boolean!
holds(
filter: HoldFilter = ACTIVE
): [V2OrderHold!]!
id: ID!
orderAuthority: AuthorityState!
orderItems(
includeAll: Boolean = false
): [OrderItem!]!
orderNumber: String!
orderType: OrderTypeEnum!
origin: OrderOriginEnum
originFulfillmentInformation: JSON
originUrl: Url
originalCarrierService: String
previousStatus: OrderStatus
requestedCarrierServiceId: String
requestedCarrierServiceName: String
salesChannel: SalesChannel!
salesChannelId: ID!
shipToCompany: String
shipToEmail: Email
shipToName: String
shipToPhone: PhoneNumber
shipToSameAsBillTo: Boolean!
shipments: [OrderShipmentUnion!]!
shippingAddress: Address
shippingCost: Decimal
shippingInformation: ShippingInformation
sourceIntegration: Integration
sourceIntegrationId: ID
state: OrderStateEnum
statusAlerts: [OrderStatusAlert!]!
statusName: OrderStatusEnum!
subtotalPrice: Decimal!
tags: [OrderTag!]!
thirdPartyBilling: Boolean!
totalDiscount: Decimal!
totalPrice: Decimal!
totalTax: Decimal!
updatedAt: ISO8601DateTime!
}
Fields
V2Order.acceptedAt ● ISO8601DateTime scalar common
The date when the order entered the ordered state (preserved field name for wire compatibility with v1 clients).
V2Order.billToCompany ● String scalar common
V2Order.billToEmail ● Email scalar common
V2Order.billToName ● String scalar common
V2Order.billToPhone ● PhoneNumber scalar common
V2Order.billingAddress ● Address object common
V2Order.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.
V2Order.brandId ● ID deprecated scalar common
This field will be removed in the future. Brand is becoming a product-only attribute.
V2Order.committedAt ● ISO8601DateTime scalar common
The date when the order was committed (transitioned from draft to ordered).
V2Order.completedAt ● ISO8601DateTime scalar common
The date when the order was fulfilled (transitioned to the fulfilled terminal state; preserved field name for wire compatibility with v1 clients).
V2Order.createdAt ● ISO8601DateTime! non-null scalar common
V2Order.enrichmentData ● EnrichmentOrderData object orders
Enriched order data for wholesale orders. Will be null for regular orders.
V2Order.expectedShipDate ● ISO8601Date scalar common
V2Order.financialStatus ● OrderFinancialStatusEnum! non-null enum orders
The financial status of the order.
V2Order.firstShipDate ● ISO8601DateTime scalar common
The date when the first item of the order was shipped.
V2Order.fulfillments ● [OrderFulfillment!]! non-null object orders
The fulfillments of the order. An order can have zero or more fulfillments.
V2Order.giftMessage ● String scalar common
The gift message of the order.
V2Order.held ● Boolean! non-null scalar common
True while the order has any active (unreleased) hold. Guarded fulfillment transitions are rejected while held.
V2Order.holds ● [V2OrderHold!]! non-null object orders
The holds on the order, filtered by the supplied filter.
V2Order.holds.filter ● HoldFilter enum common
Which holds to return: ACTIVE (default), RELEASED, or ALL.
V2Order.id ● ID! non-null scalar common
V2Order.orderAuthority ● AuthorityState! non-null object common
Authority state for the order scope.
V2Order.orderItems ● [OrderItem!]! non-null object orders
The products that are part of the order.
V2Order.orderItems.includeAll ● Boolean scalar common
Indicates if all items, including those that don't exists in the system, should be included.
V2Order.orderNumber ● String! non-null scalar common
V2Order.orderType ● OrderTypeEnum! non-null enum orders
The type of the order. This can be either B2B for wholesale orders or DTC for regular orders.
V2Order.origin ● OrderOriginEnum enum orders
The name of the external system where the order originated.
V2Order.originFulfillmentInformation ● JSON scalar common
The fulfillment information from the external system.
V2Order.originUrl ● Url scalar common
The URL of the order in the external system if available.
V2Order.originalCarrierService ● String scalar common
The raw shipping method string from the external integration, exactly as received.
V2Order.previousStatus ● OrderStatus object orders
The previous status object of the order.
V2Order.requestedCarrierServiceId ● String scalar common
V2Order.requestedCarrierServiceName ● String scalar common
V2Order.salesChannel ● SalesChannel! non-null object sales-channels
The sales channel object of the order. User must have the read_sales_channel permission.
V2Order.salesChannelId ● ID! non-null scalar common
V2Order.shipToCompany ● String scalar common
V2Order.shipToEmail ● Email scalar common
V2Order.shipToName ● String scalar common
V2Order.shipToPhone ● PhoneNumber scalar common
V2Order.shipToSameAsBillTo ● Boolean! non-null scalar common
Indicates if the Ship To information is the same as the Bill To information.
V2Order.shipments ● [OrderShipmentUnion!]! non-null union shipments
The shipments of the order. An order can have zero or more shipments.
V2Order.shippingAddress ● Address object common
V2Order.shippingCost ● Decimal scalar common
The shipping cost paid by the customer.
V2Order.shippingInformation ● ShippingInformation object orders
The order's normalized ShippingInformation (EC-3265). Nil until backfilled or dual-written.
V2Order.sourceIntegration ● Integration object integrations
The integration object that received this order.
V2Order.sourceIntegrationId ● ID scalar common
The ID for the integration that received this order.
V2Order.state ● OrderStateEnum enum orders
The current state of the V2 order (draft, pending, ordered, in_progress, fulfilled).
V2Order.statusAlerts ● [OrderStatusAlert!]! non-null object orders
The alerts associated with the status.
V2Order.statusName ● OrderStatusEnum! non-null enum orders
The code name of the order status (mapped from state for compatibility).
V2Order.subtotalPrice ● Decimal! non-null scalar common
The subtotal amount of the order.
V2Order.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.
V2Order.thirdPartyBilling ● Boolean! non-null scalar common
Indicates if the order shipping is billed to a third party.
V2Order.totalDiscount ● Decimal! non-null scalar common
The total discount applied to the order.
V2Order.totalPrice ● Decimal! non-null scalar common
The total price of the order.
V2Order.totalTax ● Decimal! non-null scalar common
The total tax paid by the customer.
V2Order.updatedAt ● ISO8601DateTime! non-null scalar common
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
Member Of
V2OrderHold object