Lists orders that match specified search criteria

GET /V1/orders

Lists orders 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#OrderRepositoryInterface 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 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 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
      • adjustment_negative number

        Negative adjustment value.

      • adjustment_positive number

        Positive adjustment value.

      • applied_rule_ids string

        Applied rule IDs.

      • base_adjustment_negative number

        Base negative adjustment value.

      • base_adjustment_positive number

        Base positive adjustment value.

      • base_currency_code string

        Base currency code.

      • base_discount_amount number

        Base discount amount.

      • base_discount_canceled number

        Base discount canceled.

      • base_discount_invoiced number

        Base discount invoiced.

      • base_discount_refunded number

        Base discount refunded.

      • base_grand_total number Required

        Base grand total.

      • 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_shipping_amount number

        Base shipping amount.

      • base_shipping_canceled number

        Base shipping canceled.

      • base_shipping_discount_amount number

        Base shipping discount amount.

      • base_shipping_discount_tax_compensation_amnt number

        Base shipping discount tax compensation amount.

      • base_shipping_incl_tax number

        Base shipping including tax.

      • base_shipping_invoiced number

        Base shipping invoiced.

      • base_shipping_refunded number

        Base shipping refunded.

      • base_shipping_tax_amount number

        Base shipping tax amount.

      • base_shipping_tax_refunded number

        Base shipping tax refunded.

      • base_subtotal number

        Base subtotal.

      • base_subtotal_canceled number

        Base subtotal canceled.

      • base_subtotal_incl_tax number

        Base subtotal including tax.

      • base_subtotal_invoiced number

        Base subtotal invoiced.

      • base_subtotal_refunded number

        Base subtotal refunded.

      • base_tax_amount number

        Base tax amount.

      • base_tax_canceled number

        Base tax canceled.

      • base_tax_invoiced number

        Base tax invoiced.

      • base_tax_refunded number

        Base tax refunded.

      • base_total_canceled number

        Base total canceled.

      • base_total_due number

        Base total due.

      • base_total_invoiced number

        Base total invoiced.

      • base_total_invoiced_cost number

        Base total invoiced cost.

      • base_total_offline_refunded number

        Base total offline refunded.

      • base_total_online_refunded number

        Base total online refunded.

      • base_total_paid number

        Base total paid.

      • base_total_qty_ordered number

        Base total quantity ordered.

      • base_total_refunded number

        Base total refunded.

      • base_to_global_rate number

        Base-to-global rate.

      • base_to_order_rate number

        Base-to-order rate.

      • billing_address_id integer

        Billing address ID.

      • can_ship_partially integer

        Can-ship-partially flag value.

      • can_ship_partially_item integer

        Can-ship-partially-item flag value.

      • coupon_code string

        Coupon code.

      • created_at string

        Created-at timestamp.

      • customer_dob string

        In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers (e.g., full name) before collecting or processing such data.

      • customer_email string Required

        Customer email address.

      • customer_firstname string

        Customer first name.

      • customer_gender integer

        Customer gender.

      • customer_group_id integer

        Customer group ID.

      • customer_id integer

        Customer ID.

      • customer_is_guest integer

        Customer-is-guest flag value.

      • customer_lastname string

        Customer last name.

      • customer_middlename string

        Customer middle name.

      • customer_note string

        Customer note.

      • customer_note_notify integer

        Customer-note-notify flag value.

      • customer_prefix string

        Customer prefix.

      • customer_suffix string

        Customer suffix.

      • customer_taxvat string

        Customer value-added tax (VAT).

      • discount_amount number

        Discount amount.

      • discount_canceled number

        Discount canceled.

      • discount_description string

        Discount description.

      • discount_invoiced number

        Discount invoiced.

      • discount_refunded number

        Discount refunded amount.

      • edit_increment integer

        Edit increment value.

      • email_sent integer

        Email-sent flag value.

      • entity_id integer

        Order ID.

      • ext_customer_id string

        External customer ID.

      • ext_order_id string

        External order ID.

      • forced_shipment_with_invoice integer

        Forced-shipment-with-invoice flag value.

      • global_currency_code string

        Global currency code.

      • grand_total number Required

        Grand total.

      • discount_tax_compensation_amount number

        Discount tax compensation amount.

      • discount_tax_compensation_invoiced number

        Discount tax compensation invoiced amount.

      • discount_tax_compensation_refunded number

        Discount tax compensation refunded amount.

      • hold_before_state string

        Hold before state.

      • hold_before_status string

        Hold before status.

      • increment_id string

        Increment ID.

      • is_virtual integer

        Is-virtual flag value.

      • order_currency_code string

        Order currency code.

      • original_increment_id string

        Original increment ID.

      • payment_authorization_amount number

        Payment authorization amount.

      • payment_auth_expiration integer

        Payment authorization expiration date.

      • protect_code string

        Protect code.

      • quote_address_id integer

        Quote address ID.

      • quote_id integer

        Quote ID.

      • relation_child_id string

        Relation child ID.

      • relation_child_real_id string

        Relation child real ID.

      • relation_parent_id string

        Relation parent ID.

      • relation_parent_real_id string

        Relation parent real ID.

      • remote_ip string

        Remote IP address.

      • shipping_amount number

        Shipping amount.

      • shipping_canceled number

        Shipping canceled amount.

      • shipping_description string

        Shipping description.

      • shipping_discount_amount number

        Shipping discount amount.

      • shipping_discount_tax_compensation_amount number

        Shipping discount tax compensation amount.

      • shipping_incl_tax number

        Shipping including tax amount.

      • shipping_invoiced number

        Shipping invoiced amount.

      • shipping_refunded number

        Shipping refunded amount.

      • shipping_tax_amount number

        Shipping tax amount.

      • shipping_tax_refunded number

        Shipping tax refunded amount.

      • state string

        State.

      • status string

        Status.

      • store_currency_code string

        Store currency code.

      • store_id integer

        Store ID.

      • store_name string

        Store name.

      • store_to_base_rate number

        Store-to-base rate.

      • store_to_order_rate number

        Store-to-order rate.

      • subtotal number

        Subtotal.

      • subtotal_canceled number

        Subtotal canceled amount.

      • subtotal_incl_tax number

        Subtotal including tax amount.

      • subtotal_invoiced number

        Subtotal invoiced amount.

      • subtotal_refunded number

        Subtotal refunded amount.

      • tax_amount number

        Tax amount.

      • tax_canceled number

        Tax canceled amount.

      • tax_invoiced number

        Tax invoiced amount.

      • tax_refunded number

        Tax refunded amount.

      • total_canceled number

        Total canceled.

      • total_due number

        Total due.

      • total_invoiced number

        Total invoiced amount.

      • total_item_count integer

        Total item count.

      • total_offline_refunded number

        Total offline refunded amount.

      • total_online_refunded number

        Total online refunded amount.

      • total_paid number

        Total paid.

      • total_qty_ordered number

        Total quantity ordered.

      • total_refunded number

        Total amount refunded.

      • updated_at string

        Updated-at timestamp.

      • weight number

        Weight.

      • x_forwarded_for string

        X-Forwarded-For field value.

      • 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
            • 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
      • billing_address object

        Order address 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 billing_address attributes Show billing_address attributes object
        • address_type string Required

          Address type.

        • city string Required

          City.

        • company string

          Company.

        • country_id string Required

          Country ID.

        • customer_address_id integer

          Country address ID.

        • customer_id integer

          Customer ID.

        • email string

          Email address.

        • entity_id integer

          Order address ID.

        • fax string

          Fax number.

        • firstname string Required

          First name.

        • lastname string Required

          Last name.

        • middlename string

          Middle name.

        • parent_id integer

          Parent ID.

        • postcode string Required

          Postal code.

        • prefix string

          Prefix.

        • region string

          Region.

        • region_code string

          Region code.

        • region_id integer

          Region ID.

        • street array[string]

          Array of any street values. Otherwise, null.

        • suffix string

          Suffix.

        • telephone string Required

          Telephone number.

        • vat_id string

          VAT ID.

        • vat_is_valid integer

          VAT-is-valid flag value.

        • vat_request_date string

          VAT request date.

        • vat_request_id string

          VAT request ID.

        • vat_request_success integer

          VAT-request-success flag value.

        • extension_attributes object

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

      • payment object

        Order payment 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 payment attributes Show payment attributes object
        • account_status string Required

          Account status.

        • additional_data string

          Additional data.

        • additional_information array[string] Required

          Array of additional information.

        • address_status string

          Address status.

        • amount_authorized number

          Amount authorized.

        • amount_canceled number

          Amount canceled.

        • amount_ordered number

          Amount ordered.

        • amount_paid number

          Amount paid.

        • amount_refunded number

          Amount refunded.

        • anet_trans_method string

          Anet transaction method.

        • base_amount_authorized number

          Base amount authorized.

        • base_amount_canceled number

          Base amount canceled.

        • base_amount_ordered number

          Base amount ordered.

        • base_amount_paid number

          Base amount paid.

        • base_amount_paid_online number

          Base amount paid online.

        • base_amount_refunded number

          Base amount refunded.

        • base_amount_refunded_online number

          Base amount refunded online.

        • base_shipping_amount number

          Base shipping amount.

        • base_shipping_captured number

          Base shipping captured amount.

        • base_shipping_refunded number

          Base shipping refunded amount.

        • cc_approval string

          Credit card approval.

        • cc_avs_status string

          Credit card avs status.

        • cc_cid_status string

          Credit card CID status.

        • cc_debug_request_body string

          Credit card debug request body.

        • cc_debug_response_body string

          Credit card debug response body.

        • cc_debug_response_serialized string

          Credit card debug response serialized.

        • cc_exp_month string

          Credit card expiration month.

        • cc_exp_year string

          Credit card expiration year.

        • cc_last4 string Required

          Last four digits of the credit card.

        • cc_number_enc string

          Encrypted credit card number.

        • cc_owner string

          Credit card number.

        • cc_secure_verify string

          Credit card secure verify.

        • cc_ss_issue string

          Credit card SS issue.

        • cc_ss_start_month string

          Credit card SS start month.

        • cc_ss_start_year string

          Credit card SS start year.

        • cc_status string

          Credit card status.

        • cc_status_description string

          Credit card status description.

        • cc_trans_id string

          Credit card transaction ID.

        • cc_type string

          Credit card type.

        • echeck_account_name string

          eCheck account name.

        • echeck_account_type string

          eCheck account type.

        • echeck_bank_name string

          eCheck bank name.

        • echeck_routing_number string

          eCheck routing number.

        • echeck_type string

          eCheck type.

        • entity_id integer

          Entity ID.

        • last_trans_id string

          Last transaction ID.

        • method string Required

          Method.

        • parent_id integer

          Parent ID.

        • po_number string

          PO number.

        • protection_eligibility string

          Protection eligibility.

        • quote_payment_id integer

          Quote payment ID.

        • shipping_amount number

          Shipping amount.

        • shipping_captured number

          Shipping captured.

        • shipping_refunded number

          Shipping refunded.

        • extension_attributes object

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

          Hide extension_attributes attributes Show extension_attributes attributes object
          • notification_message string
          • vault_payment_token object

            Gateway vault payment token interface.

            Hide vault_payment_token attributes Show vault_payment_token attributes object
            • entity_id integer

              Entity ID.

            • customer_id integer

              Customer ID.

            • public_hash string Required

              Public hash

            • payment_method_code string Required

              Payment method code

            • type string Required

              Type

            • created_at string

              Token creation timestamp

            • expires_at string

              Token expiration timestamp

            • gateway_token string Required

              Gateway token ID

            • token_details string Required

              Token details

            • is_active boolean Required

              Is active.

            • is_visible boolean Required

              Is visible.

            • website_id integer Required

              website id.

          • origin string
      • status_histories array[object]

        Order status history 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 status history 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 status_histories attributes Show status_histories attributes object
        • comment string Required

          Comment.

        • created_at string

          Created-at timestamp.

        • entity_id integer

          Order status history ID.

        • entity_name string

          Entity name.

        • is_customer_notified integer Required

          Is-customer-notified flag value.

        • is_visible_on_front integer Required

          Is-visible-on-storefront flag value.

        • parent_id integer Required

          Parent ID.

        • status string

          Status.

        • extension_attributes object

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

      • extension_attributes object

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

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

          Interface ShippingAssignmentInterface

          Interface ShippingAssignmentInterface

          Hide shipping_assignments attributes Show shipping_assignments attributes object
          • shipping object Required

            Interface ShippingInterface

            Hide shipping attributes Show shipping attributes object
            • address object

              Order address 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 address attributes Show address attributes object
              • address_type string Required

                Address type.

              • city string Required

                City.

              • company string

                Company.

              • country_id string Required

                Country ID.

              • customer_address_id integer

                Country address ID.

              • customer_id integer

                Customer ID.

              • email string

                Email address.

              • entity_id integer

                Order address ID.

              • fax string

                Fax number.

              • firstname string Required

                First name.

              • lastname string Required

                Last name.

              • middlename string

                Middle name.

              • parent_id integer

                Parent ID.

              • postcode string Required

                Postal code.

              • prefix string

                Prefix.

              • region string

                Region.

              • region_code string

                Region code.

              • region_id integer

                Region ID.

              • street array[string]

                Array of any street values. Otherwise, null.

              • suffix string

                Suffix.

              • telephone string Required

                Telephone number.

              • vat_id string

                VAT ID.

              • vat_is_valid integer

                VAT-is-valid flag value.

              • vat_request_date string

                VAT request date.

              • vat_request_id string

                VAT request ID.

              • vat_request_success integer

                VAT-request-success flag value.

              • extension_attributes object

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

            • method string

              Shipping method

            • total object

              Interface TotalInterface

              Hide total attributes Show total attributes object
              • base_shipping_amount number

                Base shipping amount.

              • base_shipping_canceled number

                Base shipping canceled.

              • base_shipping_discount_amount number

                Base shipping discount amount.

              • base_shipping_discount_tax_compensation_amnt number

                Base shipping discount tax compensation amount.

              • base_shipping_incl_tax number

                Base shipping including tax.

              • base_shipping_invoiced number

                Base shipping invoiced.

              • base_shipping_refunded number

                Base shipping refunded.

              • base_shipping_tax_amount number

                Base shipping tax amount.

              • base_shipping_tax_refunded number

                Base shipping tax refunded.

              • shipping_amount number

                Shipping amount.

              • shipping_canceled number

                Shipping canceled amount.

              • shipping_discount_amount number

                Shipping discount amount.

              • shipping_discount_tax_compensation_amount number

                Shipping discount tax compensation amount.

              • shipping_incl_tax number

                Shipping including tax amount.

              • shipping_invoiced number

                Shipping invoiced amount.

              • shipping_refunded number

                Shipping refunded amount.

              • shipping_tax_amount number

                Shipping tax amount.

              • shipping_tax_refunded number

                Shipping tax refunded amount.

              • extension_attributes object

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

            • extension_attributes object

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

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

            Stock id

          • extension_attributes object

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

        • payment_additional_info array[object]

          Payment additional info interface.

          Payment additional info interface.

          Hide payment_additional_info attributes Show payment_additional_info attributes object
          • key string Required

            Object key

          • value string Required

            Object value

        • company_order_attributes object

          Order company extension attributes interface. Adds new company attributes to orders.

          Hide company_order_attributes attributes Show company_order_attributes attributes object
          • order_id integer

            Order ID.

          • company_id integer

            Company ID.

          • company_name string

            Company name.

          • extension_attributes object

            ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyOrderInterface

        • applied_taxes array[object]

          Interface OrderTaxDetailsAppliedTaxInterface

          Interface OrderTaxDetailsAppliedTaxInterface

          Hide applied_taxes attributes Show applied_taxes attributes object
          • code string

            Code

          • title string

            Title

          • percent number

            Tax Percent

          • amount number Required

            Tax amount

          • base_amount number Required

            Tax amount in base currency

          • extension_attributes object

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

            Hide extension_attributes attribute Show extension_attributes attribute object
            • rates array[object]

              Applied tax rate interface.

              Applied tax rate interface.

              Hide rates attributes Show rates attributes object
              • code string

                Code

              • title string

                Title

              • percent number

                Tax Percent

              • extension_attributes object

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

        • item_applied_taxes array[object]

          Interface OrderTaxDetailsItemInterface

          Interface OrderTaxDetailsItemInterface

          Hide item_applied_taxes attributes Show item_applied_taxes attributes object
          • type string

            Type (shipping, product, weee, gift wrapping, etc)

          • item_id integer

            Item id if this item is a product

          • associated_item_id integer

            Associated item id if this item is associated with another item, null otherwise

          • applied_taxes array[object]

            Interface OrderTaxDetailsAppliedTaxInterface

            Interface OrderTaxDetailsAppliedTaxInterface

            Hide applied_taxes attributes Show applied_taxes attributes object
            • code string

              Code

            • title string

              Title

            • percent number

              Tax Percent

            • amount number Required

              Tax amount

            • base_amount number Required

              Tax amount in base currency

            • extension_attributes object

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

              Hide extension_attributes attribute Show extension_attributes attribute object
              • rates array[object]

                Applied tax rate interface.

                Applied tax rate interface.

                Hide rates attributes Show rates attributes object
                • code string

                  Code

                • title string

                  Title

                • percent number

                  Tax Percent

                • extension_attributes object

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

          • extension_attributes object

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

        • converting_from_quote boolean
        • taxes array[object]
          Hide taxes attributes Show taxes attributes object
          • tax_id integer

            Tax ID

          • order_id integer

            Order ID

          • code string

            Code

          • title string

            Title

          • percent number Required

            Percent

          • amount number Required

            Amount

          • base_amount number Required

            Tax amount in base currency

          • base_real_amount number Required

            Real tax amount in base currency

          • priority integer Required

            Priority

          • position integer Required

            Position

          • process integer Required

            Process

          • extension_attributes object

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

        • additional_itemized_taxes array[object]
          Hide additional_itemized_taxes attributes Show additional_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

        • base_customer_balance_amount number
        • customer_balance_amount number
        • base_customer_balance_invoiced number
        • customer_balance_invoiced number
        • base_customer_balance_refunded number
        • customer_balance_refunded number
        • base_customer_balance_total_refunded number
        • customer_balance_total_refunded number
        • gift_cards array[object]

          Gift Card data

          Gift Card data

          Hide gift_cards attributes Show gift_cards attributes object
          • id integer Required

            Id

          • code string Required

            Code

          • amount number Required

            Amount

          • base_amount number Required

            Base Amount

        • base_gift_cards_amount number
        • gift_cards_amount number
        • base_gift_cards_invoiced number
        • gift_cards_invoiced number
        • base_gift_cards_refunded number
        • gift_cards_refunded number
        • 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_allow_gift_receipt string
        • gw_add_card string
        • gw_base_price string
        • gw_price string
        • gw_items_base_price string
        • gw_items_price string
        • gw_card_base_price string
        • gw_card_price string
        • gw_base_tax_amount string
        • gw_tax_amount string
        • gw_items_base_tax_amount string
        • gw_items_tax_amount string
        • gw_card_base_tax_amount string
        • gw_card_tax_amount string
        • gw_base_price_incl_tax string
        • gw_price_incl_tax string
        • gw_items_base_price_incl_tax string
        • gw_items_price_incl_tax string
        • gw_card_base_price_incl_tax string
        • gw_card_price_incl_tax string
        • gw_base_price_invoiced string
        • gw_price_invoiced string
        • gw_items_base_price_invoiced string
        • gw_items_price_invoiced string
        • gw_card_base_price_invoiced string
        • gw_card_price_invoiced string
        • gw_base_tax_amount_invoiced string
        • gw_tax_amount_invoiced string
        • gw_items_base_tax_invoiced string
        • gw_items_tax_invoiced string
        • gw_card_base_tax_invoiced string
        • gw_card_tax_invoiced string
        • gw_base_price_refunded string
        • gw_price_refunded string
        • gw_items_base_price_refunded string
        • gw_items_price_refunded string
        • gw_card_base_price_refunded string
        • gw_card_price_refunded string
        • gw_base_tax_amount_refunded string
        • gw_tax_amount_refunded string
        • gw_items_base_tax_refunded string
        • gw_items_tax_refunded string
        • gw_card_base_tax_refunded string
        • gw_card_tax_refunded string
        • pickup_location_code string
        • notification_sent integer
        • send_notification integer
        • coupon_codes array[string]
        • coupon_discounts array[string]
        • reward_points_balance integer
        • reward_currency_amount number
        • base_reward_currency_amount number
        • dhlparcel_shipping_servicepoint_id string
        • dhlparcel_shipping_checkout_options string
        • dhlparcel_shipping_connectors_date_preference string
        • origin string
        • shipping_address_firstname string
        • shipping_address_lastname string
        • rma_id integer
        • is_pickup_point boolean
        • pickup_point object
          Hide pickup_point attributes Show pickup_point attributes object
          • pick_up_point_id string Required
          • carrier_method string Required
          • name string
          • address_lines array[string] Required
          • city string Required
          • state string
          • country string Required
          • postal string Required
          • telephone string
          • fax string
        • company_id integer
    • 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
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/orders'
Response examples (200)
{
  "items": [
    {
      "adjustment_negative": 42.0,
      "adjustment_positive": 42.0,
      "applied_rule_ids": "string",
      "base_adjustment_negative": 42.0,
      "base_adjustment_positive": 42.0,
      "base_currency_code": "string",
      "base_discount_amount": 42.0,
      "base_discount_canceled": 42.0,
      "base_discount_invoiced": 42.0,
      "base_discount_refunded": 42.0,
      "base_grand_total": 42.0,
      "base_discount_tax_compensation_amount": 42.0,
      "base_discount_tax_compensation_invoiced": 42.0,
      "base_discount_tax_compensation_refunded": 42.0,
      "base_shipping_amount": 42.0,
      "base_shipping_canceled": 42.0,
      "base_shipping_discount_amount": 42.0,
      "base_shipping_discount_tax_compensation_amnt": 42.0,
      "base_shipping_incl_tax": 42.0,
      "base_shipping_invoiced": 42.0,
      "base_shipping_refunded": 42.0,
      "base_shipping_tax_amount": 42.0,
      "base_shipping_tax_refunded": 42.0,
      "base_subtotal": 42.0,
      "base_subtotal_canceled": 42.0,
      "base_subtotal_incl_tax": 42.0,
      "base_subtotal_invoiced": 42.0,
      "base_subtotal_refunded": 42.0,
      "base_tax_amount": 42.0,
      "base_tax_canceled": 42.0,
      "base_tax_invoiced": 42.0,
      "base_tax_refunded": 42.0,
      "base_total_canceled": 42.0,
      "base_total_due": 42.0,
      "base_total_invoiced": 42.0,
      "base_total_invoiced_cost": 42.0,
      "base_total_offline_refunded": 42.0,
      "base_total_online_refunded": 42.0,
      "base_total_paid": 42.0,
      "base_total_qty_ordered": 42.0,
      "base_total_refunded": 42.0,
      "base_to_global_rate": 42.0,
      "base_to_order_rate": 42.0,
      "billing_address_id": 42,
      "can_ship_partially": 42,
      "can_ship_partially_item": 42,
      "coupon_code": "string",
      "created_at": "string",
      "customer_dob": "string",
      "customer_email": "string",
      "customer_firstname": "string",
      "customer_gender": 42,
      "customer_group_id": 42,
      "customer_id": 42,
      "customer_is_guest": 42,
      "customer_lastname": "string",
      "customer_middlename": "string",
      "customer_note": "string",
      "customer_note_notify": 42,
      "customer_prefix": "string",
      "customer_suffix": "string",
      "customer_taxvat": "string",
      "discount_amount": 42.0,
      "discount_canceled": 42.0,
      "discount_description": "string",
      "discount_invoiced": 42.0,
      "discount_refunded": 42.0,
      "edit_increment": 42,
      "email_sent": 42,
      "entity_id": 42,
      "ext_customer_id": "string",
      "ext_order_id": "string",
      "forced_shipment_with_invoice": 42,
      "global_currency_code": "string",
      "grand_total": 42.0,
      "discount_tax_compensation_amount": 42.0,
      "discount_tax_compensation_invoiced": 42.0,
      "discount_tax_compensation_refunded": 42.0,
      "hold_before_state": "string",
      "hold_before_status": "string",
      "increment_id": "string",
      "is_virtual": 42,
      "order_currency_code": "string",
      "original_increment_id": "string",
      "payment_authorization_amount": 42.0,
      "payment_auth_expiration": 42,
      "protect_code": "string",
      "quote_address_id": 42,
      "quote_id": 42,
      "relation_child_id": "string",
      "relation_child_real_id": "string",
      "relation_parent_id": "string",
      "relation_parent_real_id": "string",
      "remote_ip": "string",
      "shipping_amount": 42.0,
      "shipping_canceled": 42.0,
      "shipping_description": "string",
      "shipping_discount_amount": 42.0,
      "shipping_discount_tax_compensation_amount": 42.0,
      "shipping_incl_tax": 42.0,
      "shipping_invoiced": 42.0,
      "shipping_refunded": 42.0,
      "shipping_tax_amount": 42.0,
      "shipping_tax_refunded": 42.0,
      "state": "string",
      "status": "string",
      "store_currency_code": "string",
      "store_id": 42,
      "store_name": "string",
      "store_to_base_rate": 42.0,
      "store_to_order_rate": 42.0,
      "subtotal": 42.0,
      "subtotal_canceled": 42.0,
      "subtotal_incl_tax": 42.0,
      "subtotal_invoiced": 42.0,
      "subtotal_refunded": 42.0,
      "tax_amount": 42.0,
      "tax_canceled": 42.0,
      "tax_invoiced": 42.0,
      "tax_refunded": 42.0,
      "total_canceled": 42.0,
      "total_due": 42.0,
      "total_invoiced": 42.0,
      "total_item_count": 42,
      "total_offline_refunded": 42.0,
      "total_online_refunded": 42.0,
      "total_paid": 42.0,
      "total_qty_ordered": 42.0,
      "total_refunded": 42.0,
      "updated_at": "string",
      "weight": 42.0,
      "x_forwarded_for": "string",
      "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
          }
        }
      ],
      "billing_address": {
        "address_type": "string",
        "city": "string",
        "company": "string",
        "country_id": "string",
        "customer_address_id": 42,
        "customer_id": 42,
        "email": "string",
        "entity_id": 42,
        "fax": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "parent_id": 42,
        "postcode": "string",
        "prefix": "string",
        "region": "string",
        "region_code": "string",
        "region_id": 42,
        "street": [
          "string"
        ],
        "suffix": "string",
        "telephone": "string",
        "vat_id": "string",
        "vat_is_valid": 42,
        "vat_request_date": "string",
        "vat_request_id": "string",
        "vat_request_success": 42,
        "extension_attributes": {}
      },
      "payment": {
        "account_status": "string",
        "additional_data": "string",
        "additional_information": [
          "string"
        ],
        "address_status": "string",
        "amount_authorized": 42.0,
        "amount_canceled": 42.0,
        "amount_ordered": 42.0,
        "amount_paid": 42.0,
        "amount_refunded": 42.0,
        "anet_trans_method": "string",
        "base_amount_authorized": 42.0,
        "base_amount_canceled": 42.0,
        "base_amount_ordered": 42.0,
        "base_amount_paid": 42.0,
        "base_amount_paid_online": 42.0,
        "base_amount_refunded": 42.0,
        "base_amount_refunded_online": 42.0,
        "base_shipping_amount": 42.0,
        "base_shipping_captured": 42.0,
        "base_shipping_refunded": 42.0,
        "cc_approval": "string",
        "cc_avs_status": "string",
        "cc_cid_status": "string",
        "cc_debug_request_body": "string",
        "cc_debug_response_body": "string",
        "cc_debug_response_serialized": "string",
        "cc_exp_month": "string",
        "cc_exp_year": "string",
        "cc_last4": "string",
        "cc_number_enc": "string",
        "cc_owner": "string",
        "cc_secure_verify": "string",
        "cc_ss_issue": "string",
        "cc_ss_start_month": "string",
        "cc_ss_start_year": "string",
        "cc_status": "string",
        "cc_status_description": "string",
        "cc_trans_id": "string",
        "cc_type": "string",
        "echeck_account_name": "string",
        "echeck_account_type": "string",
        "echeck_bank_name": "string",
        "echeck_routing_number": "string",
        "echeck_type": "string",
        "entity_id": 42,
        "last_trans_id": "string",
        "method": "string",
        "parent_id": 42,
        "po_number": "string",
        "protection_eligibility": "string",
        "quote_payment_id": 42,
        "shipping_amount": 42.0,
        "shipping_captured": 42.0,
        "shipping_refunded": 42.0,
        "extension_attributes": {
          "notification_message": "string",
          "vault_payment_token": {
            "entity_id": 42,
            "customer_id": 42,
            "public_hash": "string",
            "payment_method_code": "string",
            "type": "string",
            "created_at": "string",
            "expires_at": "string",
            "gateway_token": "string",
            "token_details": "string",
            "is_active": true,
            "is_visible": true,
            "website_id": 42
          },
          "origin": "string"
        }
      },
      "status_histories": [
        {
          "comment": "string",
          "created_at": "string",
          "entity_id": 42,
          "entity_name": "string",
          "is_customer_notified": 42,
          "is_visible_on_front": 42,
          "parent_id": 42,
          "status": "string",
          "extension_attributes": {}
        }
      ],
      "extension_attributes": {
        "shipping_assignments": [
          {
            "shipping": {
              "address": {
                "address_type": "string",
                "city": "string",
                "company": "string",
                "country_id": "string",
                "customer_address_id": 42,
                "customer_id": 42,
                "email": "string",
                "entity_id": 42,
                "fax": "string",
                "firstname": "string",
                "lastname": "string",
                "middlename": "string",
                "parent_id": 42,
                "postcode": "string",
                "prefix": "string",
                "region": "string",
                "region_code": "string",
                "region_id": 42,
                "street": [
                  "string"
                ],
                "suffix": "string",
                "telephone": "string",
                "vat_id": "string",
                "vat_is_valid": 42,
                "vat_request_date": "string",
                "vat_request_id": "string",
                "vat_request_success": 42,
                "extension_attributes": {}
              },
              "method": "string",
              "total": {
                "base_shipping_amount": 42.0,
                "base_shipping_canceled": 42.0,
                "base_shipping_discount_amount": 42.0,
                "base_shipping_discount_tax_compensation_amnt": 42.0,
                "base_shipping_incl_tax": 42.0,
                "base_shipping_invoiced": 42.0,
                "base_shipping_refunded": 42.0,
                "base_shipping_tax_amount": 42.0,
                "base_shipping_tax_refunded": 42.0,
                "shipping_amount": 42.0,
                "shipping_canceled": 42.0,
                "shipping_discount_amount": 42.0,
                "shipping_discount_tax_compensation_amount": 42.0,
                "shipping_incl_tax": 42.0,
                "shipping_invoiced": 42.0,
                "shipping_refunded": 42.0,
                "shipping_tax_amount": 42.0,
                "shipping_tax_refunded": 42.0,
                "extension_attributes": {}
              },
              "extension_attributes": {}
            },
            "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
                }
              }
            ],
            "stock_id": 42,
            "extension_attributes": {}
          }
        ],
        "payment_additional_info": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "company_order_attributes": {
          "order_id": 42,
          "company_id": 42,
          "company_name": "string",
          "extension_attributes": {}
        },
        "applied_taxes": [
          {
            "code": "string",
            "title": "string",
            "percent": 42.0,
            "amount": 42.0,
            "base_amount": 42.0,
            "extension_attributes": {
              "rates": [
                {
                  "code": "string",
                  "title": "string",
                  "percent": 42.0,
                  "extension_attributes": {}
                }
              ]
            }
          }
        ],
        "item_applied_taxes": [
          {
            "type": "string",
            "item_id": 42,
            "associated_item_id": 42,
            "applied_taxes": [
              {
                "code": "string",
                "title": "string",
                "percent": 42.0,
                "amount": 42.0,
                "base_amount": 42.0,
                "extension_attributes": {
                  "rates": [
                    {
                      "code": "string",
                      "title": "string",
                      "percent": 42.0,
                      "extension_attributes": {}
                    }
                  ]
                }
              }
            ],
            "extension_attributes": {}
          }
        ],
        "converting_from_quote": true,
        "taxes": [
          {
            "tax_id": 42,
            "order_id": 42,
            "code": "string",
            "title": "string",
            "percent": 42.0,
            "amount": 42.0,
            "base_amount": 42.0,
            "base_real_amount": 42.0,
            "priority": 42,
            "position": 42,
            "process": 42,
            "extension_attributes": {}
          }
        ],
        "additional_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": {}
          }
        ],
        "base_customer_balance_amount": 42.0,
        "customer_balance_amount": 42.0,
        "base_customer_balance_invoiced": 42.0,
        "customer_balance_invoiced": 42.0,
        "base_customer_balance_refunded": 42.0,
        "customer_balance_refunded": 42.0,
        "base_customer_balance_total_refunded": 42.0,
        "customer_balance_total_refunded": 42.0,
        "gift_cards": [
          {
            "id": 42,
            "code": "string",
            "amount": 42.0,
            "base_amount": 42.0
          }
        ],
        "base_gift_cards_amount": 42.0,
        "gift_cards_amount": 42.0,
        "base_gift_cards_invoiced": 42.0,
        "gift_cards_invoiced": 42.0,
        "base_gift_cards_refunded": 42.0,
        "gift_cards_refunded": 42.0,
        "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_allow_gift_receipt": "string",
        "gw_add_card": "string",
        "gw_base_price": "string",
        "gw_price": "string",
        "gw_items_base_price": "string",
        "gw_items_price": "string",
        "gw_card_base_price": "string",
        "gw_card_price": "string",
        "gw_base_tax_amount": "string",
        "gw_tax_amount": "string",
        "gw_items_base_tax_amount": "string",
        "gw_items_tax_amount": "string",
        "gw_card_base_tax_amount": "string",
        "gw_card_tax_amount": "string",
        "gw_base_price_incl_tax": "string",
        "gw_price_incl_tax": "string",
        "gw_items_base_price_incl_tax": "string",
        "gw_items_price_incl_tax": "string",
        "gw_card_base_price_incl_tax": "string",
        "gw_card_price_incl_tax": "string",
        "gw_base_price_invoiced": "string",
        "gw_price_invoiced": "string",
        "gw_items_base_price_invoiced": "string",
        "gw_items_price_invoiced": "string",
        "gw_card_base_price_invoiced": "string",
        "gw_card_price_invoiced": "string",
        "gw_base_tax_amount_invoiced": "string",
        "gw_tax_amount_invoiced": "string",
        "gw_items_base_tax_invoiced": "string",
        "gw_items_tax_invoiced": "string",
        "gw_card_base_tax_invoiced": "string",
        "gw_card_tax_invoiced": "string",
        "gw_base_price_refunded": "string",
        "gw_price_refunded": "string",
        "gw_items_base_price_refunded": "string",
        "gw_items_price_refunded": "string",
        "gw_card_base_price_refunded": "string",
        "gw_card_price_refunded": "string",
        "gw_base_tax_amount_refunded": "string",
        "gw_tax_amount_refunded": "string",
        "gw_items_base_tax_refunded": "string",
        "gw_items_tax_refunded": "string",
        "gw_card_base_tax_refunded": "string",
        "gw_card_tax_refunded": "string",
        "pickup_location_code": "string",
        "notification_sent": 42,
        "send_notification": 42,
        "coupon_codes": [
          "string"
        ],
        "coupon_discounts": [
          "string"
        ],
        "reward_points_balance": 42,
        "reward_currency_amount": 42.0,
        "base_reward_currency_amount": 42.0,
        "dhlparcel_shipping_servicepoint_id": "string",
        "dhlparcel_shipping_checkout_options": "string",
        "dhlparcel_shipping_connectors_date_preference": "string",
        "origin": "string",
        "shipping_address_firstname": "string",
        "shipping_address_lastname": "string",
        "rma_id": 42,
        "is_pickup_point": true,
        "pickup_point": {
          "pick_up_point_id": "string",
          "carrier_method": "string",
          "name": "string",
          "address_lines": [
            "string"
          ],
          "city": "string",
          "state": "string",
          "country": "string",
          "postal": "string",
          "telephone": "string",
          "fax": "string"
        },
        "company_id": 42
      }
    }
  ],
  "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"
}