Inventory customizations

Customizations allow retailers to hide specific products, or override the titles, images and descriptions sent to channels.

Endpoints

Examples

Hide a barcode for all stores

Hiding a specific product from all stores means using the Inventory customization API to mark that product as hidden.

POST https://partner-api.near.st/retailers/{retailerId}/inventory/customizations
Content-Type: application/json
 
{
    "barcode": "5010368061112",
    "hidden": true
}

Add custom data for product in one store

You can also call this API for a specific store, by adding /stores/{id}/ in the request URL, like shown below. Remember that when adding custom data, all the required fields should be specified.

POST https://partner-api.near.st/retailers/{retailerId}/stores/{storeId}/inventory/customizations
Content-Type: application/json
 
{
    "barcode": "5010368061112",
    "title": "Cuprinol Garden Shades 1 Litre Willow",
    "description": "The 1 Litre Willow from ITS is a specially designed...",
    "brand": "Cuprinol",
    "image": ["https://..."]
}