Skip to main content
Version: V2

V2 API Overview

This section documents the V2 API routes with prefix:

/api/v2

Authentication​

  • Include your API token as a Bearer token in the Authorization header.

Global Response Fields​

All V2 JSON responses include:

{
  "response_time": "XXXms",
  "request_fulfilled": true,
  "request_debited": false
}

Meaning:

  • response_time: runtime of the request.
  • request_fulfilled: true when HTTP status is less than 400.
  • request_debited: true only when usage was debited on success.

Why UID Routes Exist​

Some products can share the same SKU while still having meaningful differences (for example color variants). In those cases, SKU-based lookups may not be specific enough.

Use product_unique_id from search responses when you need exact product targeting:

  • Product lookup by UID: /api/v2/product/lookup/uid/{product_unique_id}
  • Image lookup by UID: /api/image/uid/{product_unique_id}

This gives you a stable way to fetch the exact product details and image for one specific variant.