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
additionalData: JSON!
archiveBlockingReasons: [String!]!
archived: Boolean!
archivedAt: ISO8601DateTime
b2bData: V2OrderB2BData
billToCompany: String
billToEmail: Email
billToName: String
billToPhone: PhoneNumber
billingAddress: Address
brand: Brand @deprecated
brandId: ID @deprecated
canBeArchived: Boolean!
cartonLabelsProvider: CartonLabelsProviderEnum!
committedAt: ISO8601DateTime
completedAt: ISO8601DateTime
createdAt: ISO8601DateTime!
customer: Customer
customerId: ID
draftFinancialDocument: OrderFinancialDocument
endShippingDate: ISO8601DateTime
expectedShipDate: ISO8601Date
financialDocuments: [OrderFinancialDocument!]!
financialStatus: OrderFinancialStatusEnum!
firstShipDate: ISO8601DateTime
fulfillmentOrderCoverage: FulfillmentOrderCoverage!
fulfillments: [OrderFulfillment!]!
giftMessage: String
held: Boolean!
holds(
filter: HoldFilter = ACTIVE
): [V2OrderHold!]!
id: ID!
instructions: String
integrationManagedFields: [OrderIntegrationManagedField!]!
note: String @deprecated
orderItemFulfillmentStatuses: [OrderItemFulfillmentStatus!]!
orderItems(
includeAll: Boolean = false
): [OrderItem!]!
orderNumber: String!
orderType: OrderTypeEnum!
origin: OrderOriginEnum
originFulfillmentInformation: JSON
originOrderId: String
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 @deprecated
shippingCostMonetary: MonetaryValue
shippingInformation: ShippingInformation
sourceFulfillmentPlan: SourceFulfillmentPlan
sourceIntegration: Integration
sourceIntegrationId: ID
startShippingDate: ISO8601DateTime
state: OrderStateEnum
statusAlerts: [OrderStatusAlert!]!
statusName: OrderStatusEnum!
subtotalPrice: Decimal! @deprecated
subtotalPriceMonetary: MonetaryValue
tags: [OrderTag!]!
thirdPartyBilling: Boolean! @deprecated
totalDiscount: Decimal! @deprecated
totalDiscountMonetary: MonetaryValue
totalPrice: Decimal! @deprecated
totalPriceMonetary: MonetaryValue
totalTax: Decimal! @deprecated
totalTaxMonetary: MonetaryValue
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.additionalData ● JSON! non-null scalar common
Free-form order-level key/value data.
V2Order.archiveBlockingReasons ● [String!]! non-null scalar common
Human-readable reasons why the record cannot be archived, or empty if it can.
V2Order.archived ● Boolean! non-null scalar common
Whether the record is archived.
V2Order.archivedAt ● ISO8601DateTime scalar common
When the record was archived, or null if it is not archived.
V2Order.b2bData ● V2OrderB2BData object orders
B2B data for this order.
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.canBeArchived ● Boolean! non-null scalar common
Whether the record can be archived according to its archiving rules.
V2Order.cartonLabelsProvider ● CartonLabelsProviderEnum! non-null enum shipments
Which carton label generator this order's containers can use. ENDLESS_EDI
when the sales channel has a label mapping and the integration has an API
token; ENDLESS_EDI_UNAVAILABLE when it has the mapping but no token, where
the local label would not satisfy the retailer; LOCAL otherwise.
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.customer ● Customer object common
The linked buying customer, including archived customers.
V2Order.customerId ● ID scalar common
The buying customer linked to this order.
V2Order.draftFinancialDocument ● OrderFinancialDocument object orders
An unsaved, order-sourced accounting document the user can create manually from the UI on any sales channel. Present until an order-sourced document exists; its document type defaults to the sales channel's invoicing_type. Fulfillment/shipment-scoped documents are auto-created per entity and can coexist with it.
V2Order.endShippingDate ● ISO8601DateTime scalar common
End of the requested shipping window.
V2Order.expectedShipDate ● ISO8601Date scalar common
V2Order.financialDocuments ● [OrderFinancialDocument!]! non-null object orders
The order's persisted accounting documents (sales receipts / invoices). Zero,
one, or many entries depending on the sales channel's invoicing_scope and how
many fulfillments/shipments the order has. Empty until a document is created —
the UI offers a create action that persists the draftFinancialDocument.
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.fulfillmentOrderCoverage ● FulfillmentOrderCoverage! non-null object orders
Whether the sales order's fulfillment orders cover its ordered units line by line, plus the gaps when they don't.
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.instructions ● String scalar common
Customer or sales-channel instructions for the order.
V2Order.integrationManagedFields ● [OrderIntegrationManagedField!]! non-null object orders
Fields the source integration manages on this order.
V2Order.note ● String deprecated scalar common
Use instructions.
Customer or sales-channel instructions for the order.
V2Order.orderItemFulfillmentStatuses ● [OrderItemFulfillmentStatus!]! non-null object orders
Derived fulfillment status for each active sales order line item.
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.originOrderId ● String scalar common
The order's identifier in the external system that created it, if any.
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, including archived channels. 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 deprecated scalar common
Use shippingCostMonetary instead.
The shipping cost paid by the customer.
V2Order.shippingCostMonetary ● MonetaryValue object 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.sourceFulfillmentPlan ● SourceFulfillmentPlan object common
The latest saved source plan, or null until a plan is received from the current source.
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.startShippingDate ● ISO8601DateTime scalar common
Start of the requested shipping window.
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! deprecated non-null scalar common
Use subtotalPriceMonetary instead.
The subtotal amount of the order.
V2Order.subtotalPriceMonetary ● MonetaryValue object 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! deprecated non-null scalar common
Third-party billing now lives in B2B data. Use b2bData.thirdPartyBillingRequired instead.
Indicates if the order shipping is billed to a third party.
V2Order.totalDiscount ● Decimal! deprecated non-null scalar common
Use totalDiscountMonetary instead.
The total discount applied to the order.
V2Order.totalDiscountMonetary ● MonetaryValue object common
The total discount applied to the order.
V2Order.totalPrice ● Decimal! deprecated non-null scalar common
Use totalPriceMonetary instead.
The total price of the order.
V2Order.totalPriceMonetary ● MonetaryValue object common
The total price of the order.
V2Order.totalTax ● Decimal! deprecated non-null scalar common
Use totalTaxMonetary instead.
The total tax paid by the customer.
V2Order.totalTaxMonetary ● MonetaryValue object common
The total tax paid by the customer.
V2Order.updatedAt ● ISO8601DateTime! non-null scalar common
Returned By
acceptPendingOrder mutation ● assignOrderSourceIntegration mutation ● cancelOrderV2 mutation ● commitDraftOrder mutation ● completeOrder mutation ● createDraftOrder mutation ● createFulfillmentsByRoutingStrategy mutation ● createPendingOrder mutation ● duplicateOrder mutation ● saveDraftOrder mutation ● uncancelOrderV2 mutation ● updateOrderAdditionalData mutation ● updateOrderCustomerInformation mutation ● updateOrderDetails mutation ● updateOrderFinancialInformation mutation ● updateOrderGiftMessage mutation ● updateOrderItems mutation ● updateOrderRoutingInstructions mutation ● updateOrderShippingInstructions mutation ● updateOrderSpecialInstructions mutation ● v2Order query
Member Of
OrderSignal object ● V2OrderHold object