---
title: "List carts"
method: GET
path: "/api/sites/multiscreen/{site_name}/ecommerce/carts"
tags: ["Carts"]
---

# List carts

`GET /api/sites/multiscreen/{site_name}/ecommerce/carts`

## Request

- Base URL: `https://api.duda.co`
- URL: `https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/carts`
- Auth: HTTP basic

Returns the carts for the site, with optional filters by status, mode, and customer email, and cursor-based pagination via cursor and limit.

## Path parameters

- `site_name` string, required

## Query parameters

- `status` 'IN_PROGRESS' | 'ABANDONED'
- `mode` 'LIVE' | 'TEST'
- `email` string
- `cursor` string
- `limit` integer

## Response `200`

OK

- CartsOutputDto
  - `cursor` string, nullable: Id of the last result in this list to use as a cursor on a subsequent request
  - `has_more_results` boolean: Amount of results that will be retrieved.
  - `results` CartOutputDto[]
    - `id` string
    - `mode` 'LIVE' | 'TEST'
    - `tax_mode` 'TAXES_EXCLUDED_FROM_PRICE' | 'TAX_INCLUDED_WITH_NET_PRICE' | 'TAX_INCLUDED_WITH_GROSS_PRICE'
    - `status` 'IN_PROGRESS' | 'ABANDONED'
    - `language` string, nullable
    - `email` string, nullable
    - `site_name` string
    - `currency` string
    - `items` CartLineItemOutputDto[]
      - `type` 'UNKNOWN' | 'PHYSICAL_PRODUCT' | 'MEMBERSHIP' | 'SHIPPING' | 'DIGITAL_PRODUCT' | 'BOOKING' | 'EXTERNAL_FEE'
      - `id` string
      - `added` string, date-time
      - `product_id` string, nullable
      - `variation_id` string, nullable
      - `external_product_id` string, nullable
      - `external_variation_id` string, nullable
      - `name` string
      - `image` string, nullable
      - `options` CartItemOptionValue[]
        - `name` string
        - `value` string
      - `product_customizations` union[]
        - union
          - ExternalLineItemProductCustomizationBaseResponseDto
            - `type` string, required
            - `id` string
            - `name` string
            - `label` string, nullable
            - `price_modifier` number, double, nullable
          - ExternalLineItemTextProductCustomizationResponseDto
            - `type` string, required
            - `id` string
            - `name` string
            - `label` string, nullable
            - `price_modifier` number, double, nullable
          - ExternalLineItemBooleanProductCustomizationResponseDto
            - `type` string, required
            - `id` string
            - `name` string
            - `label` string, nullable
            - `price_modifier` number, double, nullable
          - ExternalLineItemOptionsProductCustomizationResponseDto
            - `type` string, required
            - `id` string
            - `name` string
            - `label` string, nullable
            - `price_modifier` number, double, nullable
          - ExternalLineItemFileProductCustomizationResponseDto
            - `type` string, required
            - `id` string
            - `name` string
            - `label` string, nullable
            - `price_modifier` number, double, nullable
      - `quantity` integer
      - `shippable` boolean
      - `plan` PaymentPlan
        - `id` string
        - `name` MultilingualString
        - `frequency` 'WEEKLY' | 'MONTHLY' | 'YEARLY'
        - `interval` integer
        - `count` integer, nullable
        - `tag_line` MultilingualString
      - `unit_price` number, double
      - `unit_weight` number, double, nullable
      - `unit_dimensions` CartLineItemDimensionsOutputDto
        - `height` integer, nullable
        - `width` integer, nullable
        - `length` integer, nullable
      - `discounts` CartItemDiscount[]
        - `id` string
        - `name` string
        - `savings` number, double
        - `type` 'DISCOUNT_CODE'
      - `tax_code` string, nullable
      - `taxes` CartItemTax[]
        - `name` string
        - `rate` number, double
        - `amount` number, double
      - `total` number, double
      - `combined_weight` number, double, nullable
      - `metadata` string
      - `sku` string, nullable
    - `billing_address` AddressOutputDto
      - `name` string, nullable
      - `first_name` string, nullable: First Name attached to the address.
      - `last_name` string, nullable: Last Name attached to the address.
      - `full_name` string, nullable: Full Name attached to the address.
      - `address_1` string, nullable: The first line of the address.
      - `address_2` string, nullable: The second line of the address.
      - `street_number` string, nullable: The street number Note: this may be part of the address1 or address_2 values, but is available here as a separate value._
      - `street_name` string, nullable: The street name Note: this may be part of the address1 or address_2 values, but is available here as a separate value._
      - `city` string, nullable: Name of city attached to the address.
      - `sub_locality` string, nullable: Sub-locality attached to the address (ex: county or district name).
      - `region` string, nullable: Region attached to the address (ex. the state or province name).
      - `country` string, nullable: Country attached to the address.
      - `postal_code` string, nullable: Postal code attached to the address.
      - `phone` string, nullable: Phone number of contact located at this address.
    - `shipping_address` AddressOutputDto
      - `name` string, nullable
      - `first_name` string, nullable: First Name attached to the address.
      - `last_name` string, nullable: Last Name attached to the address.
      - `full_name` string, nullable: Full Name attached to the address.
      - `address_1` string, nullable: The first line of the address.
      - `address_2` string, nullable: The second line of the address.
      - `street_number` string, nullable: The street number Note: this may be part of the address1 or address_2 values, but is available here as a separate value._
      - `street_name` string, nullable: The street name Note: this may be part of the address1 or address_2 values, but is available here as a separate value._
      - `city` string, nullable: Name of city attached to the address.
      - `sub_locality` string, nullable: Sub-locality attached to the address (ex: county or district name).
      - `region` string, nullable: Region attached to the address (ex. the state or province name).
      - `country` string, nullable: Country attached to the address.
      - `postal_code` string, nullable: Postal code attached to the address.
      - `phone` string, nullable: Phone number of contact located at this address.
    - `shipping_method` CartShippingMethodOutputDto
      - `name` string
      - `cost` number, double
    - `shipping_instructions` string, nullable
    - `discounts` CartDiscountOutputDto[]
      - `id` string
      - `savings` number, double
      - `name` string
      - `type` 'DISCOUNT_CODE'
    - `tax_provider` 'BUILT_IN' | 'AVALARA' | 'UNKNOWN'
    - `taxes` CartTaxOutputDto[]
      - `name` string
      - `amount` number, double
      - `rate` number, double
    - `subtotal` number, double
    - `total` number, double
    - `created` string, date-time
    - `updated` string, date-time
    - `user_agent` string, nullable
    - `ip_address` string, nullable
    - `customer_accepts_email_marketing` boolean, nullable
    - `customer_accepts_sms_marketing` boolean, nullable
    - `customer_accepts_marketing` boolean
    - `custom_fields` ExternalCartCustomFieldResponseDto[]
      - `id` string
      - `label` string
      - `type` 'TEXT' | 'TEXTAREA' | 'SELECT' | 'RADIO_LIST' | 'CHECKBOX' | 'DATE'
      - `zone` 'CONTACT_INFO' | 'SHIPPING_ADDRESS' | 'SHIPPING_METHODS' | 'BILLING_ADDRESS' | 'PAYMENT_METHODS'
      - `value` string, nullable
      - `includes_time` boolean, nullable
      - `date_range_policy` 'ANY' | 'PAST_ONLY' | 'FUTURE_ONLY'
    - `metadata` string
    - `fees` ExternalPublicCartFeeOutputDto[]
      - `id` string
      - `external_id` string, nullable
      - `name` string
      - `amount` number, double
      - `description` string, nullable
      - `tax_code` string, nullable
      - `tax_group` string, nullable
      - `taxes` ExternalPublicCartFeeTaxOutputDto[]
        - `name` string
        - `amount` number, double
        - `rate` number, double
      - `metadata` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Content
- `429`: Too many requests. The rate limit was exceeded.

---

[API](https://skmtc.dev/duda/apis/duda-partner-api.md) - [All operations](https://skmtc.dev/duda/apis/duda-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/duda/apis/duda-partner-api/revisions/52be4d41cb12?raw)