Enables administrative users to list carts that match specified search criteria

GET /V1/carts/search

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.

Query parameters

searchCriteria[filterGroups][0][filters][0][field] string

Field
searchCriteria[filterGroups][0][filters][0][value] string

Value
searchCriteria[filterGroups][0][filters][0][conditionType] string

Condition type
searchCriteria[sortOrders][0][field] string

Sorting field.
searchCriteria[sortOrders][0][direction] string

Sorting direction.
searchCriteria[pageSize] integer

Page size.
searchCriteria[currentPage] integer

Current page.

Responses

200

200 Success.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Interface CartInterface
  
  Hide items attributes Show items attributes object
  
  id integer Required
  
  Cart/quote ID.
  
  created_at string
  
  Cart creation date and time. Otherwise, null.
  
  updated_at string
  
  Cart last update date and time. Otherwise, null.
  
  converted_at string
  
  Cart conversion date and time. Otherwise, null.
  
  is_active boolean
  
  Active status flag value. Otherwise, null.
  
  is_virtual boolean
  
  Virtual flag value. Otherwise, null.
  
  items array[object]
  
  Interface CartItemInterface
  
  Hide items attributes Show items attributes object
  
  item_id integer
  
  Item ID. Otherwise, null.
  
  sku string
  
  Product SKU. Otherwise, null.
  
  qty number Required
  
  Product quantity.
  
  name string
  
  Product name. Otherwise, null.
  
  price number
  
  Product price. Otherwise, null.
  
  product_type string
  
  Product type. Otherwise, null.
  
  quote_id string Required
  
  Quote id.
  
  product_option object
  
  Product option interface
  
  Hide product_option attribute Show product_option attribute object
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  custom_options array[object]
  
  Interface CustomOptionInterface
  
  Hide custom_options attributes Show custom_options attributes object
  
  option_id string Required
  
  Option id
  
  option_value string Required
  
  Option value
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  file_info object
  
  Image Content data interface
  
  Hide file_info attributes Show file_info attributes object
  
  base64_encoded_data string Required
  
  Media data (base64 encoded content)
  
  type string Required
  
  MIME type
  
  name string Required
  
  Image name
  
  bundle_options array[object]
  
  Interface BundleOptionInterface
  
  Hide bundle_options attributes Show bundle_options attributes object
  
  option_id integer Required
  
  Bundle option id.
  
  option_qty integer Required
  
  Bundle option quantity.
  
  option_selections array[integer] Required
  
  Bundle option selection ids.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
  
  downloadable_option object
  
  Downloadable Option
  
  Hide downloadable_option attribute Show downloadable_option attribute object
  
  downloadable_links array[integer] Required
  
  The list of downloadable links
  
  giftcard_item_option object
  
  Interface GiftCardOptionInterface
  
  Hide giftcard_item_option attributes Show giftcard_item_option attributes object
  
  giftcard_amount string Required
  
  Gift card amount.
  
  custom_giftcard_amount number
  
  Gift card open amount value.
  
  giftcard_sender_name string Required
  
  Gift card sender name.
  
  giftcard_recipient_name string Required
  
  Gift card recipient name.
  
  giftcard_sender_email string Required
  
  Gift card sender email.
  
  giftcard_recipient_email string Required
  
  Gift card recipient email.
  
  giftcard_message string
  
  Giftcard message.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  giftcard_created_codes array[string]
  
  configurable_item_options array[object]
  
  Interface ConfigurableItemOptionValueInterface
  
  Hide configurable_item_options attributes Show configurable_item_options attributes object
  
  option_id string Required
  
  Option SKU
  
  option_value string
  
  Item id
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
  
  grouped_options array[object]
  
  Represents product item id with qty of a grouped product.
  
  Hide grouped_options attributes Show grouped_options attributes object
  
  id integer
  
  Associated product id
  
  qty integer
  
  Associated product qty
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  discounts array[object]
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  negotiable_quote_item object
  
  Interface CompanyQuoteConfigInterface
  
  Hide negotiable_quote_item attributes Show negotiable_quote_item attributes object
  
  item_id integer Required
  
  Quote item id
  
  original_price number Required
  
  Quote item original price
  
  original_tax_amount number Required
  
  Quote item original tax amount
  
  original_discount_amount number Required
  
  Quote item original discount amount
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  negotiated_price_type integer
  
  negotiated_price_value number
  
  last_item_notes array[object]
  
  Interface ItemNoteInterface
  
  Hide last_item_notes attributes Show last_item_notes attributes object
  
  note_id integer
  
  Note ID.
  
  negotiable_quote_item_id integer Required
  
  Negotiable quote item Id
  
  creator_type integer Required
  
  The note creator type.
  
  creator_id integer Required
  
  Note creator ID.
  
  note string Required
  
  Note.
  
  created_at string
  
  Comment created at.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface
  
  size string
  
  color string
  
  merchant_product_reference string
  
  category_code string
  
  image string
  
  mpn string
  
  msrp number
  
  manufacturer_code string
  
  manufacturer_name string
  
  merchant_code string
  
  merchant_name string
  
  merchant_city string
  
  parent_sku string
  
  is_sale boolean
  
  return_item_fee number
  
  base_return_item_fee number
  
  is_outlet boolean
  
  items_count integer
  
  Number of different items or products in the cart. Otherwise, null.
  
  items_qty number
  
  Total quantity of all cart items. Otherwise, null.
  
  customer object Required
  
  Customer entity interface for API handling.
  
  Hide customer attributes Show customer attributes object
  
  id integer
  
  Customer id
  
  group_id integer
  
  Group id
  
  default_billing string
  
  Default billing address id
  
  default_shipping string
  
  Default shipping address id
  
  confirmation string
  
  Confirmation
  
  created_at string
  
  Created at time
  
  updated_at string
  
  Updated at time
  
  created_in string
  
  Created in area
  
  dob string
  
  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.
  
  email string Required
  
  Email address
  
  firstname string Required
  
  First name
  
  lastname string Required
  
  Last name
  
  middlename string
  
  Middle name
  
  prefix string
  
  Prefix
  
  suffix string
  
  Suffix
  
  gender integer
  
  Gender
  
  store_id integer
  
  Store id
  
  taxvat string
  
  Tax Vat
  
  website_id integer
  
  Website id
  
  addresses array[object]
  
  Customer address interface.
  
  Hide addresses attributes Show addresses attributes object
  
  id integer
  
  ID
  
  customer_id integer
  
  Customer ID
  
  region object
  
  Customer address region interface.
  
  Hide region attributes Show region attributes object
  
  region_code string Required
  
  Region code
  
  region string Required
  
  Region
  
  region_id integer Required
  
  Region id
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
  
  region_id integer
  
  Region ID
  
  country_id string
  
  Country code in ISO_3166-2 format
  
  street array[string]
  
  Street
  
  company string
  
  Company
  
  telephone string
  
  Telephone number
  
  fax string
  
  Fax number
  
  postcode string
  
  Postcode
  
  city string
  
  City name
  
  firstname string
  
  First name
  
  lastname string
  
  Last name
  
  middlename string
  
  Middle name
  
  prefix string
  
  Prefix
  
  suffix string
  
  Suffix
  
  vat_id string
  
  Vat id
  
  default_shipping boolean
  
  If this address is default shipping address.
  
  default_billing boolean
  
  If this address is default billing address
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
  
  custom_attributes array[object]
  
  Interface for custom attribute value.
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
  
  disable_auto_group_change integer
  
  Disable auto group change flag.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  company_attributes object
  
  Extended customer custom attributes interface.
  
  Hide company_attributes attributes Show company_attributes attributes object
  
  customer_id integer
  
  Customer ID.
  
  company_id integer
  
  Company ID.
  
  job_title string
  
  Get job title.
  
  status integer
  
  Customer status.
  
  telephone string
  
  Get telephone.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface
  
  is_subscribed boolean
  
  assistance_allowed integer
  
  custom_attributes array[object]
  
  Interface for custom attribute value.
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
  
  billing_address object
  
  Interface AddressInterface
  
  Hide billing_address attributes Show billing_address attributes object
  
  id integer
  
  Id
  
  region string Required
  
  Region name
  
  region_id integer Required
  
  Region id
  
  region_code string Required
  
  Region code
  
  country_id string Required
  
  Country id
  
  street array[string] Required
  
  Street
  
  company string
  
  Company
  
  telephone string Required
  
  Telephone number
  
  fax string
  
  Fax number
  
  postcode string Required
  
  Postcode
  
  city string Required
  
  City name
  
  firstname string Required
  
  First name
  
  lastname string Required
  
  Last name
  
  middlename string
  
  Middle name
  
  prefix string
  
  Prefix
  
  suffix string
  
  Suffix
  
  vat_id string
  
  Vat id
  
  customer_id integer
  
  Customer id
  
  email string Required
  
  Billing/shipping email
  
  same_as_billing integer
  
  Same as billing flag
  
  customer_address_id integer
  
  Customer address id
  
  save_in_address_book integer
  
  Save in address book flag
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  discounts array[object]
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  gift_registry_id integer
  
  pickup_location_code string
  
  custom_attributes array[object]
  
  Interface for custom attribute value.
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
  
  reserved_order_id string
  
  Reserved order ID. Otherwise, null.
  
  orig_order_id integer
  
  Original order ID. Otherwise, null.
  
  currency object
  
  Interface CurrencyInterface
  
  Hide currency attributes Show currency attributes object
  
  global_currency_code string
  
  Global currency code
  
  base_currency_code string
  
  Base currency code
  
  store_currency_code string
  
  Store currency code
  
  quote_currency_code string
  
  Quote currency code
  
  store_to_base_rate number
  
  Store currency to base currency rate
  
  store_to_quote_rate number
  
  Store currency to quote currency rate
  
  base_to_global_rate number
  
  Base currency to global currency rate
  
  base_to_quote_rate number
  
  Base currency to quote currency rate
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
  
  customer_is_guest boolean
  
  For guest customers, false for logged in customers
  
  customer_note string
  
  Notice text
  
  customer_note_notify boolean
  
  Customer notification flag
  
  customer_tax_class_id integer
  
  Customer tax class ID.
  
  store_id integer Required
  
  Store identifier
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  shipping_assignments array[object]
  
  Interface ShippingAssignmentInterface
  
  Hide shipping_assignments attributes Show shipping_assignments attributes object
  
  shipping object Required
  
  Interface ShippingInterface
  
  Hide shipping attributes Show shipping attributes object
  
  address object Required
  
  Interface AddressInterface
  
  Hide address attributes Show address attributes object
  
  id integer
  
  Id
  
  region string Required
  
  Region name
  
  region_id integer Required
  
  Region id
  
  region_code string Required
  
  Region code
  
  country_id string Required
  
  Country id
  
  street array[string] Required
  
  Street
  
  company string
  
  Company
  
  telephone string Required
  
  Telephone number
  
  fax string
  
  Fax number
  
  postcode string Required
  
  Postcode
  
  city string Required
  
  City name
  
  firstname string Required
  
  First name
  
  lastname string Required
  
  Last name
  
  middlename string
  
  Middle name
  
  prefix string
  
  Prefix
  
  suffix string
  
  Suffix
  
  vat_id string
  
  Vat id
  
  customer_id integer
  
  Customer id
  
  email string Required
  
  Billing/shipping email
  
  same_as_billing integer
  
  Same as billing flag
  
  customer_address_id integer
  
  Customer address id
  
  save_in_address_book integer
  
  Save in address book flag
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  discounts array[object]
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  gift_registry_id integer
  
  pickup_location_code string
  
  custom_attributes array[object]
  
  Interface for custom attribute value.
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
  
  method string Required
  
  Shipping method
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
  
  items array[object] Required
  
  Interface CartItemInterface
  
  Hide items attributes Show items attributes object
  
  item_id integer
  
  Item ID. Otherwise, null.
  
  sku string
  
  Product SKU. Otherwise, null.
  
  qty number Required
  
  Product quantity.
  
  name string
  
  Product name. Otherwise, null.
  
  price number
  
  Product price. Otherwise, null.
  
  product_type string
  
  Product type. Otherwise, null.
  
  quote_id string Required
  
  Quote id.
  
  product_option object
  
  Product option interface
  
  Hide product_option attribute Show product_option attribute object
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  custom_options array[object]
  
  Interface CustomOptionInterface
  
  Hide custom_options attributes Show custom_options attributes object
  
  option_id string Required
  
  Option id
  
  option_value string Required
  
  Option value
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  file_info object
  
  Image Content data interface
  
  Hide file_info attributes Show file_info attributes object
  
  base64_encoded_data string Required
  
  Media data (base64 encoded content)
  
  type string Required
  
  MIME type
  
  name string Required
  
  Image name
  
  bundle_options array[object]
  
  Interface BundleOptionInterface
  
  Hide bundle_options attributes Show bundle_options attributes object
  
  option_id integer Required
  
  Bundle option id.
  
  option_qty integer Required
  
  Bundle option quantity.
  
  option_selections array[integer] Required
  
  Bundle option selection ids.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
  
  downloadable_option object
  
  Downloadable Option
  
  Hide downloadable_option attribute Show downloadable_option attribute object
  
  downloadable_links array[integer] Required
  
  The list of downloadable links
  
  giftcard_item_option object
  
  Interface GiftCardOptionInterface
  
  Hide giftcard_item_option attributes Show giftcard_item_option attributes object
  
  giftcard_amount string Required
  
  Gift card amount.
  
  custom_giftcard_amount number
  
  Gift card open amount value.
  
  giftcard_sender_name string Required
  
  Gift card sender name.
  
  giftcard_recipient_name string Required
  
  Gift card recipient name.
  
  giftcard_sender_email string Required
  
  Gift card sender email.
  
  giftcard_recipient_email string Required
  
  Gift card recipient email.
  
  giftcard_message string
  
  Giftcard message.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  giftcard_created_codes array[string]
  
  configurable_item_options array[object]
  
  Interface ConfigurableItemOptionValueInterface
  
  Hide configurable_item_options attributes Show configurable_item_options attributes object
  
  option_id string Required
  
  Option SKU
  
  option_value string
  
  Item id
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
  
  grouped_options array[object]
  
  Represents product item id with qty of a grouped product.
  
  Hide grouped_options attributes Show grouped_options attributes object
  
  id integer
  
  Associated product id
  
  qty integer
  
  Associated product qty
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  discounts array[object]
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  negotiable_quote_item object
  
  Interface CompanyQuoteConfigInterface
  
  Hide negotiable_quote_item attributes Show negotiable_quote_item attributes object
  
  item_id integer Required
  
  Quote item id
  
  original_price number Required
  
  Quote item original price
  
  original_tax_amount number Required
  
  Quote item original tax amount
  
  original_discount_amount number Required
  
  Quote item original discount amount
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  negotiated_price_type integer
  
  negotiated_price_value number
  
  last_item_notes array[object]
  
  Interface ItemNoteInterface
  
  Hide last_item_notes attributes Show last_item_notes attributes object
  
  note_id integer
  
  Note ID.
  
  negotiable_quote_item_id integer Required
  
  Negotiable quote item Id
  
  creator_type integer Required
  
  The note creator type.
  
  creator_id integer Required
  
  Note creator ID.
  
  note string Required
  
  Note.
  
  created_at string
  
  Comment created at.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface
  
  size string
  
  color string
  
  merchant_product_reference string
  
  category_code string
  
  image string
  
  mpn string
  
  msrp number
  
  manufacturer_code string
  
  manufacturer_name string
  
  merchant_code string
  
  merchant_name string
  
  merchant_city string
  
  parent_sku string
  
  is_sale boolean
  
  return_item_fee number
  
  base_return_item_fee number
  
  is_outlet boolean
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
  
  negotiable_quote object
  
  Interface NegotiableQuoteInterface
  
  Hide negotiable_quote attributes Show negotiable_quote attributes object
  
  quote_id integer Required
  
  Negotiable quote ID.
  
  is_regular_quote boolean Required
  
  Is regular quote.
  
  status string Required
  
  Negotiable quote status.
  
  negotiated_price_type integer Required
  
  Negotiated price type.
  
  negotiated_price_value number Required
  
  Negotiated price value.
  
  shipping_price number Required
  
  Proposed shipping price.
  
  quote_name string Required
  
  Negotiable quote name.
  
  expiration_period string Required
  
  Expiration period.
  
  email_notification_status integer Required
  
  Email notification status.
  
  has_unconfirmed_changes boolean Required
  
  Has unconfirmed changes.
  
  is_shipping_tax_changed boolean Required
  
  Shipping tax changes.
  
  is_customer_price_changed boolean Required
  
  Customer price changes.
  
  notifications integer Required
  
  Quote notifications.
  
  applied_rule_ids string Required
  
  Quote rules.
  
  is_address_draft boolean Required
  
  Is address draft.
  
  deleted_sku string Required
  
  Deleted products sku.
  
  creator_id integer Required
  
  Quote creator id.
  
  creator_type integer Required
  
  Quote creator type.
  
  original_total_price number
  
  Quote original total price.
  
  base_original_total_price number
  
  Quote original total price in base currency.
  
  negotiated_total_price number
  
  Quote negotiated total price.
  
  base_negotiated_total_price number
  
  Quote negotiated total price in base currency.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface
  
  coupon_codes array[string]
  
  origin string
  
  company_id integer
- search_criteria object Required
  
  Search criteria interface.
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  filter_groups array[object] Required
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  filters array[object]
  
  Filter which can be used by any methods from service layer.
  
  Hide filters attributes Show filters attributes object
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Data object for sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/carts/search

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/carts/search

Response examples (200)

{
  "items": [
    {
      "id": 42,
      "created_at": "string",
      "updated_at": "string",
      "converted_at": "string",
      "is_active": true,
      "is_virtual": true,
      "items": [
        {
          "item_id": 42,
          "sku": "string",
          "qty": 42.0,
          "name": "string",
          "price": 42.0,
          "product_type": "string",
          "quote_id": "string",
          "product_option": {
            "extension_attributes": {
              "custom_options": [
                {
                  "option_id": "string",
                  "option_value": "string",
                  "extension_attributes": {
                    "file_info": {
                      "base64_encoded_data": "string",
                      "type": "string",
                      "name": "string"
                    }
                  }
                }
              ],
              "bundle_options": [
                {
                  "option_id": 42,
                  "option_qty": 42,
                  "option_selections": [
                    42
                  ],
                  "extension_attributes": {}
                }
              ],
              "downloadable_option": {
                "downloadable_links": [
                  42
                ]
              },
              "giftcard_item_option": {
                "giftcard_amount": "string",
                "custom_giftcard_amount": 42.0,
                "giftcard_sender_name": "string",
                "giftcard_recipient_name": "string",
                "giftcard_sender_email": "string",
                "giftcard_recipient_email": "string",
                "giftcard_message": "string",
                "extension_attributes": {
                  "giftcard_created_codes": [
                    "string"
                  ]
                }
              },
              "configurable_item_options": [
                {
                  "option_id": "string",
                  "option_value": "string",
                  "extension_attributes": {}
                }
              ],
              "grouped_options": [
                {
                  "id": 42,
                  "qty": 42,
                  "extension_attributes": {}
                }
              ]
            }
          },
          "extension_attributes": {
            "discounts": [
              {
                "discount_data": {
                  "amount": 42.0,
                  "base_amount": 42.0,
                  "original_amount": 42.0,
                  "base_original_amount": 42.0
                },
                "rule_label": "string",
                "rule_i_d": 42
              }
            ],
            "negotiable_quote_item": {
              "item_id": 42,
              "original_price": 42.0,
              "original_tax_amount": 42.0,
              "original_discount_amount": 42.0,
              "extension_attributes": {
                "negotiated_price_type": 42,
                "negotiated_price_value": 42.0,
                "last_item_notes": [
                  {
                    "note_id": 42,
                    "negotiable_quote_item_id": 42,
                    "creator_type": 42,
                    "creator_id": 42,
                    "note": "string",
                    "created_at": "string",
                    "extension_attributes": {}
                  }
                ]
              }
            },
            "size": "string",
            "color": "string",
            "merchant_product_reference": "string",
            "category_code": "string",
            "image": "string",
            "mpn": "string",
            "msrp": 42.0,
            "manufacturer_code": "string",
            "manufacturer_name": "string",
            "merchant_code": "string",
            "merchant_name": "string",
            "merchant_city": "string",
            "parent_sku": "string",
            "is_sale": true,
            "return_item_fee": 42.0,
            "base_return_item_fee": 42.0,
            "is_outlet": true
          }
        }
      ],
      "items_count": 42,
      "items_qty": 42.0,
      "customer": {
        "id": 42,
        "group_id": 42,
        "default_billing": "string",
        "default_shipping": "string",
        "confirmation": "string",
        "created_at": "string",
        "updated_at": "string",
        "created_in": "string",
        "dob": "string",
        "email": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "prefix": "string",
        "suffix": "string",
        "gender": 42,
        "store_id": 42,
        "taxvat": "string",
        "website_id": 42,
        "addresses": [
          {
            "id": 42,
            "customer_id": 42,
            "region": {
              "region_code": "string",
              "region": "string",
              "region_id": 42,
              "extension_attributes": {}
            },
            "region_id": 42,
            "country_id": "string",
            "street": [
              "string"
            ],
            "company": "string",
            "telephone": "string",
            "fax": "string",
            "postcode": "string",
            "city": "string",
            "firstname": "string",
            "lastname": "string",
            "middlename": "string",
            "prefix": "string",
            "suffix": "string",
            "vat_id": "string",
            "default_shipping": true,
            "default_billing": true,
            "extension_attributes": {},
            "custom_attributes": [
              {
                "attribute_code": "string",
                "value": "string"
              }
            ]
          }
        ],
        "disable_auto_group_change": 42,
        "extension_attributes": {
          "company_attributes": {
            "customer_id": 42,
            "company_id": 42,
            "job_title": "string",
            "status": 42,
            "telephone": "string",
            "extension_attributes": {}
          },
          "is_subscribed": true,
          "assistance_allowed": 42
        },
        "custom_attributes": [
          {
            "attribute_code": "string",
            "value": "string"
          }
        ]
      },
      "billing_address": {
        "id": 42,
        "region": "string",
        "region_id": 42,
        "region_code": "string",
        "country_id": "string",
        "street": [
          "string"
        ],
        "company": "string",
        "telephone": "string",
        "fax": "string",
        "postcode": "string",
        "city": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "prefix": "string",
        "suffix": "string",
        "vat_id": "string",
        "customer_id": 42,
        "email": "string",
        "same_as_billing": 42,
        "customer_address_id": 42,
        "save_in_address_book": 42,
        "extension_attributes": {
          "discounts": [
            {
              "discount_data": {
                "amount": 42.0,
                "base_amount": 42.0,
                "original_amount": 42.0,
                "base_original_amount": 42.0
              },
              "rule_label": "string",
              "rule_i_d": 42
            }
          ],
          "gift_registry_id": 42,
          "pickup_location_code": "string"
        },
        "custom_attributes": [
          {
            "attribute_code": "string",
            "value": "string"
          }
        ]
      },
      "reserved_order_id": "string",
      "orig_order_id": 42,
      "currency": {
        "global_currency_code": "string",
        "base_currency_code": "string",
        "store_currency_code": "string",
        "quote_currency_code": "string",
        "store_to_base_rate": 42.0,
        "store_to_quote_rate": 42.0,
        "base_to_global_rate": 42.0,
        "base_to_quote_rate": 42.0,
        "extension_attributes": {}
      },
      "customer_is_guest": true,
      "customer_note": "string",
      "customer_note_notify": true,
      "customer_tax_class_id": 42,
      "store_id": 42,
      "extension_attributes": {
        "shipping_assignments": [
          {
            "shipping": {
              "address": {
                "id": 42,
                "region": "string",
                "region_id": 42,
                "region_code": "string",
                "country_id": "string",
                "street": [
                  "string"
                ],
                "company": "string",
                "telephone": "string",
                "fax": "string",
                "postcode": "string",
                "city": "string",
                "firstname": "string",
                "lastname": "string",
                "middlename": "string",
                "prefix": "string",
                "suffix": "string",
                "vat_id": "string",
                "customer_id": 42,
                "email": "string",
                "same_as_billing": 42,
                "customer_address_id": 42,
                "save_in_address_book": 42,
                "extension_attributes": {
                  "discounts": [
                    {
                      "discount_data": {
                        "amount": 42.0,
                        "base_amount": 42.0,
                        "original_amount": 42.0,
                        "base_original_amount": 42.0
                      },
                      "rule_label": "string",
                      "rule_i_d": 42
                    }
                  ],
                  "gift_registry_id": 42,
                  "pickup_location_code": "string"
                },
                "custom_attributes": [
                  {
                    "attribute_code": "string",
                    "value": "string"
                  }
                ]
              },
              "method": "string",
              "extension_attributes": {}
            },
            "items": [
              {
                "item_id": 42,
                "sku": "string",
                "qty": 42.0,
                "name": "string",
                "price": 42.0,
                "product_type": "string",
                "quote_id": "string",
                "product_option": {
                  "extension_attributes": {
                    "custom_options": [
                      {
                        "option_id": "string",
                        "option_value": "string",
                        "extension_attributes": {
                          "file_info": {
                            "base64_encoded_data": "string",
                            "type": "string",
                            "name": "string"
                          }
                        }
                      }
                    ],
                    "bundle_options": [
                      {
                        "option_id": 42,
                        "option_qty": 42,
                        "option_selections": [
                          42
                        ],
                        "extension_attributes": {}
                      }
                    ],
                    "downloadable_option": {
                      "downloadable_links": [
                        42
                      ]
                    },
                    "giftcard_item_option": {
                      "giftcard_amount": "string",
                      "custom_giftcard_amount": 42.0,
                      "giftcard_sender_name": "string",
                      "giftcard_recipient_name": "string",
                      "giftcard_sender_email": "string",
                      "giftcard_recipient_email": "string",
                      "giftcard_message": "string",
                      "extension_attributes": {
                        "giftcard_created_codes": [
                          "string"
                        ]
                      }
                    },
                    "configurable_item_options": [
                      {
                        "option_id": "string",
                        "option_value": "string",
                        "extension_attributes": {}
                      }
                    ],
                    "grouped_options": [
                      {
                        "id": 42,
                        "qty": 42,
                        "extension_attributes": {}
                      }
                    ]
                  }
                },
                "extension_attributes": {
                  "discounts": [
                    {
                      "discount_data": {
                        "amount": 42.0,
                        "base_amount": 42.0,
                        "original_amount": 42.0,
                        "base_original_amount": 42.0
                      },
                      "rule_label": "string",
                      "rule_i_d": 42
                    }
                  ],
                  "negotiable_quote_item": {
                    "item_id": 42,
                    "original_price": 42.0,
                    "original_tax_amount": 42.0,
                    "original_discount_amount": 42.0,
                    "extension_attributes": {
                      "negotiated_price_type": 42,
                      "negotiated_price_value": 42.0,
                      "last_item_notes": [
                        {
                          "note_id": 42,
                          "negotiable_quote_item_id": 42,
                          "creator_type": 42,
                          "creator_id": 42,
                          "note": "string",
                          "created_at": "string",
                          "extension_attributes": {}
                        }
                      ]
                    }
                  },
                  "size": "string",
                  "color": "string",
                  "merchant_product_reference": "string",
                  "category_code": "string",
                  "image": "string",
                  "mpn": "string",
                  "msrp": 42.0,
                  "manufacturer_code": "string",
                  "manufacturer_name": "string",
                  "merchant_code": "string",
                  "merchant_name": "string",
                  "merchant_city": "string",
                  "parent_sku": "string",
                  "is_sale": true,
                  "return_item_fee": 42.0,
                  "base_return_item_fee": 42.0,
                  "is_outlet": true
                }
              }
            ],
            "extension_attributes": {}
          }
        ],
        "negotiable_quote": {
          "quote_id": 42,
          "is_regular_quote": true,
          "status": "string",
          "negotiated_price_type": 42,
          "negotiated_price_value": 42.0,
          "shipping_price": 42.0,
          "quote_name": "string",
          "expiration_period": "string",
          "email_notification_status": 42,
          "has_unconfirmed_changes": true,
          "is_shipping_tax_changed": true,
          "is_customer_price_changed": true,
          "notifications": 42,
          "applied_rule_ids": "string",
          "is_address_draft": true,
          "deleted_sku": "string",
          "creator_id": 42,
          "creator_type": 42,
          "original_total_price": 42.0,
          "base_original_total_price": 42.0,
          "negotiated_total_price": 42.0,
          "base_negotiated_total_price": 42.0,
          "extension_attributes": {}
        },
        "coupon_codes": [
          "string"
        ],
        "origin": "string",
        "company_id": 42
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}