REST Resource: accounts.products.regionalInventories

  • RegionalInventory resources store product-specific details like price and availability for different regions.

  • You can manage regional inventory data using methods like insert, delete, and list to create, remove, or retrieve regional inventory information.

  • The RegionalInventory resource includes fields such as price, salePrice, availability, and customAttributes allowing for detailed product configuration per region.

  • Refer to the regional product inventory data specification for accepted values for attributes like availability and to understand the structure of regional inventory data.

Resource: RegionalInventory

Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific region. For a list of all accepted attribute values, see the regional product inventory data specification.

JSON representation 
{
  "name": string,
  "account": string,
  "region": string,
  "price": {
    object (Price)
  },
  "salePrice": {
    object (Price)
  },
  "salePriceEffectiveDate": {
    object (Interval)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "availability": string
}
Fields
name

string

Output only. The name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region}

The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: contentLanguage~feedLabel~offerId. Example: en~US~sku123 For legacy local products, the structure is: local~contentLanguage~feedLabel~offerId. Example: local~en~US~sku123

The format of the {product} segment in the URL is automatically detected by the server, supporting two options:

  1. Encoded Format: The {product} segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the contentLanguage~feedLabel~offerId structure. This encoding MUST be used if any part of the product identifier (like offerId) contains characters such as /, %, or ~.

    • Example: To represent the product ID en~US~sku/123 for region "region123", the {product} segment must be the base64url encoding of this string, which is ZW5-VVMtc2t1LzEyMw. The full resource name for the regional inventory would be accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123.

  2. Plain Format: The {product} segment is the tilde-separated string contentLanguage~feedLabel~offerId. This format is suitable only when contentLanguage, feedLabel, and offerId do not contain URL-problematic characters like /, %, or ~.

We recommend using the Encoded Format for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (~) characters in the {product} segment is used to differentiate between the two formats.

Note: For calls to the v1beta version, the plain format for the product segment is channel~contentLanguage~feedLabel~offerId. For example, the full resource name for a regional inventory in region "region123" would be: accounts/123/products/online~en~US~sku123/regionalInventories/region123.
account

string (int64 format)

Output only. The account that owns the product. This field will be ignored if set by the client.
region

string

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.
price

object (Price)

Optional. Price of the product in this region.
salePrice

object (Price)

Optional. Sale price of the product in this region. Mandatory if salePriceEffectiveDate is defined.
salePriceEffectiveDate

object (Interval)

Optional. The TimePeriod of the sale price in this region.
customAttributes[]
(deprecated)

object (CustomAttribute)

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.
availability

string

Availability of the product in this region. For accepted attribute values, see the regional product inventory data specification.

Methods

delete

 Deletes the specified RegionalInventory resource from the given product in your merchant account.

insert

 Inserts a RegionalInventory to a given product in your merchant account.

list

 Lists the RegionalInventory resources for the given product in your merchant account.