carts/search

GET

/V1/carts/search

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.

响应示例

200 - 示例 1

{
    "items": [
        {
            "billing_address": {
                "city": "string",
                "company": "string",
                "country_id": "string",
                "custom_attributes": [
                    {
                        "attribute_code": "string",
                        "value": "string"
                    }
                ],
                "customer_address_id": 0,
                "customer_id": 0,
                "email": "string",
                "extension_attributes": {
                    "checkout_fields": [
                        {
                            "attribute_code": "string",
                            "value": "string"
                        }
                    ],
                    "gift_registry_id": 0
                },
                "fax": "string",
                "firstname": "string",
                "id": 0,
                "lastname": "string",
                "middlename": "string",
                "postcode": "string",
                "prefix": "string",
                "region": "string",
                "region_code": "string",
                "region_id": 0,
                "same_as_billing": 0,
                "save_in_address_book": 0,
                "street": [
                    "string"
                ],
                "suffix": "string",
                "telephone": "string",
                "vat_id": "string"
            },
            "converted_at": "string",
            "created_at": "string",
            "currency": {
                "base_currency_code": "string",
                "base_to_global_rate": 0,
                "base_to_quote_rate": 0,
                "extension_attributes": {},
                "global_currency_code": "string",
                "quote_currency_code": "string",
                "store_currency_code": "string",
                "store_to_base_rate": 0,
                "store_to_quote_rate": 0
            },
            "customer": {
                "addresses": [
                    {
                        "city": "string",
                        "company": "string",
                        "country_id": "string",
                        "custom_attributes": [
                            {
                                "attribute_code": "string",
                                "value": "string"
                            }
                        ],
                        "customer_id": 0,
                        "default_billing": true,
                        "default_shipping": true,
                        "extension_attributes": {},
                        "fax": "string",
                        "firstname": "string",
                        "id": 0,
                        "lastname": "string",
                        "middlename": "string",
                        "postcode": "string",
                        "prefix": "string",
                        "region": {
                            "extension_attributes": {},
                            "region": "string",
                            "region_code": "string",
                            "region_id": 0
                        },
                        "region_id": 0,
                        "street": [
                            "string"
                        ],
                        "suffix": "string",
                        "telephone": "string",
                        "vat_id": "string"
                    }
                ],
                "confirmation": "string",
                "created_at": "string",
                "created_in": "string",
                "custom_attributes": [
                    {
                        "attribute_code": "string",
                        "value": "string"
                    }
                ],
                "default_billing": "string",
                "default_shipping": "string",
                "disable_auto_group_change": 0,
                "dob": "string",
                "email": "string",
                "extension_attributes": {
                    "amazon_id": "string",
                    "company_attributes": {
                        "company_id": 0,
                        "customer_id": 0,
                        "extension_attributes": {},
                        "job_title": "string",
                        "status": 0,
                        "telephone": "string"
                    },
                    "is_subscribed": true,
                    "vertex_customer_code": "string"
                },
                "firstname": "string",
                "gender": 0,
                "group_id": 0,
                "id": 0,
                "lastname": "string",
                "middlename": "string",
                "prefix": "string",
                "store_id": 0,
                "suffix": "string",
                "taxvat": "string",
                "updated_at": "string",
                "website_id": 0
            },
            "customer_is_guest": true,
            "customer_note": "string",
            "customer_note_notify": true,
            "customer_tax_class_id": 0,
            "extension_attributes": {
                "amazon_order_reference_id": "string",
                "negotiable_quote": {
                    "applied_rule_ids": "string",
                    "base_negotiated_total_price": 0,
                    "base_original_total_price": 0,
                    "creator_id": 0,
                    "creator_type": 0,
                    "deleted_sku": "string",
                    "email_notification_status": 0,
                    "expiration_period": "string",
                    "extension_attributes": {},
                    "has_unconfirmed_changes": true,
                    "is_address_draft": true,
                    "is_customer_price_changed": true,
                    "is_regular_quote": true,
                    "is_shipping_tax_changed": true,
                    "negotiated_price_type": 0,
                    "negotiated_price_value": 0,
                    "negotiated_total_price": 0,
                    "notifications": 0,
                    "original_total_price": 0,
                    "quote_id": 0,
                    "quote_name": "string",
                    "shipping_price": 0,
                    "status": "string"
                },
                "shipping_assignments": [
                    {
                        "extension_attributes": {},
                        "items": [
                            {
                                "extension_attributes": {
                                    "negotiable_quote_item": {
                                        "extension_attributes": {},
                                        "item_id": 0,
                                        "original_discount_amount": 0,
                                        "original_price": 0,
                                        "original_tax_amount": 0
                                    }
                                },
                                "item_id": 0,
                                "name": "string",
                                "price": 0,
                                "product_option": {
                                    "extension_attributes": {
                                        "bundle_options": [
                                            {
                                                "extension_attributes": {},
                                                "option_id": 0,
                                                "option_qty": 0,
                                                "option_selections": [
                                                    0
                                                ]
                                            }
                                        ],
                                        "configurable_item_options": [
                                            {
                                                "extension_attributes": {},
                                                "option_id": "string",
                                                "option_value": 0
                                            }
                                        ],
                                        "custom_options": [
                                            {
                                                "extension_attributes": {
                                                    "file_info": {
                                                        "base64_encoded_data": "string",
                                                        "name": "string",
                                                        "type": "string"
                                                    }
                                                },
                                                "option_id": "string",
                                                "option_value": "string"
                                            }
                                        ],
                                        "downloadable_option": {
                                            "downloadable_links": [
                                                0
                                            ]
                                        },
                                        "giftcard_item_option": {
                                            "custom_giftcard_amount": 0,
                                            "extension_attributes": {},
                                            "giftcard_amount": "string",
                                            "giftcard_message": "string",
                                            "giftcard_recipient_email": "string",
                                            "giftcard_recipient_name": "string",
                                            "giftcard_sender_email": "string",
                                            "giftcard_sender_name": "string"
                                        }
                                    }
                                },
                                "product_type": "string",
                                "qty": 0,
                                "quote_id": "string",
                                "sku": "string"
                            }
                        ],
                        "shipping": {
                            "address": {
                                "city": "string",
                                "company": "string",
                                "country_id": "string",
                                "custom_attributes": [
                                    {
                                        "attribute_code": "string",
                                        "value": "string"
                                    }
                                ],
                                "customer_address_id": 0,
                                "customer_id": 0,
                                "email": "string",
                                "extension_attributes": {
                                    "checkout_fields": [
                                        {
                                            "attribute_code": "string",
                                            "value": "string"
                                        }
                                    ],
                                    "gift_registry_id": 0
                                },
                                "fax": "string",
                                "firstname": "string",
                                "id": 0,
                                "lastname": "string",
                                "middlename": "string",
                                "postcode": "string",
                                "prefix": "string",
                                "region": "string",
                                "region_code": "string",
                                "region_id": 0,
                                "same_as_billing": 0,
                                "save_in_address_book": 0,
                                "street": [
                                    "string"
                                ],
                                "suffix": "string",
                                "telephone": "string",
                                "vat_id": "string"
                            },
                            "extension_attributes": {},
                            "method": "string"
                        }
                    }
                ]
            },
            "id": 0,
            "is_active": true,
            "is_virtual": true,
            "items": [
                {
                    "extension_attributes": {
                        "negotiable_quote_item": {
                            "extension_attributes": {},
                            "item_id": 0,
                            "original_discount_amount": 0,
                            "original_price": 0,
                            "original_tax_amount": 0
                        }
                    },
                    "item_id": 0,
                    "name": "string",
                    "price": 0,
                    "product_option": {
                        "extension_attributes": {
                            "bundle_options": [
                                {
                                    "extension_attributes": {},
                                    "option_id": 0,
                                    "option_qty": 0,
                                    "option_selections": [
                                        0
                                    ]
                                }
                            ],
                            "configurable_item_options": [
                                {
                                    "extension_attributes": {},
                                    "option_id": "string",
                                    "option_value": 0
                                }
                            ],
                            "custom_options": [
                                {
                                    "extension_attributes": {
                                        "file_info": {
                                            "base64_encoded_data": "string",
                                            "name": "string",
                                            "type": "string"
                                        }
                                    },
                                    "option_id": "string",
                                    "option_value": "string"
                                }
                            ],
                            "downloadable_option": {
                                "downloadable_links": [
                                    0
                                ]
                            },
                            "giftcard_item_option": {
                                "custom_giftcard_amount": 0,
                                "extension_attributes": {},
                                "giftcard_amount": "string",
                                "giftcard_message": "string",
                                "giftcard_recipient_email": "string",
                                "giftcard_recipient_name": "string",
                                "giftcard_sender_email": "string",
                                "giftcard_sender_name": "string"
                            }
                        }
                    },
                    "product_type": "string",
                    "qty": 0,
                    "quote_id": "string",
                    "sku": "string"
                }
            ],
            "items_count": 0,
            "items_qty": 0,
            "orig_order_id": 0,
            "reserved_order_id": "string",
            "store_id": 0,
            "updated_at": "string"
        }
    ],
    "search_criteria": {
        "current_page": 0,
        "filter_groups": [
            {
                "filters": [
                    {
                        "condition_type": "string",
                        "field": "string",
                        "value": "string"
                    }
                ]
            }
        ],
        "page_size": 0,
        "sort_orders": [
            {
                "direction": "string",
                "field": "string"
            }
        ]
    },
    "total_count": 0
}

请求参数

Query 参数

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.

返回响应

🟢200成功

application/json

200 Success.

Body

Interface CartSearchResultsInterface

items

array[object (quote-data-cart-interface) {20}]

必需

Carts list.

billing_address

object (quote-data-address-interface)

可选

Interface AddressInterface

converted_at

string

可选

Cart conversion date and time. Otherwise, null.

created_at

string

可选

Cart creation date and time. Otherwise, null.

currency

object (quote-data-currency-interface)

可选

Interface CurrencyInterface

customer

object (customer-data-customer-interface)

必需

Customer interface.

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.

extension_attributes

object (quote-data-cart-extension-interface)

可选

ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface

integer

必需

Cart/quote ID.

is_active

boolean

可选

Active status flag value. Otherwise, null.

is_virtual

boolean

可选

Virtual flag value. Otherwise, null.

items

array[object (quote-data-cart-item-interface) {9}]

可选

Array of items. Otherwise, null.

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.

orig_order_id

integer

可选

Original order ID. Otherwise, null.

reserved_order_id

string

可选

Reserved order ID. Otherwise, null.

store_id

integer

必需

Store identifier

updated_at

string

可选

Cart last update date and time. Otherwise, null.

search_criteria

object (framework-search-criteria-interface)

必需

Search criteria interface.

current_page

integer

可选

Current page.

filter_groups

array[object (framework-search-filter-group) {1}]

必需

A list of filter groups.

page_size

integer

可选

Page size.

sort_orders

array[object (framework-sort-order) {2}]

可选

Sort order.

total_count

integer

必需

Total count.

🟠401没有权限

🔴500服务器错误

修改于 2024-11-22 03:29:06

salesRules/search

salesRules/{ruleId}