Home      API     Rakuten Ichiba Attribute SearchAPI

The Rakuten Ichiba Attribute Search API can retrieve attribute information for items in Rakuten Ichiba. Developers can retrieve attribute information by specifying Genre ID and optionally Attribute ID.

Endpoint (REST/JSON format)


https://openapi.rakuten.co.jp/ichibagt/api/IchibaAttribute/Search/20260401?[parameter]=[value]…

*The JSONP format allows a JavaScript callback function to be specified as an input parameter.

The request URL below can be used to retrieve attribute information for a specific genre. (In a real use, please combine the request URL into one line.) 

https://openapi.rakuten.co.jp/ichibagt/api/IchibaAttribute/Search/20260401?
applicationId=[APPLICATION ID]&
genreId=[GENRE ID]

*If many accesses to an identical URL are made in a short time, the URL may be become unresponsive for a fixed period of time. Please take care during testing.

To the top of the page

Input headers


Rakuten Ichiba Attribute Search API input headers version:2026-04-01

ID Header name Header Type (maximum bytes in parentheses) Required Default Comment
Division: Shared headers
1 Access key【NEW】 accessKey String 必須 - Can be provided in either header or as query parameter
Required along with app ID query parameter
Check here
To the top of the page

Input Parameters


Rakuten Ichiba Attribute Search API Input parameters version:2026-04-01

ID Item name Parameter Type (maximum bytes in parentheses) Required Default Comment
Division: Shared parameters
1 App ID applicationId String 必須 - Required along with access key
Check here
2 Access Key【NEW】 accessKey String 必須 - Can be provided in either header or as query parameter
Required along with app ID
Check here
3 Affiliate ID affiliateId String - - Check here
4 Response format format String - json Either JSON or XML
When JSON is specified the callback parameter can also be set in order to use JSONP.
5 Callback function name callback String - - Function name to be used with the JSONP output
(UTF-8 URL encoded string)
Alphanumeric characters, periods, or underscores
6 Choosing output fields elements String - - By default, API response all of the fields. You can change response fields by this parameter.
This parameter's data is separated by comma(,).
For example, following request will response only itemName, itemPrice and itemUrl.
elements=itemName,itemPrice,itemUrl
7 Format version formatVersion int - 1

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1 :
Our API response will be returned in Array format as the followings.
You would need to use notation items[0].item.itemName To access itemName parameter. 

{"items": [
    {"item": {
        "itemName": "a",
        "itemPrice": 10
    }},
    {"item": {
        "itemName": "b",
        "itemPrice": 20
    }}
]}

In case of formatVersion=2 :
Our API response will be returned in Array format as the followings.
You can use notation items[0].itemName To access itemName parameter. 

{"items": [
    {
        "itemName": "a",
        "itemPrice": 10
    },
    {
        "itemName": "b",
        "itemPrice": 20
    }
]}
Division : service specific parameters
1 Genre ID genreId string 必須
 - Genre ID to search attributes for
2 Attribute ID attributeId string - - Optional: Specific attribute ID to retrieve
To the top of the page

Output parameters


Rakuten Ichiba Attribute Search API Output Parameters version:2026-04-01

Division : service specific parameters
1 Attribute information Attribute information attributes Array of attribute information
2 Attribute ID attributeId Attribute ID
3 Attribute name nameJa Attribute name (Japanese)
To the top of the page

Error

Error messages are displayed in the form of HTTP status code and its response body

HTTP Status Code Description Response body example (JSON)
400 Parameter error (or required parameters were insufficient)

If applicationId is not set

{
    "error": "wrong_parameter",
    "error_description": "specify valid applicationId"
}

If keyword is not valid (only 1 character given, etc.)

{
    "error": "wrong_parameter",
    "error_description": "keyword parameter is not valid"
}
404 If data not found. 
{
    "error": "not_found",
    "error_description": "not found"
}
429 Too many requests

This error will be displayed if the number of API requests has been exceeded.
Please try access again after an amount of time.

{
    "error": "too_many_requests",
    "error_description": "number of allowed requests has been exceeded for this API. please try again soon."
}
500 Internal error in Rakuten Web Service

An internal system error occured. If you continue seeing this message for a long period, please give your inquiry via this link

{
    "error": "system_error",
    "error_description": "api logic error"
}
503 Unavailable due to maintenance or overloaded

Maintenance (the API name will be displayed in XXX/XXX)

{
    "error": "service_unavailable",
    "error_description": "XXX/XXX is under maintenance"
}

Response body format is display in format.

format Error output example
json 
{
    "error": "wrong_parameter",
    "error_description": "page must be a number"
}
xml 
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <error>wrong_parameter</error>
    <error_description>page must be a number</error_description>
</root>
To the top of the page
> How to develop