BarcodesDocs

GET Lookup Product by Unique ID

This endpoint returns exactly one product variant: results is an array with a single item. The product_unique_id comes from another lookup response, so this endpoint answers "give me the current record for that exact variant". It is the right call after a style-code search returns several colorways, or when you store our IDs in your own database.

The value may contain slashes, so URL-encode it when your HTTP client does not.

Parameters

ParameterInRequiredDescription
product_unique_idpathyesUnique ID of one product variant, as returned in product_unique_id. The value may contain slashes.
show_dataquerynoSend 1 to add the raw source payload (product_data) to the product.

Billing behaviour

A successful call debits one request from the plan allowance. A call that finds nothing is fulfilled but not debited.

  • Lookup Product by SKU lists every variant under a style code.
  • The product_image field of a result points at the image endpoint.

Route

/api/v2/product/lookup/uid/{product_unique_id}

Ability

  • lookup-product

Response 200 (success)

{
  "error": false,
  "results": [
    {
      "product_last_checked": "datetime|null",
      "product_name": "string|null",
      "product_brand": "string|null",
      "product_category": "string|null",
      "product_unique_id": "string|null",
      "product_style_code": "string|null",
      "product_release_date": "YYYY-MM-DD|string|null",
      "product_description": "string|null",
      "product_colorway": "string|null",
      "product_retail_price": "string|number|null",
      "product_image": "https://.../api/image/uid/{product_unique_id}"
    }
  ],
  "response_time": "XXXms",
  "request_fulfilled": true,
  "request_debited": true
}

Response 200 (not found)

{
  "error": true,
  "message": "No product could be found for this search query.",
  "response_time": "XXXms",
  "request_fulfilled": true,
  "request_debited": false
}

Response 403

{
  "error": true,
  "message": "API Token has run out of usage, please top up via the dashboard.",
  "response_time": "XXXms",
  "request_fulfilled": false,
  "request_debited": false
}

The barcode lookup API page shows the plans and examples.