orders/items

GET

/V1/orders/items

orders/items

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

响应示例

200 - 示例 1

{
    "items": [
        {
            "additional_data": "string",
            "amount_refunded": 0,
            "applied_rule_ids": "string",
            "base_amount_refunded": 0,
            "base_cost": 0,
            "base_discount_amount": 0,
            "base_discount_invoiced": 0,
            "base_discount_refunded": 0,
            "base_discount_tax_compensation_amount": 0,
            "base_discount_tax_compensation_invoiced": 0,
            "base_discount_tax_compensation_refunded": 0,
            "base_original_price": 0,
            "base_price": 0,
            "base_price_incl_tax": 0,
            "base_row_invoiced": 0,
            "base_row_total": 0,
            "base_row_total_incl_tax": 0,
            "base_tax_amount": 0,
            "base_tax_before_discount": 0,
            "base_tax_invoiced": 0,
            "base_tax_refunded": 0,
            "base_weee_tax_applied_amount": 0,
            "base_weee_tax_applied_row_amnt": 0,
            "base_weee_tax_disposition": 0,
            "base_weee_tax_row_disposition": 0,
            "created_at": "string",
            "description": "string",
            "discount_amount": 0,
            "discount_invoiced": 0,
            "discount_percent": 0,
            "discount_refunded": 0,
            "discount_tax_compensation_amount": 0,
            "discount_tax_compensation_canceled": 0,
            "discount_tax_compensation_invoiced": 0,
            "discount_tax_compensation_refunded": 0,
            "event_id": 0,
            "ext_order_item_id": "string",
            "extension_attributes": {
                "gift_message": {
                    "customer_id": 0,
                    "extension_attributes": {
                        "entity_id": "string",
                        "entity_type": "string",
                        "wrapping_add_printed_card": true,
                        "wrapping_allow_gift_receipt": true,
                        "wrapping_id": 0
                    },
                    "gift_message_id": 0,
                    "message": "string",
                    "recipient": "string",
                    "sender": "string"
                },
                "gw_base_price": "string",
                "gw_base_price_invoiced": "string",
                "gw_base_price_refunded": "string",
                "gw_base_tax_amount": "string",
                "gw_base_tax_amount_invoiced": "string",
                "gw_base_tax_amount_refunded": "string",
                "gw_id": "string",
                "gw_price": "string",
                "gw_price_invoiced": "string",
                "gw_price_refunded": "string",
                "gw_tax_amount": "string",
                "gw_tax_amount_invoiced": "string",
                "gw_tax_amount_refunded": "string",
                "invoice_text_codes": [
                    "string"
                ],
                "tax_codes": [
                    "string"
                ],
                "vertex_tax_codes": [
                    "string"
                ]
            },
            "free_shipping": 0,
            "gw_base_price": 0,
            "gw_base_price_invoiced": 0,
            "gw_base_price_refunded": 0,
            "gw_base_tax_amount": 0,
            "gw_base_tax_amount_invoiced": 0,
            "gw_base_tax_amount_refunded": 0,
            "gw_id": 0,
            "gw_price": 0,
            "gw_price_invoiced": 0,
            "gw_price_refunded": 0,
            "gw_tax_amount": 0,
            "gw_tax_amount_invoiced": 0,
            "gw_tax_amount_refunded": 0,
            "is_qty_decimal": 0,
            "is_virtual": 0,
            "item_id": 0,
            "locked_do_invoice": 0,
            "locked_do_ship": 0,
            "name": "string",
            "no_discount": 0,
            "order_id": 0,
            "original_price": 0,
            "parent_item": {},
            "parent_item_id": 0,
            "price": 0,
            "price_incl_tax": 0,
            "product_id": 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_backordered": 0,
            "qty_canceled": 0,
            "qty_invoiced": 0,
            "qty_ordered": 0,
            "qty_refunded": 0,
            "qty_returned": 0,
            "qty_shipped": 0,
            "quote_item_id": 0,
            "row_invoiced": 0,
            "row_total": 0,
            "row_total_incl_tax": 0,
            "row_weight": 0,
            "sku": "string",
            "store_id": 0,
            "tax_amount": 0,
            "tax_before_discount": 0,
            "tax_canceled": 0,
            "tax_invoiced": 0,
            "tax_percent": 0,
            "tax_refunded": 0,
            "updated_at": "string",
            "weee_tax_applied": "string",
            "weee_tax_applied_amount": 0,
            "weee_tax_applied_row_amount": 0,
            "weee_tax_disposition": 0,
            "weee_tax_row_disposition": 0,
            "weight": 0
        }
    ],
    "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

Order item search result interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.

items

array[object (sales-data-order-item-interface) {95}]

必需

Array of collection items.

additional_data

string

可选

Additional data.

amount_refunded

number

可选

Amount refunded.

applied_rule_ids

string

可选

Applied rule IDs.

base_amount_refunded

number

可选

Base amount refunded.

base_cost

number

可选

Base cost.

base_discount_amount

number

可选

Base discount amount.

base_discount_invoiced

number

可选

Base discount invoiced.

base_discount_refunded

number

可选

Base discount refunded.

base_discount_tax_compensation_amount

number

可选

Base discount tax compensation amount.

base_discount_tax_compensation_invoiced

number

可选

Base discount tax compensation invoiced.

base_discount_tax_compensation_refunded

number

可选

Base discount tax compensation refunded.

base_original_price

number

可选

Base original price.

base_price

number

可选

Base price.

base_price_incl_tax

number

可选

Base price including tax.

base_row_invoiced

number

可选

Base row invoiced.

base_row_total

number

可选

Base row total.

base_row_total_incl_tax

number

可选

Base row total including tax.

base_tax_amount

number

可选

Base tax amount.

base_tax_before_discount

number

可选

Base tax before discount.

base_tax_invoiced

number

可选

Base tax invoiced.

base_tax_refunded

number

可选

Base tax refunded.

base_weee_tax_applied_amount

number

可选

Base WEEE tax applied amount.

base_weee_tax_applied_row_amnt

number

可选

Base WEEE tax applied row amount.

base_weee_tax_disposition

number

可选

Base WEEE tax disposition.

base_weee_tax_row_disposition

number

可选

Base WEEE tax row disposition.

created_at

string

可选

Created-at timestamp.

description

string

可选

Description.

discount_amount

number

可选

Discount amount.

discount_invoiced

number

可选

Discount invoiced.

discount_percent

number

可选

Discount percent.

discount_refunded

number

可选

Discount refunded.

discount_tax_compensation_amount

number

可选

Discount tax compensation amount.

discount_tax_compensation_canceled

number

可选

Discount tax compensation canceled.

discount_tax_compensation_invoiced

number

可选

Discount tax compensation invoiced.

discount_tax_compensation_refunded

number

可选

Discount tax compensation refunded.

event_id

integer

Event ID.

可选

ext_order_item_id

string

可选

External order item ID.

extension_attributes

object (sales-data-order-item-extension-interface)

可选

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

free_shipping

integer

可选

Free-shipping flag value.

gw_base_price

number

可选

GW base price.

gw_base_price_invoiced

number

可选

GW base price invoiced.

gw_base_price_refunded

number

可选

GW base price refunded.

gw_base_tax_amount

number

可选

GW base tax amount.

gw_base_tax_amount_invoiced

number

可选

GW base tax amount invoiced.

gw_base_tax_amount_refunded

number

可选

GW base tax amount refunded.

gw_id

integer

GW ID.

可选

gw_price

number

GW price.

可选

gw_price_invoiced

number

可选

GW price invoiced.

gw_price_refunded

number

可选

GW price refunded.

gw_tax_amount

number

可选

GW tax amount.

gw_tax_amount_invoiced

number

可选

GW tax amount invoiced.

gw_tax_amount_refunded

number

可选

GW tax amount refunded.

is_qty_decimal

integer

可选

Is-quantity-decimal flag value.

is_virtual

integer

可选

Is-virtual flag value.

item_id

integer

Item ID.

可选

locked_do_invoice

integer

可选

Locked DO invoice flag value.

locked_do_ship

integer

可选

Locked DO ship flag value.

name

string

Name.

可选

no_discount

integer

可选

No-discount flag value.

order_id

integer

Order ID.

可选

original_price

number

可选

Original price.

parent_item

object (sales-data-order-item-interface)

可选

Order item interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.

parent_item_id

integer

可选

Parent item ID.

price

number

Price.

可选

price_incl_tax

number

可选

Price including tax.

product_id

integer

可选

Product ID.

product_option

object (catalog-data-product-option-interface)

可选

Product option interface

product_type

string

可选

Product type.

qty_backordered

number

可选

Quantity backordered.

qty_canceled

number

可选

Quantity canceled.

qty_invoiced

number

可选

Quantity invoiced.

qty_ordered

number

可选

Quantity ordered.

qty_refunded

number

可选

Quantity refunded.

qty_returned

number

可选

Quantity returned.

qty_shipped

number

可选

Quantity shipped.

quote_item_id

integer

可选

Quote item ID.

row_invoiced

number

可选

Row invoiced.

row_total

number

可选

Row total.

row_total_incl_tax

number

可选

Row total including tax.

row_weight

number

可选

Row weight.

sku

string

SKU.

必需

store_id

integer

Store ID.

可选

tax_amount

number

可选

Tax amount.

tax_before_discount

number

可选

Tax before discount.

tax_canceled

number

可选

Tax canceled.

tax_invoiced

number

可选

Tax invoiced.

tax_percent

number

可选

Tax percent.

tax_refunded

number

可选

Tax refunded.

updated_at

string

可选

Updated-at timestamp.

weee_tax_applied

string

可选

WEEE tax applied.

weee_tax_applied_amount

number

可选

WEEE tax applied amount.

weee_tax_applied_row_amount

number

可选

WEEE tax applied row amount.

weee_tax_disposition

number

可选

WEEE tax disposition.

weee_tax_row_disposition

number

可选

WEEE tax row disposition.

weight

number

Weight.

可选

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

orders/create

orders/items/{id}