ChannelMetafields

Returns a list of Channel Metafields.

Table Specific Information

Select

The provider uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

Id supports the = comparison.
ChannelId supports the = comparison. A value for ChannelId is required.
Key supports the = comparison.
Namespace supports the = comparison.

The rest of the filter is executed client-side within the provider.

For example, the following queries are processed server-side:

SELECT * FROM ChannelMetafields WHERE ChannelId = 1
SELECT * FROM ChannelMetafields WHERE ChannelId = 1 AND Id = 2

Insert

To insert a channel metafield, specify at least the following columns: ChannelId, Namespace, Key, Value, and PermissionSet. Description is optional.

INSERT INTO ChannelMetafields (ChannelId, Description, Namespace, Key, Value, PermissionSet) VALUES (1, 'test', 'Warehouse', 'location', '88', 'app_only')

Update

UPDATE ChannelMetafields SET Value = 'updatedtest' WHERE ChannelId = 1 AND Id = 3

Delete

DELETE FROM ChannelMetafields WHERE ChannelId = 1 AND Id = 3

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Unique ID of the Metafield.
ChannelId [KEY]	Integer	False	The Id of the corresponding channel.
DateCreated	Datetime	True	Date and time of the metafield's creation.
DateModified	Datetime	True	Date and time when the metafield was last updated.
Description	String	False	Description for the metafields.
Key	String	False	The name of the field.
Value	String	False	The value of the field.
Namespace	String	False	Namespace for the metafield, for organizational purposes.
OwnerClientId	String	True	ID of metafield's creator.
PermissionSet	String	False	Determines the visibility and writeability of the field by other API consumers. The allowed values are app_only, read, write, read_and_sf_access, write_and_sf_access.
ResourceId	Integer	True	The ID of the resource with which the metafield is associated.
ResourceType	String	True	The type of resource with which the metafield is associated. The allowed values are category, brand, product, variant.