v1

latestOpenAPI 3.1.1Apache 2.02026-07-26774088.4 KB
Orders

Order details

Shows details of an order

Orders represent completed purchase transactions and contain:

  • Order items (products/offers purchased)
  • Payment information
  • Customer information
  • Fulfillment status

Order Attributes

  • order_number (integer) - A unique identifier for the order within the site
  • currency_code (string) - The ISO currency code for the order (e.g., "USD")
  • total_price_in_cents (integer) - Total price including taxes and discounts
  • subtotal_in_cents (integer) - Subtotal before taxes and discounts
  • sales_tax_amount_in_cents (integer) - Total sales tax amount
  • discount_amount_in_cents (integer) - Total discount amount
  • fulfilled_at (string) - Timestamp when the order was fulfilled
  • created_at (string) - Timestamp when the order was created

Include Related Resources

Use the include parameter to load related resources:

Include order items, customer

  • GET /v1/orders/123?include=order_items,customer
get/v1/orders/{id}

Path parameters

idstring required

Query parameters

includestring

Load the related resources, for example ?include=order_items,customer,site

fields[orders]string

Partial attributes as specified, e.g. fields[orders]=order_number,total_price_in_cents

Response

Success, shows details of an order