shipments

GET

/V1/shipments

Lists shipments 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#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

响应示例

200 - 示例 1

{
    "items": [
        {
            "billing_address_id": 0,
            "comments": [
                {
                    "comment": "string",
                    "created_at": "string",
                    "entity_id": 0,
                    "extension_attributes": {},
                    "is_customer_notified": 0,
                    "is_visible_on_front": 0,
                    "parent_id": 0
                }
            ],
            "created_at": "string",
            "customer_id": 0,
            "email_sent": 0,
            "entity_id": 0,
            "extension_attributes": {
                "ext_location_id": "string",
                "ext_return_shipment_id": "string",
                "ext_shipment_id": "string",
                "ext_tracking_reference": "string",
                "ext_tracking_url": "string"
            },
            "increment_id": "string",
            "items": [
                {
                    "additional_data": "string",
                    "description": "string",
                    "entity_id": 0,
                    "extension_attributes": {},
                    "name": "string",
                    "order_item_id": 0,
                    "parent_id": 0,
                    "price": 0,
                    "product_id": 0,
                    "qty": 0,
                    "row_total": 0,
                    "sku": "string",
                    "weight": 0
                }
            ],
            "order_id": 0,
            "packages": [
                {
                    "extension_attributes": {}
                }
            ],
            "shipment_status": 0,
            "shipping_address_id": 0,
            "shipping_label": "string",
            "store_id": 0,
            "total_qty": 0,
            "total_weight": 0,
            "tracks": [
                {
                    "carrier_code": "string",
                    "created_at": "string",
                    "description": "string",
                    "entity_id": 0,
                    "extension_attributes": {},
                    "order_id": 0,
                    "parent_id": 0,
                    "qty": 0,
                    "title": "string",
                    "track_number": "string",
                    "updated_at": "string",
                    "weight": 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

Shipment search result interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

items

array[object (sales-data-shipment-interface) {19}]

必需

Array of collection items.

billing_address_id

integer

可选

Billing address ID.

comments

array[object (sales-data-shipment-comment-interface) {7}]

必需

Array of comments.

created_at

string

可选

Created-at timestamp.

customer_id

integer

可选

Customer ID.

email_sent

integer

可选

Email-sent flag value.

entity_id

integer

可选

Shipment ID.

extension_attributes

object (sales-data-shipment-extension-interface)

可选

ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentInterface

increment_id

string

可选

Increment ID.

items

array[object (sales-data-shipment-item-interface) {13}]

必需

Array of items.

order_id

integer

Order ID.

必需

packages

array[object (sales-data-shipment-package-interface) {1}]

可选

Array of packages, if any. Otherwise, null.

shipment_status

integer

可选

Shipment status.

shipping_address_id

integer

可选

Shipping address ID.

shipping_label

string

可选

Shipping label.

store_id

integer

Store ID.

可选

total_qty

number

可选

Total quantity.

total_weight

number

可选

Total weight.

tracks

array[object (sales-data-shipment-track-interface) {12}]

必需

Array of tracks.

updated_at

string

可选

Updated-at timestamp.

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