Skip to main content
GET
/
api
/
v1
/
{app_id}
/
orders
Error
A valid request URL is required to generate request examples
{
  "limit": 123,
  "orders": [
    {
      "app_id": "<string>",
      "billing_address": "<string>",
      "bonus_total": 123,
      "country_code": "<string>",
      "created_at": "<string>",
      "currency_code": "<string>",
      "discount_total": 123,
      "gift_card_total": 123,
      "grand_total": 123,
      "id": "<string>",
      "language_code": "<string>",
      "lines": [
        {
          "base_price_amount": 123,
          "created_at": "<string>",
          "currency_code": "<string>",
          "id": "<string>",
          "order_id": "<string>",
          "product": {
            "brand_id": "<string>",
            "created_at": "<string>",
            "custom": {},
            "description": "<string>",
            "html_description": "<string>",
            "html_short_description": "<string>",
            "id": "<string>",
            "images": [
              {
                "alt_text": "<string>",
                "blurhash": "<string>",
                "custom": {},
                "id": "<string>",
                "image_url": "<string>",
                "title": "<string>"
              }
            ],
            "product_name": "<string>",
            "product_number": "<string>",
            "short_description": "<string>",
            "slug": "<string>",
            "status": "<string>",
            "translations_description": {},
            "translations_html_description": {},
            "translations_html_short_description": {},
            "translations_short_description": {},
            "translations_slug": {},
            "updated_at": "<string>"
          },
          "product_id": "<string>",
          "quantity": 123,
          "tax_group_id": "<string>",
          "total_discount_amount": 123,
          "total_price_amount": 123,
          "total_sale_price": 123,
          "total_tax_amount": 123,
          "updated_at": "<string>",
          "variant": {
            "created_at": "<string>",
            "id": "<string>",
            "images": [
              {
                "alt_text": "<string>",
                "blurhash": "<string>",
                "custom": {},
                "id": "<string>",
                "image_url": "<string>",
                "title": "<string>"
              }
            ],
            "product_id": "<string>",
            "status": "<string>",
            "translations_name": {},
            "updated_at": "<string>",
            "validate_stock": true,
            "variant_name": "<string>",
            "variant_number": "<string>"
          },
          "variant_id": "<string>"
        }
      ],
      "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": 123,
      "source": "<string>",
      "status": "<string>",
      "sub_total": 123,
      "tax_total": 123,
      "updated_at": "<string>"
    }
  ],
  "page": 123,
  "total": 123
}

Path Parameters

app_id
string
required

UUID of the app

Query Parameters

limit
integer

Limit for pagination (default: 20, max: 20)

page
integer

Page number for pagination (default: 1)

Response

OK

limit
integer
orders
object[]
page
integer
total
integer