About the inventory feed specification

This feed is only used to implement the local feeds partnership programme.

The inventory feed provides a list of all products (identified by id) sold in each shop (identified by store_code) for a given retailer (identified by target_customer_id). It's recommended that you update the inventory feed at least daily.

Each time that you upload the inventory feed, product information is updated incrementally. You only need to include products for which the availability or price has changed since the previous update.

Note: In order to implement the local feeds partnership programme, you're required to upload either an inventory feed or a sales feed. You can also upload both feeds and use them in combination.
Required field Description Type Example
target_customer_id The merchant ID of this retailer. Integer 112339909
store_code

The unique shop identifier. This value is case sensitive.

Use either the shop code listed in the retailer's Business Profile or a point of sales (POS)/inventory data provider internal identifier.

Note: If using an internal shop code, provide mapping to the shop address in the shop feed.

String '465278'
id

The unique identifier of the product. It's recommended that you use the product SKU.

Note: If the retailer sells the same product new and used, they should have different IDs.

String
<= 50 characters
'1029384'
gtin

The Global Trade Item Number of the product.
We accept a variety of standards for GTIN (including UPC). Learn more about unique product identifiers

String '885787364684'
availability

Specifies the status of your inventory (whether and how your product is available).

Note: If availability is missing we will use quantity instead.

Enumeration:

  • in_stock: Items that have quantities of three items or more.
  • limited_availability: Items that have quantities of two items or less.
  • on_display_to_order (ODO): Items that are displayed in store but not immediately available for purchase, such as large furniture items or different sizes and colours of a display model.
  • out_of_stock: Items that are marked as quantity 0. We won't serve local inventory ads for these items.
In_stock
price The price of the product in local currency. String '28.00 GBP'
timestamp

The timestamp of recording the inventory in a specific time zone, as defined by the ISO 8601 standard.

Format: yyyy-mm-ddThh:mm:ss+time zone

String '2016-05-09T14:08:45+00:00'
Optional field Description Type Example
quantity The quantity of the product in inventory. Integer
>= 0
5
Collection SLA The expected date that an order will be ready for collection, relative to when the order is placed. Text (string). Must be one of the eight accepted values: 'same-day', 'next-day', '2-day', '3-day', '4-day', '5-day', '6-day' or 'multi-week' same day
Collection method

The collection option for this item.

Note: The collection method does not have to be submitted to enable collection starting on 1 September 2024.

Text (string). Must be one of the four accepted values:
'buy', 'reserve', 'ship to store' or 'not supported'
buy
Note: If quantity and availability are submitted, the most conservative value will be used. Example: If quantity is '0' and availability is 'in stock' we will change availability to 'out of stock'.

Was this helpful?

How can we improve it?
Search
Clear search
Close search
Main menu
2133678743947183471
true
Search Help Centre
true
true
true
true
true
71525
false
false