v1

latestOpenAPI 3.1.1Apache 2.02026-07-26774088.4 KB
Orders

Order item details

Shows details of an order item

Order items represent individual products or offers within an order and contain:

  • Product/offer information
  • Pricing details
  • Quantity information
  • Fulfillment status

Order Item Attributes

  • quantity (integer) - Number of items purchased
  • currency_code (string) - The ISO currency code for the item
  • item_type (string) - Type of item (e.g., "Offer")
  • item_id (integer) - ID of the associated item
  • title (string) - Title of the item
  • total_price_in_cents (integer) - Total price for this line item
  • subtotal_in_cents (integer) - Subtotal before taxes and discounts
  • sales_tax_amount_in_cents (integer) - Sales tax amount for this item
  • discount_amount_in_cents (integer) - Discount amount for this item
  • fulfilled_at (string) - Timestamp when the item was fulfilled
  • created_at (string) - Timestamp when the order item was created

Include Related Resources

Use the include parameter to load related resources:

Include order

  • GET /v1/order_items/123?include=order
get/v1/order_items/{id}

Path parameters

idstring required

Query parameters

includestring

Load the related resources, for example ?include=order

fields[order_items]string

Partial attributes as specified, e.g. fields[order_items]=quantity,title,total_price_in_cents

Response

Success, shows details of an order item