Google Shopping Merchant Inventories V1 Client - Class LocalInventoryAttributes (0.7.0)

Reference documentation and code samples for the Google Shopping Merchant Inventories V1 Client class LocalInventoryAttributes.

Local inventory attributes.

Generated from protobuf message google.shopping.merchant.inventories.v1.LocalInventoryAttributes

Namespace

Google \ Shopping \ Merchant \ Inventories \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ price Google\Shopping\Type\Price

Optional. Price of the product at this store.

↳ sale_price Google\Shopping\Type\Price

Optional. Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.

↳ sale_price_effective_date Google\Type\Interval

Optional. The TimePeriod of the sale at this store.

↳ availability int

Availability of the product at this store.

↳ quantity int|string

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

↳ pickup_method int

Optional. Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla.

↳ pickup_sla int

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.

↳ instore_product_location string

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

getPrice

Optional. Price of the product at this store.

Returns
Type Description
Google\Shopping\Type\Price|null

hasPrice

clearPrice

setPrice

Optional. Price of the product at this store.

Parameter
Name Description
var Google\Shopping\Type\Price
Returns
Type Description
$this

getSalePrice

Optional. Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.

Returns
Type Description
Google\Shopping\Type\Price|null

hasSalePrice

clearSalePrice

setSalePrice

Optional. Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.

Parameter
Name Description
var Google\Shopping\Type\Price
Returns
Type Description
$this

getSalePriceEffectiveDate

Optional. The TimePeriod of the sale at this store.

Returns
Type Description
Google\Type\Interval|null

hasSalePriceEffectiveDate

clearSalePriceEffectiveDate

setSalePriceEffectiveDate

Optional. The TimePeriod of the sale at this store.

Parameter
Name Description
var Google\Type\Interval
Returns
Type Description
$this

getAvailability

Availability of the product at this store.

Returns
Type Description
int

hasAvailability

clearAvailability

setAvailability

Availability of the product at this store.

Parameter
Name Description
var int
Returns
Type Description
$this

getQuantity

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

Returns
Type Description
int|string

hasQuantity

clearQuantity

setQuantity

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getPickupMethod

Optional. Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla.

Returns
Type Description
int

hasPickupMethod

clearPickupMethod

setPickupMethod

Optional. Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla.

Parameter
Name Description
var int
Returns
Type Description
$this

getPickupSla

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.

Returns
Type Description
int

hasPickupSla

clearPickupSla

setPickupSla

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getInstoreProductLocation

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

Returns
Type Description
string

hasInstoreProductLocation

clearInstoreProductLocation

setInstoreProductLocation

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

Parameter
Name Description
var string
Returns
Type Description
$this