Skip to content
Scrappa Get API key
Uniqlo API 1 credit / request

Uniqlo Search API Documentation

GET https://scrappa.co/api/uniqlo/search

Uniqlo Search API returns 36 products per page for a keyword: product id, name, gender, price with a sale flag, rating, colours with swatch and image, sizes, labels and the product url. Narrow to a category (get the id or category_path from the categories of the product route). Filter by colorCodes, sizeCodes, flagCodes (for example discount) and one priceRanges value. Sort by price or rating.

Use the product_id of an item in the product route. price.on_sale is true for items Uniqlo flags as a sale. Uniqlo sends the sale price as the current price and usually no original price, so original_price, sale_price and discount_percent are filled only when Uniqlo sends a higher original price (use the product route for the regular price of an item in a sale price group). An item can sit in more than one price group (00 regular, 01 sale): send its price_group to the product route. A filter that matches nothing and a page past the last page return 422, never an empty answer. Regions: us and jp. A successful request costs 1 credit.

Uniqlo Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/uniqlo/search
Auth header
x-api-key
Cost
1 credit / request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "page": 1,
        "sort": "RELEVANCE",
        "items": [
            {
                "url": "https://www.uniqlo.com/us/en/products/E479000-000/00",
                "name": "Barrel Jeans",
                "tags": [
                    "UNISEX"
                ],
                "price": {
                    "amount": 39.9,
                    "on_sale": false,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

8 optional filters available.

query string Required

Search keyword.

Example value coffee shops
region string Optional

Region: us (default) or jp.

Example value US
page integer Optional

One-based page number, 1 to 100 (default 1). 36 products per page.

Example value 1
colorCodes string Optional

Colour codes like COL09, separated by commas. Products with any of them match.

Example value example
sizeCodes string Optional

Size codes like SMA003, separated by commas. Products with any of them match.

Example value example
flagCodes string Optional

Flag codes like discount (sale), separated by commas.

Example value example
priceRanges string Optional

One price range in the major currency unit of the region, inclusive, like 0-30 (US dollars) or 3000-5000 (Japanese yen). Items outside the range are never returned.

Example value example
category string Optional

Optional category: one category id, or the category_path from the categories of the product route, for example 22210,23296,23339 (Women, Bottoms, Jeans). A path is gender, class, category and subcategory ids. An unknown category returns 422.

Example value example
sort string Optional

RELEVANCE (default), PRICE_LOW_TO_HIGH, PRICE_HIGH_TO_LOW or RATING.

Example value relevance

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "page": 1,
        "sort": "RELEVANCE",
        "items": [
            {
                "url": "https://www.uniqlo.com/us/en/products/E479000-000/00",
                "name": "Barrel Jeans",
                "tags": [
                    "UNISEX"
                ],
                "price": {
                    "amount": 39.9,
                    "on_sale": false,
                    "currency": "USD",
                    "sale_price": null,
                    "original_price": null,
                    "discount_percent": null
                },
                "sizes": [
                    {
                        "code": "INS022",
                        "name": "22inch"
                    },
                    {
                        "code": "INS023",
                        "name": "23inch"
                    },
                    {
                        "code": "INS024",
                        "name": "24inch"
                    }
                ],
                "colors": [
                    {
                        "code": "COL04",
                        "name": "GRAY",
                        "image_url": "https://image.uniqlo.com/UQ/ST3/us/imagesgoods/479000/item/usgoods_04_479000_3x4.jpg",
                        "swatch_url": "https://image.uniqlo.com/UQ/ST3/WesternCommon/imagesgoods/479000/chip/goods_04_479000_chip.jpg",
                        "color_group": "GRAY",
                        "display_code": "04"
                    },
                    {
                        "code": "COL08",
                        "name": "DARK GRAY",
                        "image_url": "https://image.uniqlo.com/UQ/ST3/us/imagesgoods/479000/item/usgoods_08_479000_3x4.jpg",
                        "swatch_url": "https://image.uniqlo.com/UQ/ST3/WesternCommon/imagesgoods/479000/chip/goods_08_479000_chip.jpg",
                        "color_group": "GRAY",
                        "display_code": "08"
                    }
                ],
                "gender": "unisex",
                "labels": [
                    "Limited-Time Offer until 11/4"
                ],
                "rating": {
                    "count": 591,
                    "average": 4.7
                },
                "image_url": "https://image.uniqlo.com/UQ/ST3/us/imagesgoods/479000/item/usgoods_04_479000_3x4.jpg",
                "product_id": "E479000-000",
                "price_group": "00",
                "store_stock_only": false
            },
            {
                "url": "https://www.uniqlo.com/us/en/products/E487206-000/00",
                "name": "Straight Jeans",
                "tags": [],
                "price": {
                    "amount": 49.9,
                    "on_sale": false,
                    "currency": "USD",
                    "sale_price": null,
                    "original_price": null,
                    "discount_percent": null
                },
                "sizes": [
                    {
                        "code": "INS027",
                        "name": "27inch"
                    },
                    {
                        "code": "INS028",
                        "name": "28inch"
                    },
                    {
                        "code": "INS029",
                        "name": "29inch"
                    }
                ],
                "colors": [
                    {
                        "code": "COL67",
                        "name": "BLUE",
                        "image_url": "https://image.uniqlo.com/UQ/ST3/us/imagesgoods/487206/item/usgoods_67_487206_3x4.jpg",
                        "swatch_url": "https://image.uniqlo.com/UQ/ST3/WesternCommon/imagesgoods/487206/chip/goods_67_487206_chip.jpg",
                        "color_group": "BLUE",
                        "display_code": "67"
                    },
                    {
                        "code": "COL07",
                        "name": "GRAY",
                        "image_url": "https://image.uniqlo.com/UQ/ST3/us/imagesgoods/487206/item/usgoods_07_487206_3x4.jpg",
                        "swatch_url": "https://image.uniqlo.com/UQ/ST3/WesternCommon/imagesgoods/487206/chip/goods_07_487206_chip.jpg",
                        "color_group": "GRAY",
                        "display_code": "07"
                    }
                ],
                "gender": "men",
                "labels": [
                    "Limited-Time Offer until 11/4"
                ],
                "rating": {
                    "count": 24,
                    "average": 4.7
                },
                "image_url": "https://image.uniqlo.com/UQ/ST3/us/imagesgoods/487206/item/usgoods_67_487206_3x4.jpg",
                "product_id": "E487206-000",
                "price_group": "00",
                "store_stock_only": false
            }
        ],
        "query": "jeans",
        "total": 72,
        "region": "us",
        "filters": null,
        "category": null,
        "page_size": 36,
        "total_pages": 2
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "search"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

404

Not Found

The search does not exist. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
422

Validation Error

A parameter is missing or invalid, or the filter, page or place matches nothing. This response is not billable.

{
    "errors": {
        "colorCodes": [
            "The colorCodes must be color codes like COL09, separated by commas."
        ]
    },
    "message": "The request validation failed"
}
503

Upstream Unavailable

Uniqlo could not be reached, or it returned data that does not match the request. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Uniqlo could not be reached. Please retry shortly."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.