ReDoc documentation
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 Success.
401 Unauthorized
Unexpected error
{- "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,
- "event_id": 0,
- "ext_order_item_id": "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,
- "discount_tax_compensation_amount": 0,
- "discount_tax_compensation_canceled": 0,
- "discount_tax_compensation_invoiced": 0,
- "discount_tax_compensation_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_id": 0,
- "price": 0,
- "price_incl_tax": 0,
- "product_id": 0,
- "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,
- "parent_item": { },
- "product_option": {
- "extension_attributes": {
- "custom_options": [
- {
- "option_id": "string",
- "option_value": "string",
- "extension_attributes": {
- "file_info": null
}
}
], - "bundle_options": [
- {
- "option_id": 0,
- "option_qty": 0,
- "option_selections": [
- null
], - "extension_attributes": { }
}
], - "downloadable_option": {
- "downloadable_links": [
- 0
]
}, - "giftcard_item_option": {
- "giftcard_amount": "string",
- "custom_giftcard_amount": 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": [
- null
]
}
}, - "configurable_item_options": [
- {
- "option_id": "string",
- "option_value": 0,
- "extension_attributes": { }
}
]
}
}, - "extension_attributes": {
- "gift_message": {
- "gift_message_id": 0,
- "customer_id": 0,
- "sender": "string",
- "recipient": "string",
- "message": "string",
- "extension_attributes": {
- "entity_id": "string",
- "entity_type": "string",
- "wrapping_id": 0,
- "wrapping_allow_gift_receipt": true,
- "wrapping_add_printed_card": true
}
}, - "gw_id": "string",
- "gw_base_price": "string",
- "gw_price": "string",
- "gw_base_tax_amount": "string",
- "gw_tax_amount": "string",
- "gw_base_price_invoiced": "string",
- "gw_price_invoiced": "string",
- "gw_base_tax_amount_invoiced": "string",
- "gw_tax_amount_invoiced": "string",
- "gw_base_price_refunded": "string",
- "gw_price_refunded": "string",
- "gw_base_tax_amount_refunded": "string",
- "gw_tax_amount_refunded": "string"
}
}
], - "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
}