carts/search

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://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Request

query Parameters

searchCriteria[currentPage]	integer Current page.
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[pageSize]	integer Page size.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[sortOrders][0][field]	string Sorting field.

Responses

200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples

200
401
default

{"items": [{"id": 0,
"created_at": "string",
"updated_at": "string",
"converted_at": "string",
"is_active": true,
"is_virtual": true,
"items": [{"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": {"extension_attributes": {"custom_options": [null
],
"bundle_options": [null
],
"downloadable_option": {"downloadable_links": [ ]
},
"giftcard_item_option": {"giftcard_amount": null,
"custom_giftcard_amount": null,
"giftcard_sender_name": null,
"giftcard_recipient_name": null,
"giftcard_sender_email": null,
"giftcard_recipient_email": null,
"giftcard_message": null,
"extension_attributes": null
},
"configurable_item_options": [null
],
"grouped_options": [null
]
}
},
"extension_attributes": {"discounts": [{"discount_data": null,
"rule_label": null,
"rule_id": null
}
],
"negotiable_quote_item": {"item_id": 0,
"original_price": 0,
"original_tax_amount": 0,
"original_discount_amount": 0,
"extension_attributes": { }
}
}
}
],
"items_count": 0,
"items_qty": 0,
"customer": {"id": 0,
"group_id": 0,
"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": 0,
"store_id": 0,
"taxvat": "string",
"website_id": 0,
"addresses": [{"id": 0,
"customer_id": 0,
"region": {"region_code": "string",
"region": "string",
"region_id": 0,
"extension_attributes": { }
},
"region_id": 0,
"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": null,
"value": null
}
]
}
],
"disable_auto_group_change": 0,
"extension_attributes": {"company_attributes": {"customer_id": 0,
"company_id": 0,
"job_title": "string",
"status": 0,
"telephone": "string",
"extension_attributes": { }
},
"assistance_allowed": 0,
"is_subscribed": true
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"billing_address": {"id": 0,
"region": "string",
"region_id": 0,
"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": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"discounts": [{"discount_data": {"amount": null,
"base_amount": null,
"original_amount": null,
"base_original_amount": null
},
"rule_label": "string",
"rule_id": 0
}
],
"gift_registry_id": 0,
"pickup_location_code": "string",
"bolt_id": "string"
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"reserved_order_id": "string",
"orig_order_id": 0,
"currency": {"global_currency_code": "string",
"base_currency_code": "string",
"store_currency_code": "string",
"quote_currency_code": "string",
"store_to_base_rate": 0,
"store_to_quote_rate": 0,
"base_to_global_rate": 0,
"base_to_quote_rate": 0,
"extension_attributes": { }
},
"customer_is_guest": true,
"customer_note": "string",
"customer_note_notify": true,
"customer_tax_class_id": 0,
"store_id": 0,
"extension_attributes": {"shipping_assignments": [{"shipping": {"address": {"id": null,
"region": null,
"region_id": null,
"region_code": null,
"country_id": null,
"street": [ ],
"company": null,
"telephone": null,
"fax": null,
"postcode": null,
"city": null,
"firstname": null,
"lastname": null,
"middlename": null,
"prefix": null,
"suffix": null,
"vat_id": null,
"customer_id": null,
"email": null,
"same_as_billing": null,
"customer_address_id": null,
"save_in_address_book": null,
"extension_attributes": null,
"custom_attributes": [ ]
},
"method": "string",
"extension_attributes": { }
},
"items": [{"item_id": null,
"sku": null,
"qty": null,
"name": null,
"price": null,
"product_type": null,
"quote_id": null,
"product_option": null,
"extension_attributes": null
}
],
"extension_attributes": { }
}
],
"negotiable_quote": {"quote_id": 0,
"is_regular_quote": true,
"status": "string",
"negotiated_price_type": 0,
"negotiated_price_value": 0,
"shipping_price": 0,
"quote_name": "string",
"expiration_period": "string",
"email_notification_status": 0,
"has_unconfirmed_changes": true,
"is_shipping_tax_changed": true,
"is_customer_price_changed": true,
"notifications": 0,
"applied_rule_ids": "string",
"is_address_draft": true,
"deleted_sku": "string",
"creator_id": 0,
"creator_type": 0,
"original_total_price": 0,
"base_original_total_price": 0,
"negotiated_total_price": 0,
"base_negotiated_total_price": 0,
"extension_attributes": { }
}
}
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

➔ Next to carts/{cartId}