REST Resource: inventory

Resource: Inventory

JSON representation
{
  "price": {
    object (Price)
  },
  "availability": string,
  "salePrice": {
    object (Price)
  },
  "salePriceEffectiveDate": string,
  "quantity": integer,
  "sellOnGoogleQuantity": integer,
  "installment": {
    object (Installment)
  },
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "pickup": {
    object (InventoryPickup)
  },
  "instoreProductLocation": string,
  "customLabel0": string,
  "customLabel1": string,
  "customLabel2": string,
  "customLabel3": string,
  "customLabel4": string,
  "kind": string
}
Fields
price

object (Price)

The price of the product.

availability

string

The availability of the product.

Acceptable values are:

  • "in stock"
  • "out of stock"
  • "preorder"

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

quantity

integer (uint32 format)

The quantity of the product. Must be equal to or greater than zero. Supported only for local products.

sellOnGoogleQuantity

integer (uint32 format)

The quantity of the product that is available for selling on Google. Supported only for online products.

installment

object (Installment)

Number and amount of installments to pay for an item. Brazil only.

loyaltyPoints

object (LoyaltyPoints)

Loyalty points that users receive after purchasing the item. Japan only.

pickup

object (InventoryPickup)

Store pickup information. Only supported for local inventory. Not setting pickup means "don't update" while setting it to the empty value ({} in JSON) means "delete". Otherwise, pickupMethod and pickupSla must be set together, unless pickupMethod is "not supported".

instoreProductLocation

string

The instore product location. Supported only for local products.

customLabel0

string

Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.

customLabel1

string

Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products.

customLabel2

string

Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.

customLabel3

string

Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.

customLabel4

string

Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.

kind

string

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

InventoryPickup

JSON representation
{
  "pickupMethod": string,
  "pickupSla": string
}
Fields
pickupMethod

string

Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is "not supported", must be submitted together with pickupSla.

Acceptable values are:

  • "buy"
  • "not supported"
  • "reserve"
  • "ship to store"

pickupSla

string

The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with pickupMethod.

Acceptable values are:

  • "five day"
  • "four day"
  • "multi day"
  • "multi week"
  • "next day"
  • "same day"
  • "seven day"
  • "six day"
  • "three day"
  • "two day"

Methods

custombatch

Updates price and availability for multiple products or stores in a single request.

set

Updates price and availability of a product in your Merchant Center account.