Skip to main content
GET
{micro_service_base_url}
/
orders
/
{order_id}
/
order-items
/
{order_item_id}
{
  "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>",
  "store_item_size": "<string>",
  "item": {
    "images": [
      {}
    ],
    "name": "<string>",
    "description": "<string>",
    "upc": "<string>",
    "categories": [
      {}
    ],
    "subCategories": [
      {}
    ],
    "storeItems": [
      {}
    ]
  },
  "modifications": [
    {
      "modifier_id": "<string>",
      "modifier_name": "<string>",
      "modifier_value": "<string>",
      "additional_cost": "<string>"
    }
  ],
  "fulfillment_status": "<string>",
  "preparation_notes": "<string>"
}
This endpoint provides comprehensive details for a specific item within an order. Use this when you need detailed information about a particular order item for customer service, inventory tracking, or fulfillment purposes.
This endpoint returns complete item details including product information, pricing breakdown, modifications, and fulfillment status.

​
Path Parameters

​
order_id
string
required
The unique identifier of the order containing the item
​
order_item_id
string
required
The unique identifier of the specific order item to retrieve

​
Response

​
id
string
Unique order item identifier
​
quantity
integer
Quantity of this item ordered
​
special_instructions
string
Item-specific preparation instructions
​
store_item_price
string
Price per unit for this item
​
store_item_total_price
string
Total price for this item (quantity × unit price)
​
store_item_name
string
Product name as displayed in store
​
store_item_description
string
Product description
​
store_item_category
string
Product category classification
​
store_item_size
string
Item size specification (if applicable)
​
item
object
Complete product information
​
modifications
array
Item modifications or customizations applied
​
fulfillment_status
string
Current fulfillment status for this specific item
​
preparation_notes
string
Internal notes for item preparation

​
Response Example

{
  "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",
  "store_item_size": "1 count",
  "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": [
    {
      "modifier_id": "mod_size_large",
      "modifier_name": "Size",
      "modifier_value": "Large",
      "additional_cost": "0.50"
    }
  ],
  "fulfillment_status": "pending",
  "preparation_notes": "Handle with care - fragile packaging"
}
Item Status: The fulfillment_status field shows the specific status of this item within the order, which may differ from the overall order status.
Image Handling: Product images are returned as URLs. Always check if the image URL is valid before displaying to avoid broken image links.

​
Error Responses

Order Item Not Found
{
  "error": "Order item not found",
  "order_item_id": "invalid-item-id",
  "message": "The specified order item does not exist in this order"
}
Order Not Found
{
  "error": "Order not found",
  "order_id": "invalid-order-id",
  "message": "The specified order does not exist"
}
Access Denied
{
  "error": "Access denied",
  "message": "You do not have permission to view this order item"
}

​
Use Cases

Customer Service
  • Answer customer questions about specific items
  • Check item-specific special instructions
  • Verify product details and pricing
Fulfillment Management
  • Check item preparation requirements
  • Review modification details
  • Track individual item status
Inventory Tracking
  • Verify product information accuracy
  • Check UPC codes for scanning
  • Monitor item-level demand
Quality Control
  • Review preparation notes
  • Check for special handling requirements
  • Verify modifications were applied correctly
Performance: Use this endpoint sparingly for individual item lookups. For bulk item information, use the “Get All Order Items” endpoint instead.
⌘I