• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
ItemVariationLocationOverrides

Price and inventory alerting overrides for a CatalogItemVariation at a specific Location.

Properties

Name Description
location_id
string

The ID of the Location. This can include locations that are deactivated.

price_money
Money

The price of the CatalogItemVariation at the given Location, or blank for variable pricing.

pricing_type
string

The pricing type (fixed or variable) for the CatalogItemVariation at the given Location.

track_inventory
boolean

If true, inventory tracking is active for the CatalogItemVariation at this Location.

inventory_alert_type
string

Indicates whether the CatalogItemVariation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold.

inventory_alert_threshold
integer (64-bit)

If the inventory quantity for the variation is less than or equal to this value and inventory_alert_type is LOW_QUANTITY, the variation displays an alert in the merchant dashboard.

This value is always an integer.

sold_out
boolean

Beta

Read only Indicates whether the overridden item variation is sold out at the specified location.

When inventory tracking is enabled on the item variation either globally or at the specified location, the item variation is automatically marked as sold out when its inventory count reaches zero. The seller can manually set the item variation as sold out even when the inventory count is greater than zero. Attempts by an application to set this attribute are ignored. Regardless how the sold-out status is set, applications should treat its inventory count as zero when this attribute value is true.

sold_out_valid_until
string

Beta

Read only The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation becomes available again at the specified location. Attempts by an application to set this attribute are ignored. When the current time is later than this attribute value, the affected item variation is no longer sold out.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00