LocalInventory

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-VVN-c2t1LzEyMw . The full resource name for the local inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/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.

base64_encoded_name

string

Output only. The unpadded base64url encoded name of the LocalInventory resource. Format: accounts/{account}/products/{product}/localInventories/{store_code} where the {product} segment is the unpadded base64url encoded value of the identifier of the form content_language~feed_label~offer_id . Example: accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123 for the decoded product ID en~US~sku/123 and store_code "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example GetLocalInventory .

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.