Channels
(Beta) Query the channels available to a Square seller.
Table Specific Information
Select
The driver uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the driver.
- Id supports the following operators: =, IN.
- Status supports the following operator: =.
- ReferenceId supports the following operator: =.
- ReferenceType supports the following operator: =.
Retrieve all channels:
SELECT * FROM Channels
Retrieve a specific channel:
SELECT * FROM Channels WHERE Id = 'CH_0RauN49qbI5pcbqhVJDJi5H7qfkJuvBygSTD3QlQuYC'
Retrieve several channels at once by supplying their Ids with IN. The driver sends these to the Square bulk retrieve endpoint, so the list is served by a single request rather than one request per Id. The maximum BatchSize supported by Channels is 100, and a longer list is split across as many requests as needed. Note that = does not use this endpoint; a single-Id filter is answered by the per-channel request instead. An Id that does not match a channel is omitted from the results rather than reported as an error, so the row count can be lower than the number of Ids supplied.
SELECT Id, Name, Status FROM Channels WHERE Id IN ('CH_9C03D0B59', 'CH_6X139B5MN')
Retrieve active channels:
SELECT * FROM Channels WHERE Status = 'ACTIVE'
Columns
| Name | Type | Description |
| Id [KEY] | String | The channel's unique ID. |
| Name | String | The name of the channel. |
| Status | String | Status of the channel.
The allowed values are ACTIVE, INACTIVE. |
| MerchantId | String | The unique ID of the merchant this channel belongs to. |
| Version | Integer | The version number which is incremented each time an update is made to the channel. |
| ReferenceId | String | The ID of the external reference linked to this channel. |
| ReferenceType | String | The type of the external reference linked to this channel (e.g., SQUARE_ONLINE_SITE).
The allowed values are UNKNOWN_TYPE, LOCATION, FIRST_PARTY_INTEGRATION, OAUTH_APPLICATION, ONLINE_SITE, ONLINE_CHECKOUT, INVOICE, GIFT_CARD, GIFT_CARD_MARKETPLACE, RECURRING_SUBSCRIPTION, ONLINE_BOOKING_FLOW, SQUARE_ASSISTANT, CASH_LOCAL, POINT_OF_SALE, KIOSK. |
| ProcessedGdprForget | Boolean | Indicates whether a GDPR forget request has been processed for this channel. |
| CreatedAt | Datetime | Timestamp indicating when the channel was established, formatted per RFC 3339 standards. |
| UpdatedAt | Datetime | Timestamp indicating the most recent modification to the channel, formatted per RFC 3339 standards. |