REST Resource: localinventory

  • The LocalInventory resource allows you to manage and update the local inventory information for your products, including price, availability, and pickup options.

  • You can specify attributes like store code, price, sale price, availability, quantity, pickup method, and in-store product location using this resource.

  • LocalInventory supports custom attributes, letting you submit merchant-specific details about your products for a more comprehensive listing.

  • Utilize the custombatch and insert methods to update local inventory for multiple products or individual items within your Merchant Center account, respectively, leveraging the provided JSON representation and adhering to the local product inventory feed specifications.

Resource: LocalInventory

Local inventory resource. For accepted attribute values, see the local product inventory feed specification.

JSON representation
{
  "storeCode": string,
  "price": {
    object (Price)
  },
  "salePrice": {
    object (Price)
  },
  "salePriceEffectiveDate": string,
  "availability": string,
  "quantity": integer,
  "pickupMethod": string,
  "pickupSla": string,
  "instoreProductLocation": string,
  "kind": string,
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ]
}
Fields
storeCode

string

Required. The store code of this local inventory resource.

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 may be specified as 'null' if undecided.

availability

string

The availability of the product. For accepted attribute values, see the local product inventory feed specification.

quantity

integer (uint32 format)

The quantity of the product. Must be nonnegative.

pickupMethod

string

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

pickupSla

string

The expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. For accepted attribute values, see the local product inventory feed specification.

instoreProductLocation

string

The in-store product location.

kind

string

Identifies what kind of resource this is. Value: the fixed string "content#localInventory"

customAttributes[]

object (CustomAttribute)

A list of custom (merchant-provided) attributes. Can also be used to submit any attribute of the feed specification in its generic form, for example, { "name": "size type", "value": "regular" }.

Methods

custombatch

Updates local inventory for multiple products or stores in a single request.

insert

Updates the local inventory of a product in your Merchant Center account.