Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get order by reference for authenticated user

Get a single order by reference for the authenticated user with full product and variant data

GET/api/v1/{app_id}/orders/reference/{reference}
Authorization
AuthorizationAPI key · headerrequired

Bearer token (format: "Bearer {token}")

Path parameters
app_idstringrequired

UUID of the app

referencestringrequired

Order reference

Responses
200

OK

app_idstring
billing_addressstring
bonus_totalnumber
country_codestring
created_atstring
currency_codestring
discount_totalnumber
gift_card_totalnumber
grand_totalnumber
idstring
language_codestring
linesOrderLineResponse[] | null
Show properties
Array of OrderLineResponse
base_price_amountnumber
created_atstring
currency_codestring
idstring
order_idstring
productProductResponse
Show properties
brandBrandResponse
Show properties
idstring
namestring
slugstring
variantstring
created_atstring
customobject
descriptionstring
html_descriptionstring
html_short_descriptionstring
idstring
imagesImageResponse[] | null
Show properties
Array of ImageResponse
alt_textstring
blurhashstring
customobject
idstring
image_urlstring
titlestring
product_namestring
product_numberstring
short_descriptionstring
slugstring
statusstring
translations_descriptionobject
translations_html_descriptionobject
translations_html_short_descriptionobject
translations_product_nameobject
translations_short_descriptionobject
translations_slugobject
updated_atstring
variantsVariantResponse[] | null
product_idstring
quantitynumber
tax_group_idstring
total_discount_amountnumber
total_price_amountnumber
total_sale_pricenumber
total_tax_amountnumber
updated_atstring
variantVariantResponse
Show properties
created_atstring
idstring
imagesImageResponse[] | null
pricesVariantPriceResponse[] | null
Show properties
Array of VariantPriceResponse
amount_cents_with_taxinteger
country_codesstring[]
created_atstring
idstring
market_idstring
market_slugstring
on_saleboolean
reference_priceinteger
sale_end_datestring
sale_price_with_taxinteger
sale_start_datestring
statusstring
store_groupstring
store_group_slugstring
updated_atstring
variant_idstring
product_idstring
statusstring
translations_nameobject
updated_atstring
validate_stockboolean
variant_namestring
variant_numberstring
variant_idstring
merchant_user_idstring
payment_methodstring
payment_method_idstring
payment_method_namestring
referencestring
session_idstring
shipping_addressstring
shipping_methodsstring[]
shipping_totalnumber
sourcestring
statusstring
sub_totalnumber
tax_totalnumber
updated_atstring
400

Invalid request

detailsstring[] | null
messagestring
successboolean
401

Unauthorized

detailsstring[] | null
messagestring
successboolean
404

Order not found

detailsstring[] | null
messagestring
successboolean
500

Internal server error

detailsstring[] | null
messagestring
successboolean
Try it
Server
Authorization
Parameters
Request
curl -X GET '//customers.enad.io/api/v1/string/orders/reference/string' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "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": 0,
      "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": {
          "property1": null,
          "property2": null
        },
        "description": "string",
        "html_description": "string",
        "html_short_description": "string",
        "id": "string",
        "images": [
          {
            "alt_text": "string",
            "blurhash": "string",
            "custom": {
              "property1": null,
              "property2": null
            },
            "id": "string",
            "image_url": "string",
            "title": "string"
          }
        ],
        "product_name": "string",
        "product_number": "string",
        "short_description": "string",
        "slug": "string",
        "status": "string",
        "translations_description": {
          "property1": null,
          "property2": null
        },
        "translations_html_description": {
          "property1": null,
          "property2": null
        },
        "translations_html_short_description": {
          "property1": null,
          "property2": null
        },
        "translations_product_name": {
          "property1": null,
          "property2": null
        },
        "translations_short_description": {
          "property1": null,
          "property2": null
        },
        "translations_slug": {
          "property1": null,
          "property2": null
        },
        "updated_at": "string",
        "variants": [
          {
            "created_at": "string",
            "id": "string",
            "images": [
              {
                "alt_text": "string",
                "blurhash": "string",
                "custom": {
                  "property1": null,
                  "property2": null
                },
                "id": "string",
                "image_url": "string",
                "title": "string"
              }
            ],
            "prices": [
              {
                "amount_cents_with_tax": 0,
                "country_codes": [
                  "string"
                ],
                "created_at": "string",
                "id": "string",
                "market_id": "string",
                "market_slug": "string",
                "on_sale": true,
                "reference_price": 0,
                "sale_end_date": "string",
                "sale_price_with_tax": 0,
                "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": {
              "property1": null,
              "property2": null
            },
            "updated_at": "string",
            "validate_stock": true,
            "variant_name": "string",
            "variant_number": "string"
          }
        ]
      },
      "product_id": "string",
      "quantity": 0,
      "tax_group_id": "string",
      "total_discount_amount": 0,
      "total_price_amount": 0,
      "total_sale_price": 0,
      "total_tax_amount": 0,
      "updated_at": "string",
      "variant": {
        "created_at": "string",
        "id": "string",
        "images": [
          {
            "alt_text": "string",
            "blurhash": "string",
            "custom": {
              "property1": null,
              "property2": null
            },
            "id": "string",
            "image_url": "string",
            "title": "string"
          }
        ],
        "prices": [
          {
            "amount_cents_with_tax": 0,
            "country_codes": [
              "string"
            ],
            "created_at": "string",
            "id": "string",
            "market_id": "string",
            "market_slug": "string",
            "on_sale": true,
            "reference_price": 0,
            "sale_end_date": "string",
            "sale_price_with_tax": 0,
            "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": {
          "property1": null,
          "property2": null
        },
        "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": 0,
  "source": "string",
  "status": "string",
  "sub_total": 0,
  "tax_total": 0,
  "updated_at": "string"
}