Excel Add-In for Square

Build 21.0.8137

CatalogItemVariations

Query the available item variations.

Table Specific Information

Select

Retrieve all catalog item variations:

SELECT * FROM CatalogItemVariations

Insert

To create an item variation, you will need to specify the ItemId, PricingType, PriceMoneyAmount and PriceMoneyCurrency column, or ItemId and PricingType if PricingType is set to VARIABLE_PRICING. All the fields that are not read-only can be specified.

INSERT INTO CatalogItemVariations (ItemId, PricingType,PriceMoneyAmount,PriceMoneyCurrency) VALUES ('2I2UELJL4543VQJF4D4EU3EJO','FIXED_PRICING',1,'USD')

Creating an item variation, by specifying aggregate columns.

 INSERT INTO CatalogItemVariations (ItemId, Name, PricingType, PriceMoneyAmount, PriceMoneyCurrency, SKU, Upc, Ordinal, LocationOverrides, TrackInventory, InventoryAlertType,InventoryAlertThreshold,UserData,ServiceDuration,PresentAtAllLocations,AbsentAtLocationIds) VALUES ('YC77SWXPJLTUFUHCCYSGYMYD', 'MyItemVariations14','FIXED_PRICING',1,'USD', 'testSKU', 'testUPC', '2',
'[
  {
  "inventory_alert_threshold": 1, 
  "location_id": "92BYHNBR6W77E",
  }
 ]',
 true,'LOW_QUANTITY',3,'test',3,false,
 '[
   "92BYHNBR6W77E"
  ]')

  

Create an Item variation using TEMP Table.

 insert into catalogitemvariations(name,PricingType,itemid,pricemoneyamount,pricemoneycurrency) values ('hello','FIXED_PRICING','GZSJP2V2SE4KS2ZU7AJCLX5P',19900,USD  

 insert into catalogitemvariations(name,PricingType,itemid,pricemoneyamount,pricemoneycurrency) values ('test55','FIXED_PRICING','RSQPFRKIZZFWO3IV3UX3M5LM',20001,USD  

 INSERT INTO CatalogItems (Name, Description, ModifierListInfo) VALUES ('Jeep Rentals NEW', 'Our Daily Jeep Rates','CatalogItemVariations#Temp'  

Update

To Update an item, you will need to specify the Id column.

UPDATE CatalogItemVariations SET name='TestName1', PricingType = 'FIXED_PRICING', PriceMoneyAmount = 1010, PriceMoneyCurrency = 'USD', ItemId = 'OLCXWRVE7JD22TCS6NIRST6G', UserData = 'SEASONAL=TRUE' WHERE id='WNT7535N7AEJHJBMLRGGZXIK'

Delete

Delete a discount object by providing the Id of the discount object:

DELETE FROM CatalogItemVariations WHERE Id='32123'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The item variation's ID.

ItemId [KEY] String False

The ID of the CatalogItem associated with this item variation.

Name String False

The item variation's name.

UpdatedAt Datatime True

Last modification timestamp.

IsDeleted Boolean False

If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.

Sku String False

The item variation's SKU.

Upc String False

The item variation's UPC.

Ordinal Integer False

The order in which this item variation should be displayed.

PricingType String False

Indicates whether the item variation's price is fixed or determined at the time of sale.

PriceMoneyAmount Integer False

The item variation's price amount, if fixed pricing is used.

PriceMoneyCurrency String False

The item variation's price currency, if fixed pricing is used.

LocationOverrides String False

Per-location price and inventory overrides.

TrackInventory Boolean False

If true, inventory tracking is active for the variation.

InventoryAlertType String False

Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its InventoryAlertThreshold.

InventoryAlertThreshold Integer False

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

UserData String False

Arbitrary user metadata to associate with the item variation.

ServiceDuration Integer False

If the CatalogItem that owns this item variation is of type APPOINTMENTS_SERVICE, then this is the duration of the service in milliseconds.

CatalogMeasurementUnitId String True

Represents the unit used to measure a CatalogItemVariation and specifies the precision for decimal quantities.

MeasurementUnitId String False

ID of the 'CatalogMeasurementUnit' that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities.

PresentAtAllLocations Boolean False

If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.

PresentAtLocationIds String False

A list of locations where the object is present, even if PresentAtAllLocations is false.

AbsentAtLocationIds String False

A list of locations where the object is not present, even if PresentAtAllLocations is true.

Version Int64 False

The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137