REST Resource: projects.locations.brands.stores.inventories

Resource: Inventory

An inventory resource for a store.

JSON representation
{
  "name": string,
  "itemId": string,
  "modifierId": string,
  "posId": string,
  "quantity": integer,
  "status": enum (Status)
}
Fields
name

string

Identifier. The resource name of the inventory. Format: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/inventories/{inventory}

itemId

string

Required. The item ID that this inventory belongs to.

modifierId

string

Optional. The modifier ID that this inventory belongs to.

posId

string

Optional. The point of sale (POS) ID associated with this inventory.

quantity

integer

Optional. The quantity of the item/modifier in stock.

status

enum (Status)

Optional. The status of the inventory.

Status

Availability status of the inventory.

Enums
STATUS_UNSPECIFIED Unspecified status.
IN_STOCK The item/modifier is in stock.
OUT_OF_STOCK The item/modifier is out of stock.

Methods

create

Creates an inventory.

delete

Deletes the specified inventory.

get

Gets an inventory.

list

Lists inventories.

patch

Updates the specified inventory.