OBJECT

CartItemDeliveryMethodGroup

A grouping of cart items that all have the same delivery method. Most of the fields are aggregations of individual cart item fields.

link GraphQL Schema definition

  • type CartItemDeliveryMethodGroup {
  • # 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!
  • deliveryMethod: DeliveryMethodEnum!
  • # Total amount of monetary discounts. Denominated in cents.
  • discountCents: Int!
  • # Total amount of monetary discounts formatted in the given currency.
  • #
  • # Arguments
  • # currency: Currency in which to display any monetary discounts.
  • # Defaults to the currency of the marketplace's home country.
  • discountFormatted(currency: String): String!
  • internationalShippingAvailable: Boolean!
  • # For deliverable items, whether the buyer's country matches the seller's country
  • # for all associated cart items.
  • internationalShippingRequired: Boolean!
  • # Sum of the shipping costs of the cart items. Denominated in cents.
  • shippingCostCents: Int!
  • # General description of the delivery method and estimated time in transit for the
  • # shipment.
  • shippingDescription: String!
  • # List of descriptions of potential or applied shipping discounts for this group
  • # of cart items. Includes any relevant promotions and information about free
  • # shipping when available.
  • #
  • # Arguments
  • # currency: Currency in which to display any monetary discounts.
  • # Defaults to the currency of the marketplace's home country.
  • shippingDiscountDescriptions(currency: String): [String!]!
  • # For cart item groups that have a shipping discount or free shipping, this text
  • # can replace the shipping cost in the list of line items.
  • shippingDiscountLineItem: String
  • # Message for user, informing them of the location from where their purchase will
  • # be shipped if applicable
  • #
  • # Arguments
  • # useCity: Whether to include the name of the city that the item
  • # is shipping from in the message.
  • shippingFromLocationMessage(useCity: Boolean): String
  • # Sum of the tax amount for the shipping cost. Denominated in cents. Whether this
  • # amount is included in the base shipping cost depends on the website's home
  • # country (i.e. Australia's GST is included in an item's price, but sales tax in
  • # the U.S. is added on separately).
  • shippingTaxCents: Int!
  • # Sum of the cost of the cart items (price x quantity), plus any additional fees
  • # applied by the seller. Denominated in cents.
  • subtotalCents: Int!
  • # List of descriptions of promotional discounts applied to the subtotal of this
  • # group of cart items
  • #
  • # Arguments
  • # currency: Currency in which to display any monetary discounts.
  • # Defaults to the currency of the marketplace's home country.
  • subtotalDiscountDescriptions(currency: String): [String!]!
  • # Sum of the total cost of the cart items, which includes subtotals and cost of
  • # shipping if applicable. Denominated in cents.
  • totalCents: Int!
  • }