Documentation
Feedback
Guides
API Reference

Guides
VTEX Ads
Synchronizing inventory information

Ensure inventory availability data is kept up to date for ad display.

Inventory information defines the price, promotional price, and "stock." Regarding stock, we should only receive whether the product is available for sale.

Learn more about each field on POST Synchronize inventory information.

🚧 Batch Insert / Update

For each batch insert/update, a maximum of 500 objects per request and 3 simultaneous requests are allowed.

Therefore, for an initial load with the entire product base, this limit must be taken into account when sending data.

Request

Processing will be performed asynchronously.


_21
POST https://api-retail-media.newtail.com.br/product/bulk/inventories HTTP/1.1
_21
accept: application/json
_21
content-type: application/json
_21
x-app-id: <PUBLISHER_APP_ID>
_21
x-api-key: <API_KEY>
_21
_21
[
_21
{
_21
"product_sku": "120210",
_21
"store_id": "1",
_21
"price": 18.20,
_21
"promotional_price": 16.32,
_21
"is_available": true
_21
},
_21
{
_21
"product_sku": "120212",
_21
"price": 18.20,
_21
"promotional_price": 0, // this removes the promotional price
_21
"is_available": true
_21
}
_21
]

Response with validation error

For validations, we use the RFC 8927 format, as exemplified below.

A failed response will have HTTP code 422.


_71
[
_71
{
_71
"instancePath": "/0",
_71
"schemaPath": "#/items/required",
_71
"keyword": "required",
_71
"params": {
_71
"missingProperty": "product_sku"
_71
},
_71
"message": "must have required property 'product_sku'"
_71
},
_71
{
_71
"instancePath": "/0",
_71
"schemaPath": "#/items/required",
_71
"keyword": "required",
_71
"params": {
_71
"missingProperty": "promotional_price"
_71
},
_71
"message": "must have required property 'promotional_price'"
_71
}, {
_71
"instancePath": "/0",
_71
"schemaPath": "#/items/required",
_71
"keyword": "required",
_71
"params": {
_71
"missingProperty": "is_available"
_71
},
_71
"message": "must have required property 'is_available'"
_71
},
_71
{
_71
"instancePath": "/1",
_71
"schemaPath": "#/items/required",
_71
"keyword": "required",
_71
"params": {
_71
"missingProperty": "price"
_71
},
_71
"message": "must have required property 'price'"
_71
}, {
_71
"instancePath": "/1",
_71
"schemaPath": "#/items/required",
_71
"keyword": "required",
_71
"params": {
_71
"missingProperty": "promotional_price"
_71
},
_71
"message": "must have required property 'promotional_price'"
_71
},
_71
{
_71
"instancePath": "/1",
_71
"schemaPath": "#/items/required",
_71
"keyword": "required",
_71
"params": {
_71
"missingProperty": "is_available"
_71
},
_71
"message": "must have required property 'is_available'"
_71
}, {
_71
"instancePath": "/2",
_71
"schemaPath": "#/items/required",
_71
"keyword": "required",
_71
"params": {
_71
"missingProperty": "price"
_71
},
_71
"message": "must have required property 'price'"
_71
},
_71
{
_71
"instancePath": "/2",
_71
"schemaPath": "#/items/required",
_71
"keyword": "required",
_71
"params": {
_71
"missingProperty": "is_available"
_71
},
_71
"message": "must have required property 'is_available'"
_71
}
_71
]

Contributors
1
Photo of the contributor
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
1
Photo of the contributor
On this page