Checkout

Checkout object.

type Checkout implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  token: NauticalUUID!
  note: String!
  currency: String!
  created: DateTime!
  lastChange: DateTime!
  quantity: Int!
  discountName: String
  translatedDiscountName: String
  voucherCode: String
  poNumbers: [String!]
  isAuthenticated: Boolean!
  email: String!
  user: User
  billingAddress: Address
  shippingAddress: Address
  discount: Money
  lines: [CheckoutLine!]!
  lineCount: Int!
  shippingMethods: [CheckoutSellerShipping!]!
  marketplaceShippingMethod: ShippingMethod
  isShippingRequired: Boolean!
  totalPrice: TaxedMoney!
  subtotalPrice: TaxedMoney!
  originalSubtotalPrice: Money!
  shippingPrice: TaxedMoney!
  discountedShippingPrice: Money
  marketplaceShippingPrice: TaxedMoney!
  totalDiscount: Money!
  shippingSaleDiscount: Money!
  discountType: VoucherTypeEnum
  availablePaymentGateways: [PaymentGateway!]!
  availableMarketplaceShippingMethods: [ShippingMethod!]!
  availableShippingMethodsBySeller: [MultiSellerShippingMethod!]!
}

Show more ↓

Fields

Checkout.id ● ID! non-null scalar

The ID of the checkout.

Checkout.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Checkout.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items. Requires proper staff permissions to access.

Checkout.token ● NauticalUUID! non-null scalar

The checkout's token.

Checkout.note ● String! non-null scalar

Checkout note.

Checkout.currency ● String! non-null scalar

Currency code.

Checkout.created ● DateTime! non-null scalar

When the checkout was created.

Checkout.lastChange ● DateTime! non-null scalar

When the checkout was last modified.

Checkout.quantity ● Int! non-null scalar

Total quantity of items.

Checkout.discountName ● String scalar

Name of the applied discount.

Checkout.translatedDiscountName ● String scalar

Translated name of the applied discount.

Checkout.voucherCode ● String scalar

Applied voucher code.

Checkout.poNumbers ● [String!] list scalar

List of purchase order numbers.

Checkout.isAuthenticated ● Boolean! non-null scalar

Whether the checkout has an authenticated user.

Checkout.email ● String! non-null scalar

Email of the customer.

Checkout.user ● User object

The user who owns this checkout.

Checkout.billingAddress ● Address object

The billing address for this checkout.

Checkout.shippingAddress ● Address object

The shipping address for this checkout.

Checkout.discount ● Money object

The discount amount applied.

Checkout.lines ● [CheckoutLine!]! non-null object

A list of checkout lines, each containing information about an item.

Checkout.lineCount ● Int! non-null scalar

Number of line items.

Checkout.shippingMethods ● [CheckoutSellerShipping!]! non-null object

A list of structured checkout shipping methods.

Checkout.marketplaceShippingMethod ● ShippingMethod object

The marketplace shipping method if set.

Checkout.isShippingRequired ● Boolean! non-null scalar

Returns True if checkout requires shipping.

Checkout.totalPrice ● TaxedMoney! non-null object

The sum of the checkout line prices, with all the taxes, shipping costs, and discounts included.

Checkout.subtotalPrice ● TaxedMoney! non-null object

The price of the checkout before shipping, after sales and vouchers.

Checkout.originalSubtotalPrice ● Money! non-null object

The price of the checkout before shipping, sales, and vouchers.

Checkout.shippingPrice ● TaxedMoney! non-null object

The price of the shipping, with all taxes included.

Checkout.discountedShippingPrice ● Money object

The price of the shipping after discount.

Checkout.marketplaceShippingPrice ● TaxedMoney! non-null object

The price of the marketplace shipping.

Checkout.totalDiscount ● Money! non-null object

The sum of all discounts, including sales and vouchers.

Checkout.shippingSaleDiscount ● Money! non-null object

Shipping discount for this order from sales.

Checkout.discountType ● VoucherTypeEnum enum

Discount type if voucher is applied.

Checkout.availablePaymentGateways ● [PaymentGateway!]! non-null object

List of available payment gateways.

Checkout.availableMarketplaceShippingMethods ● [ShippingMethod!]! non-null object

Available shipping methods for marketplace-fulfilled items.

Checkout.availableShippingMethodsBySeller ● [MultiSellerShippingMethod!]! non-null object

Available shipping methods for each seller in this checkout.

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Returned By

checkout query

Member Of

CheckoutAddPONumbers object ● CheckoutAddPromoCode object ● CheckoutBillingAddressUpdate object ● CheckoutCountableEdge object ● CheckoutCreate object ● CheckoutCustomerAttach object ● CheckoutCustomerDetach object ● CheckoutDelete object ● CheckoutEmailUpdate object ● CheckoutLineDelete object ● CheckoutLinesAdd object ● CheckoutLinesUpdate object ● CheckoutMarketplaceShippingMethodUpdate object ● CheckoutNoteUpdate object ● CheckoutPaymentCreate object ● CheckoutRemovePONumbers object ● CheckoutRemovePromoCode object ● CheckoutSellerShippingMethodsBulkUpdate object ● CheckoutSellerShippingMethodsClear object ● CheckoutSellerShippingMethodsUpdate object ● CheckoutSetTransactionCurrency object ● CheckoutShippingAddressUpdate object ● User object