Skip to main content
GET
/
api
/
v1
/
{app_id}
/
orders
/
reference
/
{reference}
Error
A valid request URL is required to generate request examples
{
  "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>",
          "name": "<string>",
          "slug": "<string>",
          "variant": "<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>",
        "variants": [
          {
            "created_at": "<string>",
            "id": "<string>",
            "images": [
              {
                "alt_text": "<string>",
                "blurhash": "<string>",
                "custom": {},
                "id": "<string>",
                "image_url": "<string>",
                "title": "<string>"
              }
            ],
            "prices": [
              {
                "amount_cents_with_tax": 123,
                "country_codes": [
                  "<string>"
                ],
                "created_at": "<string>",
                "id": "<string>",
                "market_id": "<string>",
                "market_slug": "<string>",
                "on_sale": true,
                "reference_price": 123,
                "sale_end_date": "<string>",
                "sale_price_with_tax": 123,
                "sale_start_date": "<string>",
                "status": "<string>",
                "store_group": "<string>",
                "store_group_slug": "<string>",
                "updated_at": "<string>",
                "variant_id": "<string>"
              }
            ],
            "product_id": "<string>",
            "status": "<string>",
            "translations_name": {},
            "updated_at": "<string>",
            "validate_stock": true,
            "variant_name": "<string>",
            "variant_number": "<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>"
          }
        ],
        "prices": [
          {
            "amount_cents_with_tax": 123,
            "country_codes": [
              "<string>"
            ],
            "created_at": "<string>",
            "id": "<string>",
            "market_id": "<string>",
            "market_slug": "<string>",
            "on_sale": true,
            "reference_price": 123,
            "sale_end_date": "<string>",
            "sale_price_with_tax": 123,
            "sale_start_date": "<string>",
            "status": "<string>",
            "store_group": "<string>",
            "store_group_slug": "<string>",
            "updated_at": "<string>",
            "variant_id": "<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>"
}

Path Parameters

app_id
string
required

UUID of the app

reference
string
required

Order reference

Response

OK

app_id
string
billing_address
string
bonus_total
number
country_code
string
created_at
string
currency_code
string
discount_total
number
gift_card_total
number
grand_total
number
id
string
language_code
string
lines
object[]
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
number
source
string
status
string
sub_total
number
tax_total
number
updated_at
string