Package google.shopping.merchant.inventories.v1beta

  • The LocalInventoryService and RegionalInventoryService manage local and regional inventory for products, respectively, with methods to insert, delete, and list inventory data.

  • LocalInventory represents in-store product information for a specific store, including price, availability, and pickup options, while RegionalInventory provides similar details for a specific region.

  • Requests for managing inventory require specifying the account, product, and either store code (for local) or region (for regional) using resource names in a defined format.

  • Responses include the requested inventory data or a token for pagination if more data is available, and resources might take some time to be reflected in products after updates.

  • Both services require the OAuth scope https://www.googleapis.com/auth/content for authorization.

Index

LocalInventoryService

Service to manage local inventory for products

DeleteLocalInventory

rpc DeleteLocalInventory(DeleteLocalInventoryRequest) returns (Empty)

Deletes the specified LocalInventory from the given product in your merchant account. It might take a up to an hour for the LocalInventory to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
InsertLocalInventory

rpc InsertLocalInventory(InsertLocalInventoryRequest) returns (LocalInventory)

Inserts a LocalInventory resource to a product in your merchant account.

Replaces the full LocalInventory resource if an entry with the same storeCode already exists for the product.

It might take up to 30 minutes for the new or updated LocalInventory resource to appear in products.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
ListLocalInventories

rpc ListLocalInventories(ListLocalInventoriesRequest) returns (ListLocalInventoriesResponse)

Lists the LocalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

LocalInventory resources are listed per product for a given account.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

RegionalInventoryService

Service to manage regional inventory for products. There is also separate regions resource and API to manage regions definitions.

DeleteRegionalInventory

rpc DeleteRegionalInventory(DeleteRegionalInventoryRequest) returns (Empty)

Deletes the specified RegionalInventory resource from the given product in your merchant account. It might take up to an hour for the RegionalInventory to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
InsertRegionalInventory

rpc InsertRegionalInventory(InsertRegionalInventoryRequest) returns (RegionalInventory)

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

Replaces the full RegionalInventory resource if an entry with the same region already exists for the product.

It might take up to 30 minutes for the new or updated RegionalInventory resource to appear in products.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
ListRegionalInventories

rpc ListRegionalInventories(ListRegionalInventoriesRequest) returns (ListRegionalInventoriesResponse)

Lists the RegionalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

RegionalInventory resources are listed per product for a given account.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

DeleteLocalInventoryRequest

Request message for the DeleteLocalInventory method.

Fields
name

string

Required. The name of the local inventory for the given product to delete. Format: accounts/{account}/products/{product}/localInventories/{store_code}

The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. 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 content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.

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

  2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id 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~content_language~feed_label~offer_id. For example, the full resource name for a local inventory at store_code "store123" would be: accounts/123/products/online~en~US~sku123/localInventories/store123.

DeleteRegionalInventoryRequest

Request message for the DeleteRegionalInventory method.

Fields
name

string

Required. The name of the RegionalInventory resource to delete. 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: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. 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 content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) 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 content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id 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~content_language~feed_label~offer_id. For example, the full resource name for a regional inventory in region "region123" would be: accounts/123/products/online~en~US~sku123/regionalInventories/region123.

InsertLocalInventoryRequest

Request message for the InsertLocalInventory method.

Fields
parent

string

Required. The account and product where this inventory will be inserted. Format: accounts/{account}/products/{product}

The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. 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 content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.

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

  2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id 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 is channel~content_language~feed_label~offer_id, for example: accounts/123/products/online~en~US~sku123.
local_inventory

LocalInventory

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

InsertRegionalInventoryRequest

Request message for the InsertRegionalInventory method.

Fields
parent

string

Required. The account and product where this inventory will be inserted. Format: accounts/{account}/products/{product}

The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. 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 content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.

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

  2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id 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 is channel~content_language~feed_label~offer_id, for example: accounts/123/products/online~en~US~sku123.
regional_inventory

RegionalInventory

Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

ListLocalInventoriesRequest

Request message for the ListLocalInventories method.

Fields
parent

string

Required. The name of the parent product to list local inventories for. Format: accounts/{account}/products/{product}

The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. 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 content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.

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

  2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id 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 is channel~content_language~feed_label~offer_id, for example: accounts/123/products/online~en~US~sku123.
page_size

int32

The maximum number of LocalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the pageSize will default to the maximum
page_token

string

A page token, received from a previous ListLocalInventories call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListLocalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

ListLocalInventoriesResponse

Response message for the ListLocalInventories method.

Fields
local_inventories[]

LocalInventory

The LocalInventory resources for the given product from the specified account.
next_page_token

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListRegionalInventoriesRequest

Request message for the ListRegionalInventories method.

Fields
parent

string

Required. The name of the parent product to list RegionalInventory resources for. Format: accounts/{account}/products/{product}

The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. 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 content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.

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

  2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id 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 is channel~content_language~feed_label~offer_id, for example: accounts/123/products/online~en~US~sku123.
page_size

int32

The maximum number of RegionalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.
page_token

string

A page token, received from a previous ListRegionalInventories call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListRegionalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

ListRegionalInventoriesResponse

Response message for the ListRegionalInventories method.

Fields
regional_inventories[]

RegionalInventory

The RegionalInventory resources for the given product from the specified account.
next_page_token

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

LocalInventory

Local inventory information for the product. Represents in-store information for a specific product at the store specified by storeCode. For a list of all accepted attribute values, see the local product inventory data specification.

Fields
name

string

Output only. The name of the LocalInventory resource. Format: accounts/{account}/products/{product}/localInventories/{store_code}

The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. 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 content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.

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

  2. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id 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~content_language~feed_label~offer_id. For example, the full resource name for a local inventory at store_code "store123" would be: accounts/123/products/online~en~US~sku123/localInventories/store123.
account

int64

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

string

Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.
price

Price

Optional. Price of the product at this store.
sale_price

Price

Optional. Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.
sale_price_effective_date

Interval

Optional. The TimePeriod of the sale at this store.
custom_attributes[]
(deprecated)

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 at this store. For accepted attribute values, see the local product inventory data specification
quantity

int64

Quantity of the product available at this store. Must be greater than or equal to zero.
pickup_method

string

Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification
pickup_sla

string

Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with pickupMethod. For accepted attribute values, see the local product inventory data specification
instore_product_location

string

Location of the product inside the store. Maximum length is 20 bytes.

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.

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: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. 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 content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) 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 content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id 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~content_language~feed_label~offer_id. 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

int64

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

Price

Optional. Price of the product in this region.
sale_price

Price

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

Interval

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

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.