Items
Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
Query parameters
searchCriteria[filterGroups][0][filters][0][field]stringOptionalExample:
Field
<string>searchCriteria[filterGroups][0][filters][0][value]stringOptionalExample:
Value
<string>searchCriteria[filterGroups][0][filters][0][conditionType]stringOptionalExample:
Condition type
<string>searchCriteria[sortOrders][0][field]stringOptionalExample:
Sorting field.
<string>searchCriteria[sortOrders][0][direction]stringOptionalExample:
Sorting direction.
<string>searchCriteria[pageSize]stringOptionalExample:
Page size.
<integer>searchCriteria[currentPage]stringOptionalExample:
Current page.
<integer>Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/orders/items HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
"items": [
{
"sku": "adipisicing in laboris nostrud",
"additional_data": "officia",
"amount_refunded": -21594016.79025033,
"applied_rule_ids": "ad",
"base_amount_refunded": 18640547.931361377,
"base_cost": 25993738.598692223,
"base_discount_amount": 4325462.903112069,
"base_discount_invoiced": 71696039.76761776,
"base_discount_refunded": 49200314.657438904,
"base_discount_tax_compensation_amount": 17863788.39775406,
"base_discount_tax_compensation_invoiced": 20751886.012449637,
"base_discount_tax_compensation_refunded": 89567103.7359969,
"base_original_price": 7841874.8956528455,
"base_price": -93855378.83018,
"base_price_incl_tax": -52284311.750744015,
"base_row_invoiced": 85361646.32119983,
"base_row_total": -48013188.55655592,
"base_row_total_incl_tax": -16913960.18653433,
"base_tax_amount": -32977512.51852592,
"base_tax_before_discount": 74055214.59294415,
"base_tax_invoiced": 2550674.9964678437,
"base_tax_refunded": -86256187.3484959,
"base_weee_tax_applied_amount": 86755359.27632132,
"base_weee_tax_applied_row_amnt": 94252413.24319863,
"base_weee_tax_disposition": 82946873.5447258,
"base_weee_tax_row_disposition": 46126933.980847836,
"created_at": "sint fugiat ut quis",
"description": "cupidatat id u",
"discount_amount": -35087474.57759172,
"discount_invoiced": -89591923.40040447,
"discount_percent": -32966877.11534352,
"discount_refunded": 95657836.7426947,
"event_id": -4297650,
"ext_order_item_id": "anim ut",
"free_shipping": 47122801,
"gw_base_price": -36253733.917483896,
"gw_base_price_invoiced": 55250719.46535003,
"gw_base_price_refunded": 26985080.105219513,
"gw_base_tax_amount": -11174976.705926105,
"gw_base_tax_amount_invoiced": -23196080.98397632,
"gw_base_tax_amount_refunded": 40462200.88710165,
"gw_id": 9842932,
"gw_price": -50045114.61527494,
"gw_price_invoiced": -62238741.4209082,
"gw_price_refunded": -77906789.18251759,
"gw_tax_amount": -66080040.30534121,
"gw_tax_amount_invoiced": 79131379.21950763,
"gw_tax_amount_refunded": -40684358.293210156,
"discount_tax_compensation_amount": -56101265.39553675,
"discount_tax_compensation_canceled": 75872895.01041594,
"discount_tax_compensation_invoiced": 89057291.17603731,
"discount_tax_compensation_refunded": 92914452.3582091,
"is_qty_decimal": -3997324,
"is_virtual": -1749783,
"item_id": 66791632,
"locked_do_invoice": 72339876,
"locked_do_ship": -6490457,
"name": "velit",
"no_discount": 77495441,
"order_id": -4617652,
"original_price": 8037348.399131224,
"parent_item_id": 75205222,
"price": -72972749.85424705,
"price_incl_tax": -61091271.13910953,
"product_id": 58186777,
"product_type": "dolore dolore",
"qty_backordered": -75125292.24631055,
"qty_canceled": 44972742.49833363,
"qty_invoiced": -60600765.36485095,
"qty_ordered": 22326873.555587083,
"qty_refunded": 13702163.560541525,
"qty_returned": 3690087.5261920393,
"qty_shipped": -33383155.707071222,
"quote_item_id": -12247040,
"row_invoiced": -89371900.49086694,
"row_total": -27373917.501957163,
"row_total_incl_tax": 14952059.326234847,
"row_weight": -77131662.84198642,
"store_id": 54141138,
"tax_amount": -99041582.18448772,
"tax_before_discount": 60572754.168403745,
"tax_canceled": 58904936.08392745,
"tax_invoiced": -92706685.92636496,
"tax_percent": -2899118.77703996,
"tax_refunded": -69874545.33818544,
"updated_at": "sint est commodo",
"weee_tax_applied": "proident qui ex aute",
"weee_tax_applied_amount": -64469843.40848729,
"weee_tax_applied_row_amount": 12996427.955818042,
"weee_tax_disposition": 84257422.64104685,
"weee_tax_row_disposition": -94529709.20967597,
"weight": 53520701.86621165,
"parent_item": {
"value": "<Circular reference to #/components/schemas/sales-data-order-item-interface detected>"
},
"product_option": {
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"extension_attributes": {
"gift_message": {
"sender": "<string>",
"recipient": "<string>",
"message": "<string>",
"gift_message_id": "<integer>",
"customer_id": "<integer>",
"extension_attributes": {
"entity_id": "id ipsum fugiat",
"entity_type": "sint Duis incididunt exercitation"
}
},
"vertex_tax_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"invoice_text_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"tax_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
]
}
},
{
"sku": "ea nostrud exercitation",
"additional_data": "aliqua pariatur cupidatat dolore ex",
"amount_refunded": -64263591.783361785,
"applied_rule_ids": "Duis eu dolor in id",
"base_amount_refunded": -78333685.56298196,
"base_cost": -63403022.67530431,
"base_discount_amount": 96041505.20304611,
"base_discount_invoiced": -93620979.03570375,
"base_discount_refunded": 23811663.986812487,
"base_discount_tax_compensation_amount": 77849406.13680243,
"base_discount_tax_compensation_invoiced": -4050989.3191774935,
"base_discount_tax_compensation_refunded": -75293640.04410893,
"base_original_price": 3268767.274052337,
"base_price": 50919777.9638471,
"base_price_incl_tax": -59041148.22587054,
"base_row_invoiced": -47125887.18620889,
"base_row_total": 80784582.79425952,
"base_row_total_incl_tax": 16288099.010456845,
"base_tax_amount": 1094845.4698948264,
"base_tax_before_discount": 28284086.337395653,
"base_tax_invoiced": -58387324.58662657,
"base_tax_refunded": -72172589.51689969,
"base_weee_tax_applied_amount": 41158281.26281506,
"base_weee_tax_applied_row_amnt": 80143487.85536164,
"base_weee_tax_disposition": 78035637.7838246,
"base_weee_tax_row_disposition": 8017710.547080353,
"created_at": "quis Ut mollit sint",
"description": "et Excepteur",
"discount_amount": 89694359.6430225,
"discount_invoiced": -36618442.30937299,
"discount_percent": -37699209.08797699,
"discount_refunded": -3260477.635181263,
"event_id": 19640089,
"ext_order_item_id": "exercitation enim",
"free_shipping": 6281976,
"gw_base_price": 33209336.22463973,
"gw_base_price_invoiced": 49759839.411471784,
"gw_base_price_refunded": -69828174.87759885,
"gw_base_tax_amount": -45496718.3314523,
"gw_base_tax_amount_invoiced": 11913091.518474549,
"gw_base_tax_amount_refunded": 36997289.069224626,
"gw_id": 24857076,
"gw_price": 34676661.98856664,
"gw_price_invoiced": -62233881.80781164,
"gw_price_refunded": 21490953.551762,
"gw_tax_amount": 20616974.20769933,
"gw_tax_amount_invoiced": -29696486.270203292,
"gw_tax_amount_refunded": -17266905.491665825,
"discount_tax_compensation_amount": 78689206.7595138,
"discount_tax_compensation_canceled": -85746693.67430255,
"discount_tax_compensation_invoiced": 70089475.9294262,
"discount_tax_compensation_refunded": 20291514.02868083,
"is_qty_decimal": 93645905,
"is_virtual": -19584708,
"item_id": -34576607,
"locked_do_invoice": -20787770,
"locked_do_ship": 70660451,
"name": "reprehenderit nisi eiusmod ut",
"no_discount": -6555301,
"order_id": 43981510,
"original_price": -13027532.377459794,
"parent_item_id": 15675278,
"price": 79517613.48816371,
"price_incl_tax": -1479407.133797884,
"product_id": -92545361,
"product_type": "cillum in",
"qty_backordered": -29627.58747689426,
"qty_canceled": -32147694.36569047,
"qty_invoiced": 94063116.88608748,
"qty_ordered": 23871351.393690035,
"qty_refunded": -50624053.42556531,
"qty_returned": -58092863.786854565,
"qty_shipped": 43964244.24526724,
"quote_item_id": -45927819,
"row_invoiced": 31971664.19057642,
"row_total": 53631029.5928323,
"row_total_incl_tax": 44087907.963770956,
"row_weight": 83138233.45536005,
"store_id": 92233449,
"tax_amount": -58299919.49876328,
"tax_before_discount": 85189011.0039219,
"tax_canceled": 62890537.30421266,
"tax_invoiced": -79632421.59329766,
"tax_percent": -33881864.27489459,
"tax_refunded": -73319769.74374577,
"updated_at": "ea ad",
"weee_tax_applied": "nisi",
"weee_tax_applied_amount": 54537252.40698925,
"weee_tax_applied_row_amount": -53635100.14925126,
"weee_tax_disposition": 96736080.49148998,
"weee_tax_row_disposition": -48927867.695656605,
"weight": 9580026.626381993,
"parent_item": {
"value": "<Circular reference to #/components/schemas/sales-data-order-item-interface detected>"
},
"product_option": {
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"extension_attributes": {
"gift_message": {
"sender": "<string>",
"recipient": "<string>",
"message": "<string>",
"gift_message_id": "<integer>",
"customer_id": "<integer>",
"extension_attributes": {
"entity_id": "ad aute ea sint",
"entity_type": "ut sint magna incididunt qui"
}
},
"vertex_tax_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"invoice_text_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"tax_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
]
}
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "et culpa nostr",
"value": "fugiat ut ad eu es",
"condition_type": "ipsum pariatur Duis in"
},
{
"field": "pariatur Lorem",
"value": "anim culpa esse",
"condition_type": "veniam c"
}
]
},
{
"filters": [
{
"field": "in ea deserun",
"value": "ut",
"condition_type": "esse"
},
{
"field": "ut aliqua",
"value": "aliqua Lorem amet in",
"condition_type": "exerc"
}
]
}
],
"sort_orders": [
{
"field": "veniam",
"direction": "in reprehenderit laboris"
},
{
"field": "Excepteur cillum officia",
"direction": "deserunt sint"
}
],
"page_size": -30389778,
"current_page": 47227985
},
"total_count": 5098225
}Loads a specified order item.
Path parameters
idstringRequiredExample:
(Required) The order item ID.
<integer>Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/orders/items/{id} HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
"sku": "labore pariatur rep",
"additional_data": "in elit ni",
"amount_refunded": -74188298.37316895,
"applied_rule_ids": "eiusmod",
"base_amount_refunded": 12516521.755822435,
"base_cost": -16208112.138153955,
"base_discount_amount": 21419931.92091976,
"base_discount_invoiced": 53657914.14503813,
"base_discount_refunded": 58828254.43492213,
"base_discount_tax_compensation_amount": -3582079.430090174,
"base_discount_tax_compensation_invoiced": -20377318.51780346,
"base_discount_tax_compensation_refunded": 59767083.88800165,
"base_original_price": 78259978.23793972,
"base_price": -62510370.694592156,
"base_price_incl_tax": 13852953.011473,
"base_row_invoiced": 18150993.754040986,
"base_row_total": 18685821.455758184,
"base_row_total_incl_tax": 66948169.3534061,
"base_tax_amount": 61631821.47367877,
"base_tax_before_discount": -2299739.996065676,
"base_tax_invoiced": 58873157.758954555,
"base_tax_refunded": 10269310.17248556,
"base_weee_tax_applied_amount": -66410672.57807709,
"base_weee_tax_applied_row_amnt": -19662540.39224577,
"base_weee_tax_disposition": -3125351.076683283,
"base_weee_tax_row_disposition": -53153333.44673374,
"created_at": "in ",
"description": "in",
"discount_amount": -57879468.65752795,
"discount_invoiced": -35508288.47599137,
"discount_percent": 31994053.95697035,
"discount_refunded": -98861556.95875342,
"event_id": -93006585,
"ext_order_item_id": "nostrud sit amet esse",
"free_shipping": -79819454,
"gw_base_price": -8500742.23230952,
"gw_base_price_invoiced": -53630665.612212926,
"gw_base_price_refunded": 2309163.672643289,
"gw_base_tax_amount": -231529.99197670817,
"gw_base_tax_amount_invoiced": -9039435.785540566,
"gw_base_tax_amount_refunded": -47089609.327760495,
"gw_id": -25314084,
"gw_price": -61596131.61796264,
"gw_price_invoiced": -94608416.80943246,
"gw_price_refunded": -36110223.75408877,
"gw_tax_amount": 46714075.96973789,
"gw_tax_amount_invoiced": -77031206.83683227,
"gw_tax_amount_refunded": 79476118.77609336,
"discount_tax_compensation_amount": 19702457.780582666,
"discount_tax_compensation_canceled": 55132349.022476435,
"discount_tax_compensation_invoiced": 1924401.7445737273,
"discount_tax_compensation_refunded": -7606214.998490706,
"is_qty_decimal": -23134527,
"is_virtual": -18784431,
"item_id": -3330171,
"locked_do_invoice": -39334830,
"locked_do_ship": 30931734,
"name": "eu do",
"no_discount": -42897865,
"order_id": 57773676,
"original_price": -61027534.82254379,
"parent_item_id": 59883787,
"price": 40707687.77835271,
"price_incl_tax": 68742207.61717647,
"product_id": -76298322,
"product_type": "dolore anim Duis",
"qty_backordered": -44510861.24424681,
"qty_canceled": 97682459.48810357,
"qty_invoiced": -79959443.18802634,
"qty_ordered": 26821389.733591825,
"qty_refunded": -38777379.54845246,
"qty_returned": -79650194.3182776,
"qty_shipped": -18787520.22335574,
"quote_item_id": -73464220,
"row_invoiced": -99884349.51939783,
"row_total": 59474022.07256234,
"row_total_incl_tax": 45442623.10731831,
"row_weight": -85364035.61654708,
"store_id": 62403724,
"tax_amount": 17094124.527388304,
"tax_before_discount": -39048792.870286465,
"tax_canceled": -98529476.63438818,
"tax_invoiced": -28370148.60036087,
"tax_percent": 52302549.255197436,
"tax_refunded": -24989590.255389288,
"updated_at": "lab",
"weee_tax_applied": "incididunt exercitation",
"weee_tax_applied_amount": 52576260.8244912,
"weee_tax_applied_row_amount": -77632395.11484015,
"weee_tax_disposition": 58114671.77740049,
"weee_tax_row_disposition": 73194885.13895583,
"weight": -49436525.81550344,
"parent_item": {
"sku": "amet consequat ullamco ",
"additional_data": "aute laborum proident",
"amount_refunded": -88436303.8955462,
"applied_rule_ids": "dolor Excepteur",
"base_amount_refunded": -93248454.41951029,
"base_cost": 60239477.79864353,
"base_discount_amount": -405764.8276908994,
"base_discount_invoiced": -80804621.395915,
"base_discount_refunded": 99964307.23616815,
"base_discount_tax_compensation_amount": -64162392.49462463,
"base_discount_tax_compensation_invoiced": -99271259.96553232,
"base_discount_tax_compensation_refunded": -37964726.824443676,
"base_original_price": 63597438.32779786,
"base_price": 58051754.410453916,
"base_price_incl_tax": 63089865.39880741,
"base_row_invoiced": -51438876.09201614,
"base_row_total": 48239190.91763526,
"base_row_total_incl_tax": -52293905.323813304,
"base_tax_amount": 53766378.14528471,
"base_tax_before_discount": 3744350.164940521,
"base_tax_invoiced": -64708821.475898005,
"base_tax_refunded": 92004922.64557925,
"base_weee_tax_applied_amount": 36729114.828498185,
"base_weee_tax_applied_row_amnt": -62020446.06681598,
"base_weee_tax_disposition": -74435151.73913866,
"base_weee_tax_row_disposition": -37965291.13116538,
"created_at": "amet deserunt aliquip voluptate",
"description": "veli",
"discount_amount": -47431696.09521809,
"discount_invoiced": -14621998.771181583,
"discount_percent": 43659616.72081378,
"discount_refunded": -25558467.00589508,
"event_id": -57099882,
"ext_order_item_id": "mollit anim culpa",
"free_shipping": 15125873,
"gw_base_price": 46699271.685411334,
"gw_base_price_invoiced": 58200101.420832425,
"gw_base_price_refunded": 89108837.65309271,
"gw_base_tax_amount": -52457078.40679392,
"gw_base_tax_amount_invoiced": -93595867.62945043,
"gw_base_tax_amount_refunded": 50739667.732013464,
"gw_id": -16789888,
"gw_price": -11318098.011143014,
"gw_price_invoiced": 57830928.1063838,
"gw_price_refunded": -45018973.97222412,
"gw_tax_amount": -58410057.63642282,
"gw_tax_amount_invoiced": -40274079.181417525,
"gw_tax_amount_refunded": -24321713.42216049,
"discount_tax_compensation_amount": 68188610.8612836,
"discount_tax_compensation_canceled": -77662152.23264456,
"discount_tax_compensation_invoiced": 57458758.57476032,
"discount_tax_compensation_refunded": 79469634.75368252,
"is_qty_decimal": 61956921,
"is_virtual": 22515670,
"item_id": -86429931,
"locked_do_invoice": 2790560,
"locked_do_ship": -187837,
"name": "al",
"no_discount": 3274644,
"order_id": 54827316,
"original_price": -90237408.5551362,
"parent_item_id": -60073567,
"price": 63591451.10321677,
"price_incl_tax": -80488971.04321888,
"product_id": 48675024,
"product_type": "sit E",
"qty_backordered": -82382814.79134999,
"qty_canceled": -9294643.383500695,
"qty_invoiced": -2524562.8846469074,
"qty_ordered": 98177803.86310107,
"qty_refunded": -83851976.46989253,
"qty_returned": -45011676.45076487,
"qty_shipped": 17153391.387742907,
"quote_item_id": 15914929,
"row_invoiced": -83147046.06592005,
"row_total": 80602112.44867301,
"row_total_incl_tax": -95619246.06576952,
"row_weight": 471692.4953636974,
"store_id": 62934573,
"tax_amount": -88244428.89877315,
"tax_before_discount": -72890733.58066167,
"tax_canceled": -12153828.340854302,
"tax_invoiced": -83746221.41766745,
"tax_percent": -81478878.25334777,
"tax_refunded": -96773721.83651336,
"updated_at": "incididunt veniam Duis sunt",
"weee_tax_applied": "nulla ea",
"weee_tax_applied_amount": 1512230.8186219484,
"weee_tax_applied_row_amount": 50539789.33335093,
"weee_tax_disposition": 96408996.32828388,
"weee_tax_row_disposition": -81086078.90955994,
"weight": 53821133.51098478,
"parent_item": {
"value": "<Circular reference to #/components/schemas/sales-data-order-item-interface detected>"
},
"product_option": {
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"extension_attributes": {
"gift_message": {
"sender": "<string>",
"recipient": "<string>",
"message": "<string>",
"gift_message_id": "<integer>",
"customer_id": "<integer>",
"extension_attributes": {
"entity_id": "commodo voluptate est",
"entity_type": "voluptate"
}
},
"vertex_tax_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"invoice_text_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"tax_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
]
}
},
"product_option": {
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"extension_attributes": {
"gift_message": {
"sender": "<string>",
"recipient": "<string>",
"message": "<string>",
"gift_message_id": "<integer>",
"customer_id": "<integer>",
"extension_attributes": {
"entity_id": "commodo",
"entity_type": "nulla ad aliquip quis consectetur"
}
},
"vertex_tax_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"invoice_text_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"tax_codes": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
]
}
}