OBJECT

Cart

A cart object just waiting to transform into an order.

link GraphQL Schema definition

  • type Cart implements Node {
  • # The shipping address associated to the cart. Required for checkout.
  • address: Address
  • # The billing address associated to the cart. Required for checkout.
  • billingAddress: Address
  • # The company name of the bill recipient.
  • billingCompanyName: String
  • # The email address of the bill recipient. Required for checkout.
  • billingEmailAddress: String
  • # The first name of the bill recipient. Required for checkout.
  • billingFirstName: String
  • # The phone number of the bill recipient. Depending on marketplace configuration,
  • # can be required for checkout
  • billingPhone: String
  • # The surname of the bill recipient. Required for checkout.
  • billingSurname: String
  • # The total buyable quantity of all items in the cart.
  • buyableQuantity: Int!
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • cartItems(after: String, before: String, first: Int, last: Int): CartItemConnection!
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • cartSellers(after: String, before: String, first: Int, last: Int): CartSellersConnection!
  • # The company name of the user who owns the cart.
  • companyName: String
  • # A coupon code that has been applied to the cart. Will return an error if the
  • # coupon is invalid
  • couponCode: String
  • # Timestamp at which the cart was created.
  • createdAt: ISO8601DateTime!
  • # The discount applied to the cart. Negative value. Denominated in cents.
  • discountCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The discount applied to the cart. Negative value. In string with currency
  • # symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • discountFormatted(currency: String): String!
  • # The email address of the user who owns the cart. Required for checkout.
  • emailAddress: String
  • # The first name of the user who owns the cart. Required for checkout.
  • firstName: String
  • id: ID!
  • # Is this order a gift order? Defaults to false.
  • isGift: Boolean
  • # A message that will be sent to the gift recipient.
  • messageToGiftRecipient: String
  • # A message that will be sent to the seller.
  • messageToSeller: String
  • # The phone number of the user who owns the cart. Depending on marketplace
  • # configuration, can be required for checkout
  • phone: String
  • # The cart postage cost. Denominated in cents.
  • shippingCostCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The cart postage cost. In string with currency symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • shippingCostFormatted(currency: String): String!
  • # The cart subtotal, excluding discounts and postage. Tax is included for tax
  • # inclusive marketplaces. Denominated in cents.
  • subtotalCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The cart subtotal, excluding discounts and postage. Tax is included for tax
  • # inclusive marketplaces. In string with currency symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • subtotalFormatted(currency: String): String!
  • # The surname of the user who owns the cart. Required for checkout.
  • surname: String
  • # The status of the tax calculation on a cart. Returns an enumerable value.
  • taxCalculationStatus: CartTaxCalculationStatusEnum
  • # The tax on the cart. Denominated in cents.
  • taxTotalCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The tax on the cart. In string with currency symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • taxTotalFormatted(currency: String): String!
  • # Required for retrieving or modifying cart data.
  • token: String!
  • # The cart total. Denominated in cents.
  • totalCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The cart total. In string with currency symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • totalFormatted(currency: String): String!
  • # Timestamp at which the cart was most recently changed.
  • updatedAt: ISO8601DateTime!
  • # The user associated to the cart.
  • user: User
  • }