Preview

Cart is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

Cart

A user's cart containing items to be purchased

This page contains

    Fields

    id: ID!

    Unique identifier of the cart

    buyerUser: User! PREVIEW

    User making the purchase

    buyerAccount: Account! PREVIEW

    Account (company) associated with the purchasing user

    currency: Currency!

    The currency in which the price is presented.

    status: CartStatus! PREVIEW

    Current status of the cart (ACTIVE or FINISHED)

    locale: Locale!

    Preferred locale for the response (e.g., en-US, de, en-AU)

    items: [CartItem!]! PREVIEW

    List of items in the cart

    associations: [CartItemAssociation!]! PREVIEW

    List of item associations in the cart

    paymentMethodId: String @deprecated( reason: "Not needed during checkout process, its populated after cart is finalized" )

    Identifier of the selected payment method

    customAttributes: CartCustomAttributes PREVIEW

    Custom attributes associated with the cart

    pricingTotal: CartPricingTotal! PREVIEW

    Pricing totals for all items in the cart

    createdOn: DateTime!

    Timestamp when the cart was created

    Mutations for Cart

    addItemsToCart PREVIEW

    Creates a new cart or adds items to an existing active cart

    applyDiscountToCart PREVIEW

    Applies a discount code to the cart

    removeDiscountFromCart PREVIEW

    Removes a discount code from the cart

    removeItemsFromCart PREVIEW

    Removes specified items from the cart

    updateCartCustomAttributes PREVIEW

    Updates custom attributes of an existing cart

    updateCartItems PREVIEW

    Updates items in an existing cart

    Queries for Cart

    activeCart PREVIEW

    Retrieves the active cart for the current user

    activeCartOfUser PREVIEW

    Retrieves the active cart for a specific user