Skip to main content
Version: V2

GET Lookup Barcode

Route​

/api/v2/barcode/lookup/{barcode}

Ability​

  • lookup-barcode

Query Parameters​

  • fields (required, comma-separated fields or *)

Response 200 (success with fields=*)​

{
    "error": false,
    "product": {
        "product_name": "string|null",
        "product_brand": "string|null",
        "product_category": "string|null",
        "product_unique_id": "string|null",
        "product_description": "string|null",
        "product_style_code": "string|null",
        "product_colorway": "string|null",
        "product_release_date": "YYYY-MM-DD|string|null",
        "product_retail_price": "string|number|null",
        "product_image": "https://.../api/image/uid/{product_unique_id}",
        "product_sizes": [
            "size aliases"
        ],
        "product_added": "datetime|string|null",
        "product_updated": "datetime|string|null",
        "us_sizes": [
            "string sizes"
        ]
    },
    "barcode": {
        "barcode_type": "string",
        "barcode_value": "string",
        "barcode_added": "datetime|string|null",
        "product_size": {
            "us": "string|number|null",
            "uk": "string|number|null",
            "eu": "string|number|null"
        }
    },
    "response_time": "XXXms",
    "request_fulfilled": true,
    "request_debited": true
}

Response 200 (success with custom fields)​

{
    "error": false,
    "product_name": "string (if requested)",
    "product_style_code": "string (if requested)",
    "barcode_value": "string (if requested)",
    "product": "object (if parent field requested)",
    "barcode": "object (if parent field requested)",
    "response_time": "XXXms",
    "request_fulfilled": true,
    "request_debited": true
}

Response 200 (not found)​

{
    "error": true,
    "message": "Barcode could not be found. | We do not hold any product information for this barcode.",
    "response_time": "XXXms",
    "request_fulfilled": true,
    "request_debited": false
}

Response 400 or 403​

{
    "error": true,
    "message": "validation errors object | Please enter a valid barcode. | token depleted message",
    "response_time": "XXXms",
    "request_fulfilled": false,
    "request_debited": false
}