Skip to content

Products and attributes

When only price or availability changes, do not resend the entire menu: there are dedicated operations, without the 5-per-day limit.

Operation Method and path Synchronous?
Modify product POST /api/v3/item/modify/stores/{storeId}/products/{productId} yes
Modify attribute POST /api/v3/item/modify/stores/{storeId}/attributes/{attributeId} yes
Bulk update POST /api/v3/item/modify/stores/{storeId}/bulk no
Bulk update status GET /api/v3/item/modify/checkstatus/bulk/{trackingCode}
POST /api/v3/item/modify/stores/gi20__001/products/18411340
Authorization: your-api-key
Content-Type: application/json
{
"price": 47.5,
"available": true
}
Field Type Effect
price Number The new price. Absent or null → left unchanged.
available Boolean Availability. Absent or null → left unchanged.
POST /api/v3/item/modify/stores/gi20__001/attributes/17876412
Authorization: your-api-key
Content-Type: application/json
{
"price_impact": 1.5,
"available": true
}

Attributes use price_impact, not price: the value is the surcharge on top of the product price, not a standalone price.

For many changes at once — for instance the morning availability pass across the whole menu:

POST /api/v3/item/modify/stores/gi20__001/bulk
Authorization: your-api-key
Content-Type: application/json
{
"products": [
{ "id": "18411340", "price": 47.5, "available": true },
{ "id": "18412870", "available": false }
],
"attributes": [
{ "id": "17876412", "price_impact": 2.0, "available": true }
]
}

The operation is asynchronous: you get a tracking code and check the outcome separately.

GET /api/v3/item/modify/checkstatus/bulk/{trackingCode}
Authorization: your-api-key
Situation What you use
A product ran out individual change
Morning opening, dozens of products bulk
A new price list bulk
New product, new category, changed name full update

Individual changes cannot create or delete products. They operate on identifiers that already exist in the menu; any structural change goes through a full update.

The complete field and response specification: API reference.