Magento2

Lists order items that match specified search criteria

GET /V1/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://developer.adobe.com/commerce/webapi/rest/attributes#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Query parameters

  • 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.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • items array[object] Required

      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.

      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.

      Hide items attributes Show items attributes object
      • 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.

      • event_id integer

        Event ID.

      • ext_order_item_id string

        External order item ID.

      • 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.

      • 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.

      • 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_id integer

        Parent item ID.

      • price number

        Price.

      • price_incl_tax number

        Price including tax.

      • product_id integer

        Product ID.

      • 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 Required

        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.

      • parent_item object

        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.

      • product_option object

        Product option interface

        Hide product_option attribute Show product_option attribute object
        • extension_attributes object

          ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductOptionInterface

          Hide extension_attributes attributes Show extension_attributes attributes object
          • custom_options array[object]

            Interface CustomOptionInterface

            Interface CustomOptionInterface

            Hide custom_options attributes Show custom_options attributes object
            • option_id string Required

              Option id

            • option_value string Required

              Option value

            • extension_attributes object

              ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface

              Hide extension_attributes attribute Show extension_attributes attribute object
              • file_info object

                Image Content data interface

                Hide file_info attributes Show file_info attributes object
                • base64_encoded_data string Required

                  Media data (base64 encoded content)

                • type string Required

                  MIME type

                • name string Required

                  Image name

          • bundle_options array[object]

            Interface BundleOptionInterface

            Interface BundleOptionInterface

            Hide bundle_options attributes Show bundle_options attributes object
            • option_id integer Required

              Bundle option id.

            • option_qty integer Required

              Bundle option quantity.

            • option_selections array[integer] Required

              Bundle option selection ids.

            • extension_attributes object

              ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface

          • downloadable_option object

            Downloadable Option

            Hide downloadable_option attribute Show downloadable_option attribute object
            • downloadable_links array[integer] Required

              The list of downloadable links

          • giftcard_item_option object

            Interface GiftCardOptionInterface

            Hide giftcard_item_option attributes Show giftcard_item_option attributes object
            • giftcard_amount string Required

              Gift card amount.

            • custom_giftcard_amount number

              Gift card open amount value.

            • giftcard_sender_name string Required

              Gift card sender name.

            • giftcard_recipient_name string Required

              Gift card recipient name.

            • giftcard_sender_email string Required

              Gift card sender email.

            • giftcard_recipient_email string Required

              Gift card recipient email.

            • giftcard_message string

              Giftcard message.

            • extension_attributes object

              ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface

              Hide extension_attributes attribute Show extension_attributes attribute object
              • giftcard_created_codes array[string]
          • configurable_item_options array[object]

            Interface ConfigurableItemOptionValueInterface

            Interface ConfigurableItemOptionValueInterface

            Hide configurable_item_options attributes Show configurable_item_options attributes object
            • option_id string Required

              Option SKU

            • option_value string

              Item id

            • extension_attributes object

              ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface

      • extension_attributes object

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

        Hide extension_attributes attributes Show extension_attributes attributes object
        • itemized_taxes array[object]
          Hide itemized_taxes attributes Show itemized_taxes attributes object
          • tax_item_id integer

            Tax item ID

          • tax_id integer

            Tax ID

          • item_id integer

            Order item ID

          • tax_code string

            Tax code

          • tax_percent number Required

            Tax percent

          • amount number Required

            Tax amount

          • base_amount number Required

            Tax amount in base currency

          • real_amount number Required

            Real tax amount

          • real_base_amount number Required

            Real tax amount in base currency

          • associated_item_id integer

            Associated order item ID

          • taxable_item_type string

            shipping, product, weee, quote_gw, etc...

          • extension_attributes object

            ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxItemInterface

        • gift_message object

          Interface MessageInterface

          Hide gift_message attributes Show gift_message attributes object
          • gift_message_id integer

            Gift message ID. Otherwise, null.

          • customer_id integer

            Customer ID. Otherwise, null.

          • sender string Required

            Sender name.

          • recipient string Required

            Recipient name.

          • message string Required

            Message text.

          • extension_attributes object

            ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface

            Hide extension_attributes attributes Show extension_attributes attributes object
            • entity_id string
            • entity_type string
            • wrapping_id integer
            • wrapping_allow_gift_receipt boolean
            • wrapping_add_printed_card boolean
        • 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
        • list_price number
        • size string
        • color string
        • merchant_product_reference string
        • category_code string
        • image string
        • mpn string
        • msrp number
        • is_sale boolean
        • manufacturer_code string
        • manufacturer_name string
        • merchant_code string
        • merchant_name string
        • merchant_city string
        • merchant_commission_percentage number
        • merchant_deficiency_percentage number
        • merchant_handling_fee number
        • return_item_fee number
        • base_return_item_fee number
        • configurable_sku string
        • is_outlet boolean
    • search_criteria object Required

      Search criteria interface.

      Hide search_criteria attributes Show search_criteria attributes object
      • filter_groups array[object] Required

        Groups two or more filters together using a logical OR

        Groups two or more filters together using a logical OR

        Hide filter_groups attribute Show filter_groups attribute object
        • filters array[object]

          Filter which can be used by any methods from service layer.

          Filter which can be used by any methods from service layer.

          Hide filters attributes Show filters attributes object
          • field string Required

            Field

          • value string Required

            Value

          • condition_type string

            Condition type

      • sort_orders array[object]

        Data object for sort order.

        Data object for sort order.

        Hide sort_orders attributes Show sort_orders attributes object
        • field string Required

          Sorting field.

        • direction string Required

          Sorting direction.

      • page_size integer

        Page size.

      • current_page integer

        Current page.

    • total_count integer Required

      Total count.
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
GET /V1/orders/items 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/orders/items'
Response examples (200) 
{
  "items": [
    {
      "additional_data": "string",
      "amount_refunded": 42.0,
      "applied_rule_ids": "string",
      "base_amount_refunded": 42.0,
      "base_cost": 42.0,
      "base_discount_amount": 42.0,
      "base_discount_invoiced": 42.0,
      "base_discount_refunded": 42.0,
      "base_discount_tax_compensation_amount": 42.0,
      "base_discount_tax_compensation_invoiced": 42.0,
      "base_discount_tax_compensation_refunded": 42.0,
      "base_original_price": 42.0,
      "base_price": 42.0,
      "base_price_incl_tax": 42.0,
      "base_row_invoiced": 42.0,
      "base_row_total": 42.0,
      "base_row_total_incl_tax": 42.0,
      "base_tax_amount": 42.0,
      "base_tax_before_discount": 42.0,
      "base_tax_invoiced": 42.0,
      "base_tax_refunded": 42.0,
      "base_weee_tax_applied_amount": 42.0,
      "base_weee_tax_applied_row_amnt": 42.0,
      "base_weee_tax_disposition": 42.0,
      "base_weee_tax_row_disposition": 42.0,
      "created_at": "string",
      "description": "string",
      "discount_amount": 42.0,
      "discount_invoiced": 42.0,
      "discount_percent": 42.0,
      "discount_refunded": 42.0,
      "event_id": 42,
      "ext_order_item_id": "string",
      "free_shipping": 42,
      "gw_base_price": 42.0,
      "gw_base_price_invoiced": 42.0,
      "gw_base_price_refunded": 42.0,
      "gw_base_tax_amount": 42.0,
      "gw_base_tax_amount_invoiced": 42.0,
      "gw_base_tax_amount_refunded": 42.0,
      "gw_id": 42,
      "gw_price": 42.0,
      "gw_price_invoiced": 42.0,
      "gw_price_refunded": 42.0,
      "gw_tax_amount": 42.0,
      "gw_tax_amount_invoiced": 42.0,
      "gw_tax_amount_refunded": 42.0,
      "discount_tax_compensation_amount": 42.0,
      "discount_tax_compensation_canceled": 42.0,
      "discount_tax_compensation_invoiced": 42.0,
      "discount_tax_compensation_refunded": 42.0,
      "is_qty_decimal": 42,
      "is_virtual": 42,
      "item_id": 42,
      "locked_do_invoice": 42,
      "locked_do_ship": 42,
      "name": "string",
      "no_discount": 42,
      "order_id": 42,
      "original_price": 42.0,
      "parent_item_id": 42,
      "price": 42.0,
      "price_incl_tax": 42.0,
      "product_id": 42,
      "product_type": "string",
      "qty_backordered": 42.0,
      "qty_canceled": 42.0,
      "qty_invoiced": 42.0,
      "qty_ordered": 42.0,
      "qty_refunded": 42.0,
      "qty_returned": 42.0,
      "qty_shipped": 42.0,
      "quote_item_id": 42,
      "row_invoiced": 42.0,
      "row_total": 42.0,
      "row_total_incl_tax": 42.0,
      "row_weight": 42.0,
      "sku": "string",
      "store_id": 42,
      "tax_amount": 42.0,
      "tax_before_discount": 42.0,
      "tax_canceled": 42.0,
      "tax_invoiced": 42.0,
      "tax_percent": 42.0,
      "tax_refunded": 42.0,
      "updated_at": "string",
      "weee_tax_applied": "string",
      "weee_tax_applied_amount": 42.0,
      "weee_tax_applied_row_amount": 42.0,
      "weee_tax_disposition": 42.0,
      "weee_tax_row_disposition": 42.0,
      "weight": 42.0,
      "parent_item": {},
      "product_option": {
        "extension_attributes": {
          "custom_options": [
            {
              "option_id": "string",
              "option_value": "string",
              "extension_attributes": {
                "file_info": {
                  "base64_encoded_data": "string",
                  "type": "string",
                  "name": "string"
                }
              }
            }
          ],
          "bundle_options": [
            {
              "option_id": 42,
              "option_qty": 42,
              "option_selections": [
                42
              ],
              "extension_attributes": {}
            }
          ],
          "downloadable_option": {
            "downloadable_links": [
              42
            ]
          },
          "giftcard_item_option": {
            "giftcard_amount": "string",
            "custom_giftcard_amount": 42.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": [
                "string"
              ]
            }
          },
          "configurable_item_options": [
            {
              "option_id": "string",
              "option_value": "string",
              "extension_attributes": {}
            }
          ]
        }
      },
      "extension_attributes": {
        "itemized_taxes": [
          {
            "tax_item_id": 42,
            "tax_id": 42,
            "item_id": 42,
            "tax_code": "string",
            "tax_percent": 42.0,
            "amount": 42.0,
            "base_amount": 42.0,
            "real_amount": 42.0,
            "real_base_amount": 42.0,
            "associated_item_id": 42,
            "taxable_item_type": "string",
            "extension_attributes": {}
          }
        ],
        "gift_message": {
          "gift_message_id": 42,
          "customer_id": 42,
          "sender": "string",
          "recipient": "string",
          "message": "string",
          "extension_attributes": {
            "entity_id": "string",
            "entity_type": "string",
            "wrapping_id": 42,
            "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",
        "list_price": 42.0,
        "size": "string",
        "color": "string",
        "merchant_product_reference": "string",
        "category_code": "string",
        "image": "string",
        "mpn": "string",
        "msrp": 42.0,
        "is_sale": true,
        "manufacturer_code": "string",
        "manufacturer_name": "string",
        "merchant_code": "string",
        "merchant_name": "string",
        "merchant_city": "string",
        "merchant_commission_percentage": 42.0,
        "merchant_deficiency_percentage": 42.0,
        "merchant_handling_fee": 42.0,
        "return_item_fee": 42.0,
        "base_return_item_fee": 42.0,
        "configurable_sku": "string",
        "is_outlet": true
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}