Checkout

Checkout object.

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

Show more ↓

Fields

Checkout.created ● DateTime! non-null scalar

Checkout.lastChange ● DateTime! non-null scalar

Checkout.user ● User object

Checkout.quantity ● Int! non-null scalar

Checkout.billingAddress ● Address object

Checkout.shippingAddress ● Address object

Checkout.note ● String! non-null scalar

Checkout.currency ● String! non-null scalar

Transaction currency.

Checkout.discount ● Money object

Checkout.discountName ● String scalar

Checkout.translatedDiscountName ● String scalar

Checkout.voucherCode ● String scalar

Checkout.poNumbers ● [String!] list scalar

Checkout.id ● ID! non-null scalar

The ID of the object

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

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

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

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

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

Available shipping methods for marketplace-fulfilled items in this checkout.

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

Available shipping methods for each seller in this checkout.

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

List of available payment gateways.

Checkout.email ● String! non-null scalar

Email of a customer.

Checkout.isShippingRequired ● Boolean! non-null scalar

Returns True, if checkout requires shipping.

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

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

Checkout.shippingPrice ● TaxedMoney! non-null object

The price of the shipping, with all the taxes included.

Checkout.discountedShippingPrice ● Money object

The price of the shipping after discount

Checkout.originalSubtotalPrice ● Money! non-null object

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

Checkout.subtotalPrice ● TaxedMoney! non-null object

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

Checkout.token ● NauticalUUID! non-null scalar

The checkout's token.

Checkout.totalPrice ● TaxedMoney! non-null object

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

Checkout.discountType ● VoucherTypeEnum enum

Discount Type if voucher is applied

Checkout.totalDiscount ● Money! non-null object

The sum of all discounts, including sales and vouchers

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

A list of structured checkout shipping methods.

Checkout.shippingSaleDiscount ● Money! non-null object

Shipping discount for this order

Checkout.marketplaceShippingMethod ● ShippingMethod object

Shipping method for this order.

Checkout.marketplaceShippingPrice ● TaxedMoney! non-null object

The price of the marketplace shipping.

Checkout.isAuthenticated ● Boolean! non-null scalar

Whether the checkout has an authenticated user.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

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 ● Payment object ● User object