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: regionalinventory
Stay organized with collections
Save and categorize content based on your preferences.
Resource: RegionalInventory
Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.
JSON representation |
{
"regionId": string,
"price": {
object (Price )
},
"salePrice": {
object (Price )
},
"salePriceEffectiveDate": string,
"availability": string,
"customAttributes": [
{
object (CustomAttribute )
}
],
"kind": string
} |
Fields |
regionId |
string
The ID uniquely identifying each region.
|
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 might be specified as 'null' if undecided.
|
availability |
string
The availability of the product.
|
customAttributes[] |
object (CustomAttribute )
A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory ".
|
Methods |
|
Updates regional inventory for multiple products or regions in a single request. |
|
Updates the regional 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 \u003ccode\u003eRegionalInventory\u003c/code\u003e resource allows you to manage product information specific to different regions, such as price, sale price, availability, and custom attributes.\u003c/p\u003e\n"],["\u003cp\u003eIt includes fields like \u003ccode\u003eregionId\u003c/code\u003e, \u003ccode\u003eprice\u003c/code\u003e, \u003ccode\u003esalePrice\u003c/code\u003e, \u003ccode\u003esalePriceEffectiveDate\u003c/code\u003e, \u003ccode\u003eavailability\u003c/code\u003e, \u003ccode\u003ecustomAttributes\u003c/code\u003e, and \u003ccode\u003ekind\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eYou can interact with this resource using methods like \u003ccode\u003ecustombatch\u003c/code\u003e to update inventory for multiple products or regions, and \u003ccode\u003einsert\u003c/code\u003e to update inventory for a specific product within a region.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRegionalInventory\u003c/code\u003e resource is represented in JSON format with specific data types for each field, and detailed documentation is available on the linked pages.\u003c/p\u003e\n"]]],["The RegionalInventory resource contains region-specific product data, including `regionId`, `price`, `salePrice`, `salePriceEffectiveDate`, and `availability`. It also supports `customAttributes` and has a fixed `kind` value. The `custombatch` method updates multiple product/region inventories simultaneously, while the `insert` method modifies the regional inventory for a single product. All fields have specific types (string, object), following the schema.\n"],null,["# REST Resource: regionalinventory\n\n- [Resource: RegionalInventory](#RegionalInventory)\n - [JSON representation](#RegionalInventory.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: RegionalInventory\n---------------------------\n\nRegional inventory resource. contains the regional name and all attributes which are overridden for the specified region.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"regionId\": string, \"price\": { object (/shopping-content/reference/rest/v2.1/Price) }, \"salePrice\": { object (/shopping-content/reference/rest/v2.1/Price) }, \"salePriceEffectiveDate\": string, \"availability\": string, \"customAttributes\": [ { object (/shopping-content/reference/rest/v2.1/CustomAttribute) } ], \"kind\": string } ``` |\n\n| Fields ||\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `regionId` | `string` The ID uniquely identifying each region. |\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 might be specified as 'null' if undecided. |\n| `availability` | `string` The availability of the product. |\n| `customAttributes[]` | `object (`[CustomAttribute](/shopping-content/reference/rest/v2.1/CustomAttribute)`)` A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#regionalInventory`\". |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|\n| ### [custombatch](/shopping-content/reference/rest/v2.1/regionalinventory/custombatch) | Updates regional inventory for multiple products or regions in a single request. |\n| ### [insert](/shopping-content/reference/rest/v2.1/regionalinventory/insert) | Updates the regional inventory of a product in your Merchant Center account. |"]]