REST Resource: accounts.products.localInventories

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.

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

string

Output only. The name of the LocalInventory resource. Format: accounts/{account}/products/{product}/localInventories/{storeCode}
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 for more information.
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 is defined.
salePriceEffectiveDate

object (Interval)

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

string (int64 format)

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

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
pickupSla

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
instoreProductLocation

string

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

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.