Excel Add-In for Square

Build 21.0.8137

CatalogModifierLists

Query the available catalog modifier lists.

Table Specific Information

Select

Retrieve all catalog modifier lists:

SELECT * FROM CatalogModifierLists

Insert

To create an item, you will need to specify the Name column and modifier object.

INSERT INTO CatalogModifierLists (Name,selectiontype,Modifiers) VALUES ('Type','MULTIPLE','[\n" +
        "\t{\n" +
        "\t  \"id\" : \"DSVHFBTUXMNTKUFSXMODS7HO\",\n" +
        "      \"type\": \"MODIFIER\",\n" +
        "      \"version\": 1489411961853,\n" +
        "      \"modifier_data\":{\n" +
        "\t  \"name\" : \"4 floor\",\n" +
        "\t  \"on_by_default\": false,\n" +
        "      \"price_money\": {\n" +
        "        \"currency\": \"USD\",\n" +
        "        \"amount\": 23900\n" +
        "      }\n" +
        "      }\n" +
        "    }]' 

Create a modifierlist object using TEMP table.

 INSERT INTO CatalogModifiers#Temp (Id,Type, Version,Name, PriceMoneyCurrency, PriceMoneyAmount) Values ('Y2R6VS3ZCF4GCLO2IJBJWMYR','MODIFIER',1591591604813,'4 door','USD', 23900) 

 INSERT INTO CatalogModifierLists (Name, SelectionType, Modifiers) VALUES ('Type Updated', 'MULTIPLE', 'CatalogModifiers#Temp' 

Update

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

UPDATE CatalogModifierLists set Name='list1' where id='1234'

Delete

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

DELETE FROM CatalogModifierLists WHERE Id='32123'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The CatalogModifierList's ID.

Name String False

The CatalogModifierList's name.

UpdatedAt Datetime False

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.

Modifiers String False

The options included in the CatalogModifierList. Each CatalogObject must have type MODIFIER and contain CatalogModifier data.

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.

SelectionType String False

Indicates whether multiple options from the modifier list can be applied to a single CatalogItem..

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