- [Resource: LocalInventory](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories.md.txt#LocalInventory)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories.md.txt#LocalInventory.SCHEMA_REPRESENTATION)
- [LocalInventoryAttributes](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories.md.txt#LocalInventoryAttributes)
  - [JSON representation](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories.md.txt#LocalInventoryAttributes.SCHEMA_REPRESENTATION)
- [Availability](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories.md.txt#Availability)
- [PickupMethod](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories.md.txt#PickupMethod)
- [PickupSla](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories.md.txt#PickupSla)
- [Methods](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories.md.txt#METHODS_SUMMARY)

## Resource: 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](https://support.google.com/merchants/answer/3061342).

For more information, see [Add local inventory](https://developers.google.com/merchant/api/guides/inventories/add-local-inventory.md.txt) and [Update local inventory](https://developers.google.com/merchant/api/guides/inventories/update-local-inventory.md.txt).

| JSON representation |
|---|
| ``` { "name": string, "base64EncodedName": string, "account": string, "storeCode": string, "localInventoryAttributes": { object (`LocalInventoryAttributes`) } } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. The name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{storeCode}` 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 `storeCode` "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 `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. |
| `base64EncodedName` | `string` Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{storeCode}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `contentLanguage~feedLabel~offerId`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `storeCode` "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`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get). |
| `account` | `string (int64 format)` Output only. The account that owns the product. This field will be ignored if set by the client. |
| `storeCode` | `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](https://support.google.com/merchants/answer/3061342) for more information. |
| `localInventoryAttributes` | ``object (`LocalInventoryAttributes`)`` Optional. A list of local inventory attributes. |

## LocalInventoryAttributes

Local inventory attributes.

| JSON representation |
|---|
| ``` { "price": { object (`Price`) }, "salePrice": { object (`Price`) }, "salePriceEffectiveDate": { object (`Interval`) }, "loyaltyPrograms": [ { object (`InventoryLoyaltyProgram`) } ], "customAttributes": [ { object (`CustomAttribute`) } ], "availability": enum (`Availability`), "quantity": string, "pickupMethod": enum (`PickupMethod`), "pickupSla": enum (`PickupSla`), "instoreProductLocation": string, "localShippingLabel": string } ``` |

| Fields ||
|---|---|
| `price` | ``object (`Price`)`` Optional. Price of the product at this store. |
| `salePrice` | ``object (`Price`)`` Optional. Sale price of the product at this store. Mandatory if \[`salePriceEffectiveDate`\]\[LocalInventory.sale_price_effective_date\] is defined. |
| `salePriceEffectiveDate` | ``object (`Interval`)`` Optional. The `TimePeriod` of the sale at this store. |
| `loyaltyPrograms[]` | ``object (`InventoryLoyaltyProgram`)`` Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store. This field is used to show store-specific member prices on Local Inventory Ads (LIA). To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. For local inventory specific details, see the [Local inventory data specification](https://support.google.com/merchants/answer/3061342). |
| `customAttributes[]` | ``object (`CustomAttribute`)`` Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. |
| `availability` | ``enum (`Availability`)`` [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. |
| `quantity` | `string (int64 format)` Optional. Quantity of the product available at this store. Must be greater than or equal to zero. |
| `pickupMethod` | ``enum (`PickupMethod`)`` Optional. Supported [pickup method](https://support.google.com/merchants/answer/3061342) for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`. |
| `pickupSla` | ``enum (`PickupSla`)`` Optional. 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`. See more details [here](https://support.google.com/merchants/answer/3061342). |
| `instoreProductLocation` | `string` Optional. Location of the product inside the store. Maximum length is 20 bytes. |
| `localShippingLabel` | `string` Optional. Specifies a label associated with the shipping for the `LocalInventory` resource. Can be used to group local shipping services to this particular inventory item. For accepted field format, see the [Local delivery](https://support.google.com/merchants/answer/14819809#localdelivery) |

## Availability

[Availability](https://support.google.com/merchants/answer/3061342) of the product at this store.

| Enums ||
|---|---|
| `LOCAL_INVENTORY_AVAILABILITY_UNSPECIFIED` | Indicates that the availability is unspecified. |
| `IN_STOCK` | Indicates that the product is in stock. |
| `LIMITED_AVAILABILITY` | Indicates that the product is out of stock. |
| `ON_DISPLAY_TO_ORDER` | Indicates that the product is on display to order. |
| `OUT_OF_STOCK` | Indicates that the product is out of stock. |

## PickupMethod

Supported [pickup method](https://support.google.com/merchants/answer/3061342) for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`.

| Enums ||
|---|---|
| `PICKUP_METHOD_UNSPECIFIED` | Indicates that the pickup method is unspecified. |
| `BUY` | Indicates that the pickup method is Buy. |
| `RESERVE` | Indicates that the pickup method is Reserve. |
| `SHIP_TO_STORE` | Indicates that the pickup method is Ship to store. |
| `NOT_SUPPORTED` | Indicates that the pickup method is not supported. |

## PickupSla

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`. See more details [here](https://support.google.com/merchants/answer/3061342).

| Enums ||
|---|---|
| `PICKUP_SLA_UNSPECIFIED` | Indicates that the pickup SLA is unspecified. |
| `SAME_DAY` | Indicates that the pickup SLA is same day. |
| `NEXT_DAY` | Indicates that the pickup SLA is next day. |
| `TWO_DAY` | Indicates that the pickup SLA is two days. |
| `THREE_DAY` | Indicates that the pickup SLA is three days. |
| `FOUR_DAY` | Indicates that the pickup SLA is four days. |
| `FIVE_DAY` | Indicates that the pickup SLA is five days. |
| `SIX_DAY` | Indicates that the pickup SLA is six days. |
| `SEVEN_DAY` | Indicates that the pickup SLA is seven days. |
| `MULTI_WEEK` | Indicates that the pickup SLA is multi-week. |

| ## Methods ||
|---|---|
| ### `delete` | Deletes the specified `LocalInventory` from the given product in your merchant account. |
| ### `insert` | Inserts a `LocalInventory` resource to a product in your merchant account. |
| ### `list` | Lists the `LocalInventory` resources for the given product in your merchant account. |