Vendors

Create, update, and query the available Vendors in Square.

Table Specific Information

Select

The driver uses the Square API to process the following search criteria:

List all vendors. This will list both active and inactive vendors.

SELECT * from Vendors;

Retrieve a vendor through its 'Id':

SELECT * from Vendors WHERE Id = 'F5MMNGPNW2IZVRB2';

Retrieve a vendor through its 'Name':

SELECT * from Vendors WHERE Name = 'new-vendor';

List only active vendors:

SELECT * FROM Vendors WHERE Status = 'ACTIVE';

List only inactive vendors:

SELECT * FROM Vendors WHERE Status = 'INACTIVE';

Insert

To create a Vendor, the field 'Name' is required.

INSERT INTO Vendors (Name, AddressAddressLine1, AddressAddressLine2, AddressAddressLine3, AddressLocality, AddressSublocality, AddressSublocality2, AddressSublocality3, AddressAdministrativeDistrictLevel1, AddressAdministrativeDistrictLevel2, AddressAdministrativeDistrictLevel3, AddressPostalCode, AddressCountry, AddressFirstName, AddressLastName, AccountNumber, Note, Status) VALUES ('insert_4', 'a', 'b', 'c', 'locality', 'sub', 'sub2', 'sub3', 'AddressAdministrativeDistrictLevel1', 'AddressAdministrativeDistrictLevel2', 'AddressAdministrativeDistrictLevel3', '134003', 'IN', 'AddressFirstName', 'AddressLastName', '1234567890', 'this is a note.', 'ACTIVE');

INSERT INTO Vendors (Name, AccountNumber, Note, Status, Contacts) VALUES ('insert_8', '1234567890', 'this is a note.', 'ACTIVE', '[{"ordinal": 0, "name": "first_contact", "phone_number": "1234567890", "removed": false}, {"ordinal": 1, "name": "first_contact2", "phone_number": "1234567891", "removed": false}]');

Update

To update a Vendor record, the field 'Version' is required. The value which should be supplied to this field must be the same one the record currently has.

UPDATE Vendors SET Name = 'updated', AddressAddressLine1 = 'updated', AddressAddressLine2 = 'updated', AddressAddressLine3 = 'updated', AddressLocality = 'updated', AddressSublocality = 'updated', AddressSublocality2 = 'updated', AddressSublocality3 = 'updated', AddressAdministrativeDistrictLevel1 = 'updated', AddressAdministrativeDistrictLevel2 = 'updated', AddressAdministrativeDistrictLevel3 = 'updated', AddressPostalCode = 'updated', AddressCountry = 'AU', AddressFirstName = 'updated', AddressLastName = 'updated', Contacts = '[{"ordinal": 2,"email_address": "[email protected]","name": "updated1","phone_number": "5645645645","removed": false}, {"ordinal": 3,"email_address": "[email protected]","name": "updated2","phone_number": "1233211233","removed": false}]', AccountNumber = '9346', Note = 'updated', Version = 3, Status = 'INACTIVE' WHERE Id = 'YEA4LD6WXX6BJUZT';

Bulk Insert

Maximum BatchSize supported by Vendors is 100.

You can create Vendors in bulk using TEMP tables.

INSERT INTO Vendors#TEMP (Name, AddressCountry) VALUES ('s1', 'IN');

INSERT INTO Vendors#TEMP (Name, AddressCountry) VALUES ('s2', 'IN');

INSERT INTO Vendors (Name, AddressCountry) SELECT Name, Contacts FROM Vendors#TEMP;

Bulk Update