# Carts Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object. ## Documentation Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object. - Catalog: `Magento` - Schema: `Sales` - Primary Keys: `id` This is a read-only table function. The Magento API may not support changing the data or the Invantive UniversalSQL driver for Magento does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Magento API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `Carts`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `searchCriteria[currentPage]` | `` | ☐ | | Current page. | | `searchCriteria[filterGroups][0][filters][0][conditionType]` | `` | ☐ | | Condition type | | `searchCriteria[filterGroups][0][filters][0][field]` | `` | ☐ | | Field | | `searchCriteria[filterGroups][0][filters][0][value]` | `` | ☐ | | Value | | `searchCriteria[pageSize]` | `` | ☐ | | Page size. | | `searchCriteria[sortOrders][0][direction]` | `` | ☐ | | Sorting direction. | | `searchCriteria[sortOrders][0][field]` | `` | ☐ | | Sorting field. | ## Columns of Table Function The columns of the table function `Carts` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `billing_address_city` | `varchar2` | | ☐ | City name | | `billing_address_company` | `varchar2` | | ☐ | Company | | `billing_address_country_id` | `varchar2` | | ☐ | Country id | | `billing_address_customer_address_id` | `int64` | | ☐ | Customer address id | | `billing_address_customer_id` | `int64` | | ☐ | Customer id | | `billing_address_email` | `varchar2` | | ☐ | Billing/shipping email | | `billing_address_extension_attributes_pickup_location_code` | `varchar2` | | ☐ | | | `billing_address_fax` | `varchar2` | | ☐ | Fax number | | `billing_address_firstname` | `varchar2` | | ☐ | First name | | `billing_address_id` | `int64` | | ☐ | Id | | `billing_address_lastname` | `varchar2` | | ☐ | Last name | | `billing_address_middlename` | `varchar2` | | ☐ | Middle name | | `billing_address_postcode` | `varchar2` | | ☐ | Postcode | | `billing_address_prefix` | `varchar2` | | ☐ | Prefix | | `billing_address_region_code` | `varchar2` | | ☐ | Region code | | `billing_address_region_id` | `int64` | | ☐ | Region id | | `billing_address_region` | `varchar2` | | ☐ | Region name | | `billing_address_same_as_billing` | `int64` | | ☐ | Same as billing flag | | `billing_address_save_in_address_book` | `int64` | | ☐ | Save in address book flag | | `billing_address_suffix` | `varchar2` | | ☐ | Suffix | | `billing_address_telephone` | `varchar2` | | ☐ | Telephone number | | `billing_address_vat_id` | `varchar2` | | ☐ | Vat id | | `converted_at` | `varchar2` | | ☐ | Cart conversion date and time. Otherwise, null. | | `created_at` | `varchar2` | | ☐ | Cart creation date and time. Otherwise, null. | | `currency_base_currency_code` | `varchar2` | | ☐ | Base currency code | | `currency_base_to_global_rate` | `decimal` | | ☐ | Base currency to global currency rate | | `currency_base_to_quote_rate` | `decimal` | | ☐ | Base currency to quote currency rate | | `currency_extension_attributes` | `varchar2` | | ☐ | The JSON text of the nested object. | | `currency_global_currency_code` | `varchar2` | | ☐ | Global currency code | | `currency_quote_currency_code` | `varchar2` | | ☐ | Quote currency code | | `currency_store_currency_code` | `varchar2` | | ☐ | Store currency code | | `currency_store_to_base_rate` | `decimal` | | ☐ | Store currency to base currency rate | | `currency_store_to_quote_rate` | `decimal` | | ☐ | Store currency to quote currency rate | | `customer_confirmation` | `varchar2` | | ☐ | Confirmation | | `customer_created_at` | `varchar2` | | ☐ | Created at time | | `customer_created_in` | `varchar2` | | ☐ | Created in area | | `customer_default_billing` | `varchar2` | | ☐ | Default billing address id | | `customer_default_shipping` | `varchar2` | | ☐ | Default shipping address id | | `customer_disable_auto_group_change` | `int64` | | ☐ | Disable auto group change flag. | | `customer_dob` | `varchar2` | | ☐ | In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers (e.g., full name) before collecting or processing such data. | | `customer_email` | `varchar2` | | ☐ | Email address | | `customer_extension_attributes_assistance_allowed` | `int64` | | ☐ | | | `customer_extension_attributes_is_subscribed` | `char` | | ☐ | | | `customer_firstname` | `varchar2` | | ☐ | First name | | `customer_gender` | `int64` | | ☐ | Gender | | `customer_group_id` | `int64` | | ☐ | Group id | | `customer_id` | `int64` | | ☐ | Customer id | | `customer_is_guest` | `char` | | ☐ | For guest customers, false for logged in customers | | `customer_lastname` | `varchar2` | | ☐ | Last name | | `customer_middlename` | `varchar2` | | ☐ | Middle name | | `customer_note_notify` | `char` | | ☐ | Customer notification flag | | `customer_note` | `varchar2` | | ☐ | Notice text | | `customer_prefix` | `varchar2` | | ☐ | Prefix | | `customer_store_id` | `int64` | | ☐ | Store id | | `customer_suffix` | `varchar2` | | ☐ | Suffix | | `customer_tax_class_id` | `int64` | | ☐ | Customer tax class ID. | | `customer_taxvat` | `varchar2` | | ☐ | Tax Vat | | `customer_updated_at` | `varchar2` | | ☐ | Updated at time | | `customer_website_id` | `int64` | | ☐ | Website id | | `id` | `int64` | | ☐ | Cart/quote ID. | | `is_active` | `char` | | ☐ | Active status flag value. Otherwise, null. | | `is_virtual` | `char` | | ☐ | Virtual flag value. Otherwise, null. | | `items_count` | `int64` | | ☐ | Number of different items or products in the cart. Otherwise, null. | | `items_qty` | `decimal` | | ☐ | Total quantity of all cart items. Otherwise, null. | | `orig_order_id` | `int64` | | ☐ | Original order ID. Otherwise, null. | | `reserved_order_id` | `varchar2` | | ☐ | Reserved order ID. Otherwise, null. | | `store_id` | `int64` | | ☐ | Store identifier | | `updated_at` | `varchar2` | | ☐ | Cart last update date and time. Otherwise, null. |