rocket
Meet
Merchant API
- the official successor to Content API for Shopping.
update
Get the latest
on new Merchant API features, bug fixes, and updates.
add_alert
Note: Content API for Shopping will be sunset on August 18, 2026.
REST Resource: localinventory
Stay organized with collections
Save and categorize content based on your preferences.
Resource: LocalInventory
| JSON representation |
{
"storeCode": string,
"price": {
object (Price)
},
"salePrice": {
object (Price)
},
"salePriceEffectiveDate": string,
"availability": string,
"quantity": integer,
"pickupMethod": string,
"pickupSla": string,
"instoreProductLocation": string,
"kind": string,
"customAttributes": [
{
object (CustomAttribute)
}
]
} |
| Fields |
storeCode |
string
Required. The store code of this local inventory resource.
|
price |
object (Price)
The price of the product.
|
salePrice |
object (Price)
The sale price of the product. Mandatory if salePriceEffectiveDate is defined.
|
salePriceEffectiveDate |
string
A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as 'null' if undecided.
|
availability |
string
The availability of the product. For accepted attribute values, see the local product inventory feed specification.
|
quantity |
integer (uint32 format)
The quantity of the product. Must be nonnegative.
|
pickupMethod |
string
The supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory feed specification.
|
pickupSla |
string
The expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. For accepted attribute values, see the local product inventory feed specification.
|
instoreProductLocation |
string
The in-store product location.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#localInventory"
|
customAttributes[] |
object (CustomAttribute)
A list of custom (merchant-provided) attributes. Can also be used to submit any attribute of the feed specification in its generic form, for example, { "name": "size type", "value": "regular" }.
|
Methods |
|
|
Updates local inventory for multiple products or stores in a single request. |
|
|
Updates the local inventory of a product in your Merchant Center account. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003eThe LocalInventory resource allows you to manage and update the local inventory information for your products, including price, availability, and pickup options.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify attributes like store code, price, sale price, availability, quantity, pickup method, and in-store product location using this resource.\u003c/p\u003e\n"],["\u003cp\u003eLocalInventory supports custom attributes, letting you submit merchant-specific details about your products for a more comprehensive listing.\u003c/p\u003e\n"],["\u003cp\u003eUtilize the \u003ccode\u003ecustombatch\u003c/code\u003e and \u003ccode\u003einsert\u003c/code\u003e methods to update local inventory for multiple products or individual items within your Merchant Center account, respectively, leveraging the provided JSON representation and adhering to the local product inventory feed specifications.\u003c/p\u003e\n"]]],["The LocalInventory resource represents product inventory at specific stores. Key data includes the `storeCode`, `price`, `salePrice`, `availability`, `quantity`, `pickupMethod`, and `pickupSla`. `salePriceEffectiveDate` defines the sale period. `instoreProductLocation` indicates the in-store location. `customAttributes` allows for merchant-defined attributes. Two main methods exist: `custombatch` for updating multiple products/stores simultaneously, and `insert` to update a single product's inventory.\n"],null,["# REST Resource: localinventory\n\n- [Resource: LocalInventory](#LocalInventory)\n - [JSON representation](#LocalInventory.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: LocalInventory\n------------------------\n\nLocal inventory resource. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"storeCode\": string, \"price\": { object (/shopping-content/reference/rest/v2.1/Price) }, \"salePrice\": { object (/shopping-content/reference/rest/v2.1/Price) }, \"salePriceEffectiveDate\": string, \"availability\": string, \"quantity\": integer, \"pickupMethod\": string, \"pickupSla\": string, \"instoreProductLocation\": string, \"kind\": string, \"customAttributes\": [ { object (/shopping-content/reference/rest/v2.1/CustomAttribute) } ] } ``` |\n\n| Fields ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `storeCode` | `string` Required. The store code of this local inventory resource. |\n| `price` | `object (`[Price](/shopping-content/reference/rest/v2.1/Price)`)` The price of the product. |\n| `salePrice` | `object (`[Price](/shopping-content/reference/rest/v2.1/Price)`)` The sale price of the product. Mandatory if `salePriceEffectiveDate` is defined. |\n| `salePriceEffectiveDate` | `string` A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as 'null' if undecided. |\n| `availability` | `string` The availability of the product. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342). |\n| `quantity` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` The quantity of the product. Must be nonnegative. |\n| `pickupMethod` | `string` The supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342). |\n| `pickupSla` | `string` The expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342). |\n| `instoreProductLocation` | `string` The in-store product location. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#localInventory`\" |\n| `customAttributes[]` | `object (`[CustomAttribute](/shopping-content/reference/rest/v2.1/CustomAttribute)`)` A list of custom (merchant-provided) attributes. Can also be used to submit any attribute of the feed specification in its generic form, for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------|\n| ### [custombatch](/shopping-content/reference/rest/v2.1/localinventory/custombatch) | Updates local inventory for multiple products or stores in a single request. |\n| ### [insert](/shopping-content/reference/rest/v2.1/localinventory/insert) | Updates the local inventory of a product in your Merchant Center account. |"]]