List all orders for an app

List all orders for the app with filtering and pagination (max 50 per page). Authenticated via service token.

GET/api/v1/{app_id}/lookup/orders

API: Auth
OpenAPI: auth-api
Updated: Apr 26, 2026

auth-api:GET:/api/v1/{app_id}/lookup/orders

List all orders for the app with filtering and pagination (max 50 per page). Authenticated via service token.

API ownership

API family: Auth API
Best for: Customer identity, session, token, cart, and wishlist flows.
Do not use from: Merchant admin data syncs or public catalog rendering.
Guide route: /apis/auth/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: GET
Path: /api/v1/\{app_id\}/lookup/orders
Summary: List all orders for an app
Description: List all orders for the app with filtering and pagination (max 50 per page). Authenticated via service token.
OpenAPI contract: auth-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters8 parameters

Name	In	Required	Type	Description
app_id	path	Yes	string	UUID of the app
limit	query	No	integer	Limit for pagination (default: 50, max: 50)
page	query	No	integer	Page number for pagination (default: 1)
email	query	No	string	Filter by customer email (billing or shipping address)
reference	query	No	string	Filter by order reference
product_sku	query	No	string	Filter by product SKU (product_number) in order lines
variant_sku	query	No	string	Filter by variant SKU (variant_number) in order lines
created_after	query	No	string	Filter orders created after this timestamp (RFC3339)

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses3 statuses

Status	Description	Content
200	OK	application/json (object)
400	Invalid request	application/json (object)
500	Internal server error	application/json (object)

200 - object

List All Orders

Property	Type	Required	Details
`limit`	integer	No	-
`orders`	object[]	No	-
`page`	integer	No	-
`total`	integer	No	-
`total_pages`	integer	No	-

Order

Property	Type	Required	Details
`app_id`	string	No	-
`billing_address`	string	No	-
`bonus_total`	number	No	-
`country_code`	string	No	-
`created_at`	string	No	-
`currency_code`	string	No	-
`discount_total`	number	No	-
`gift_card_total`	number	No	-
`grand_total`	number	No	-
`id`	string	No	-
`language_code`	string	No	-
`lines`	object[]	No	-
`merchant_user_id`	string	No	-
`payment_method`	string	No	-
`payment_method_id`	string	No	-
`payment_method_name`	string	No	-
`reference`	string	No	-
`session_id`	string	No	-
`shipping_address`	string	No	-
`shipping_methods`	string[]	No	-
`shipping_total`	number	No	-
`source`	string	No	-
`status`	string	No	-
`sub_total`	number	No	-
`tax_total`	number	No	-
`updated_at`	string	No	-

Order Line

Property	Type	Required	Details
`base_price_amount`	number	No	-
`created_at`	string	No	-
`currency_code`	string	No	-
`id`	string	No	-
`order_id`	string	No	-
`product`	object	No	-
`product_id`	string	No	-
`quantity`	number	No	-
`tax_group_id`	string	No	-
`total_discount_amount`	number	No	-
`total_price_amount`	number	No	-
`total_sale_price`	number	No	-
`total_tax_amount`	number	No	-
`updated_at`	string	No	-
`variant`	object	No	-
`variant_id`	string	No	-

{
  "limit": 0,
  "orders": [
    {
      "app_id": "string",
      "billing_address": "string",
      "bonus_total": 0,
      "country_code": "string",
      "created_at": "string",
      "currency_code": "string",
      "discount_total": 0,
      "gift_card_total": 0,
      "grand_total": 0,
      "id": "string",
      "language_code": "string",
      "lines": [
        {
          "base_price_amount": null,
          "created_at": null,
          "currency_code": null,
          "id": null,
          "order_id": null,
          "product": null,
          "product_id": null,
          "quantity": null,
          "tax_group_id": null,
          "total_discount_amount": null,
          "total_price_amount": null,
          "total_sale_price": null,
          "total_tax_amount": null,
          "updated_at": null,
          "variant": null,
          "variant_id": null
        }
      ],
      "merchant_user_id": "string",
      "payment_method": "string",
      "payment_method_id": "string",
      "payment_method_name": "string",
      "reference": "string",
      "session_id": "string",
      "shipping_address": "string",
      "shipping_methods": [
        "string"
      ],
      "shipping_total": 0,
      "source": "string",
      "status": "string",
      "sub_total": 0,
      "tax_total": 0,
      "updated_at": "string"
    }
  ],
  "page": 0,
  "total": 0,
  "total_pages": 0
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Auth API
Method: GET
Path: /api/v1/\{app_id\}/lookup/orders
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Orders
OpenAPI summary: List all orders for an app