Lookup Product | Channel3

{
  "product": {
    "id": "string",
    "title": "string",
    "description": "string",
    "brands": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "images": [
      {
        "url": "string",
        "cleaned_url": "string",
        "is_main_image": false,
        "shot_type": "hero",
        "alt_text": "string"
      }
    ],
    "category": {
      "slug": "string",
      "title": "string",
      "has_children": true,
      "path": [
        {
          "slug": "string",
          "title": "string"
        }
      ]
    },
    "gender": "male",
    "age": "newborn",
    "materials": [
      "string"
    ],
    "key_features": [
      "string"
    ],
    "offers": [
      {
        "url": "string",
        "domain": "string",
        "price": {
          "price": 1.1,
          "currency": "string",
          "compare_at_price": 1.1
        },
        "availability": "InStock",
        "condition": "new",
        "max_commission_rate": 0,
        "dimensions": {
          "length": {
            "number": 1.1,
            "unit": "mm"
          },
          "width": {
            "number": 1.1,
            "unit": "mm"
          },
          "height": {
            "number": 1.1,
            "unit": "mm"
          },
          "weight": {
            "number": 1.1,
            "unit": "mg"
          }
        }
      }
    ],
    "variants": {
      "options": [
        {
          "name": "string",
          "values": [
            {
              "label": "string",
              "exists": true,
              "available": "InStock",
              "thumbnail_url": "string",
              "product_id": "string"
            }
          ]
        }
      ],
      "selected": [
        {
          "name": "string",
          "label": "string"
        }
      ]
    },
    "structured_attributes": {}
  }
}

Retrieve product information for any supported product URL.

Returns the same Product model as GET /v1/products/{product_id}. The product_id in the response can be used with the Product Detail endpoint.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

urlstringRequired

The URL of the product to look up

max_staleness_hoursintegerOptional>=1Defaults to 3

Maximum age (in hours) of cached product data before forcing a fresh lookup. Defaults to 3 hours.

Response

Successful Response

productobject

Product with detailed information.

Errors

401

Unauthorized Error

402

Payment Required Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

504

Gateway Timeout Error

Authentication

Headers

Request

Response

Errors