Sign in
Catalog

Creates a product Metafield.

post/catalog/brands/{brand_id}/metafields

Request body

permission_set'app_only' | 'read' | 'write'

Determines whether the field is completely private to the app that owns the field (app_only), or visible to other API consumers (read), or completely open for reading and writing to other apps (write).

namespacestring

Namespace for the metafield, for organizational purposes.

keystring

The name of the field, for example: location_id, color.

valuestring

The value of the field, for example: 1, blue.

descriptionstring

Description for the metafields.

resource_type'category' | 'brand' | 'product' | 'variant'

The type of resource with which the metafield is associated.

resource_idinteger

The unique identifier for the resource with which the metafield is associated.

Response

A Metafield object.

metaMeta

Empty meta object; may be used later.

Changes

No recorded changes to this endpoint across all 7 revisions of this API.