GET
{micro_service_base_url}
/
orders
/
{order_id}
/
order-items
{
  "order_id": "<string>",
  "total_items": 123,
  "items": [
    {
      "id": "<string>",
      "quantity": 123,
      "special_instructions": "<string>",
      "store_item_price": "<string>",
      "store_item_total_price": "<string>",
      "store_item_name": "<string>",
      "store_item_description": "<string>",
      "store_item_category": "<string>",
      "fulfillment_status": "<string>",
      "item": {},
      "modifications": [
        {}
      ]
    }
  ],
  "order_summary": {
    "total_quantity": 123,
    "subtotal": "<string>",
    "items_by_category": {},
    "items_by_status": {}
  }
}
This endpoint returns a comprehensive list of all items within an order. It’s ideal for order fulfillment, kitchen display systems, packing lists, and complete order review.
This endpoint provides complete item details for all items in an order, making it efficient for bulk operations and comprehensive order management.

Path Parameters

order_id
string
required
The unique identifier of the order whose items you want to retrieve

Query Parameters

include_modifications
boolean
default:"true"
Whether to include detailed modification information for each item
status_filter
string
Filter items by fulfillment status: “pending”, “preparing”, “ready”, “completed”
category_filter
string
Filter items by product category

Response

order_id
string
The order identifier these items belong to
total_items
integer
Total number of items in the order
items
array
Array of all order items with complete details
order_summary
object
Summary information for the complete order

Response Example

{
  "order_id": "35d18f08-6d54-421d-9476-8cef629111bc",
  "total_items": 2,
  "items": [
    {
      "id": "7fbe2819-5bc6-4340-8dfe-a5605272a32b",
      "quantity": 1,
      "special_instructions": "Cancel this order if this item is not available.",
      "store_item_price": "1.00",
      "store_item_total_price": "1.00",
      "store_item_name": "Jumbo Ring Pop - 1",
      "store_item_description": "Jumbo Ring Pop",
      "store_item_category": "Others",
      "fulfillment_status": "pending",
      "item": {
        "images": [
          "https://example.com/product-image.jpg"
        ],
        "name": "Jumbo Ring Pop",
        "description": "Jumbo Ring Pop",
        "upc": "4111626331",
        "categories": [
          {
            "id": "12bd6794-a17a-48a2-9a14-64c44a20c232",
            "name": "Others"
          }
        ],
        "subCategories": [],
        "storeItems": [
          {
            "id": "b7e9d9a6-2e3e-451a-ada9-6c001b17eaa5",
            "price": "10",
            "external_id": null,
            "location": null,
            "name": "Jumbo Ring Pop - 1",
            "description": null,
            "categories": [
              {
                "id": "12bd6794-a17a-48a2-9a14-64c44a20c232",
                "name": "Others"
              }
            ],
            "subCategories": []
          }
        ]
      },
      "modifications": []
    },
    {
      "id": "651daec0-c721-4399-82c8-2ac6afcc1160",
      "quantity": 4,
      "special_instructions": "Cancel this order if this item is not available.",
      "store_item_price": "10.00",
      "store_item_total_price": "40.00",
      "store_item_name": "test new item 1",
      "store_item_description": "",
      "store_item_category": "Baby",
      "fulfillment_status": "preparing",
      "item": {
        "images": null,
        "name": "test new item 1",
        "description": "",
        "upc": null,
        "categories": [
          {
            "id": "cef965f2-5a5a-4a30-b166-1350b4c3ff55",
            "name": "Baby"
          }
        ],
        "subCategories": [
          {
            "id": "4a525cdb-2c2d-4d23-8764-d2c9f3c14142",
            "name": "For Mom"
          }
        ],
        "storeItems": [
          {
            "id": "cf61e0c0-bff4-42dd-8273-1cbf4f8f5b42",
            "price": "10.00",
            "external_id": null,
            "location": null,
            "name": "test new item 1",
            "description": null,
            "categories": [
              {
                "id": "3c185006-271c-4d1e-903f-de21ec3b4234",
                "name": "loo"
              }
            ],
            "subCategories": []
          }
        ]
      },
      "modifications": []
    }
  ],
  "order_summary": {
    "total_quantity": 5,
    "subtotal": "41.00",
    "items_by_category": {
      "Others": 1,
      "Baby": 1
    },
    "items_by_status": {
      "pending": 1,
      "preparing": 1
    }
  }
}
Performance Optimization: When you only need basic item information, set include_modifications=false to reduce response size and improve performance.
Kitchen Display: Use status_filter=pending to show only items that need preparation, perfect for kitchen display systems.

Use Cases

Error Responses

Large Orders: For orders with many items, consider using pagination or filters to manage response sizes and improve performance.