OrderWithPayments

OBJECT

Definition

type OrderWithPayments implements Node & BaseOrder {
  id: String!
  payments(filters: PaymentsFiltersInput, before: String, after: String, first: Int, last: Int): PaymentsConnection!
  entityId: Int!
  orderedAt: DateTimeExtended!
  updatedAt: DateTimeExtended!
  status: OrderStatus!
  billingAddress: OrderBillingAddress!
  isTaxIncluded: Boolean!
  consignments: OrderConsignments
  subTotal: Money!
  discountedSubTotal: Money
  discounts: OrderDiscounts!
  wrappingCostTotal: Money!
  shippingCostTotal: Money!
  handlingCostTotal: Money!
  taxTotal: Money!
  taxes: [OrderTax!]!
  totalIncTax: Money!
  customerMessage: String
  totalProductQuantity: Int!
  backorderShippingExpectationMessage: String
  comparisonShippingCost: Money
  fees: [OrderFee!]!
  metafields(namespace: String!, keys: [String!], before: String, after: String, first: Int, last: Int): MetafieldConnection!
  cartMetafields(namespace: String!, keys: [String!], before: String, after: String, first: Int, last: Int): MetafieldConnection!
  permalink: String
}

A node for fetching a single order with payment data.

Fields

idStringRequired

The ID of an object.

paymentsPaymentsConnectionRequired

The list of payments for an order.

entityIdIntegerRequired

Order ID.

orderedAtDateTimeExtendedRequired

Date and time the order was placed.

updatedAtDateTimeExtendedRequired

Date and time the order was last updated.

statusOrderStatusRequired

Order status.

billingAddressOrderBillingAddressRequired

Billing address.

isTaxIncludedBooleanRequired

Indicates whether the taxes are included in the order total.

subTotalMoneyRequired

Subtotal.

discountsOrderDiscountsRequired

Discounts.

wrappingCostTotalMoneyRequired

Total cost of wrapping.

shippingCostTotalMoneyRequired

Total cost of shipping.

handlingCostTotalMoneyRequired

Total cost of handling.

taxTotalMoneyRequired

Total tax.

taxeslist of OrderTaxesRequired

Taxes.

totalIncTaxMoneyRequired

The final order total payable amount inclusive of tax, before applying any store credit or gift certificate.

totalProductQuantityIntegerRequired

The total quantity of products in the order.

feeslist of OrderFeesRequired

Order-level fees applied to the order.

metafieldsMetafieldConnectionRequired

Metafield data related to an order.

cartMetafieldsMetafieldConnectionRequired

Cart metafields associated with the order.

consignmentsOrderConsignmentsOptional

Consignments.

discountedSubTotalMoneyOptional

Discounted total for the order to display to shopper, only product-level automatic discounts are discounted on the sub-total directly.

customerMessageStringOptional

Message from customer

backorderShippingExpectationMessageStringOptional

Shipping expectation message on the order.

comparisonShippingCostMoneyOptional

The total shipping cost to be shown to shopper in the summary as struck-through.

permalinkStringOptionalDeprecated

Permalink URL for the order confirmation page. Returns a URL for supported orders, null for unsupported orders.

Deprecated: Alpha version. Do not use in production.

Referenced by

Fields

Site.order