metafield.set

Set a metafield value on a product, variant, collection, or the store.

• scope: catalog:write
• storefront-visible (bumps the catalog generation): yes
• destructive: no

Payload

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ownerType": {
      "type": "string",
      "enum": [
        "product",
        "variant",
        "collection",
        "store"
      ]
    },
    "ownerId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "namespace": {
      "type": "string",
      "pattern": "^(custom|app\\.[a-z0-9-]{2,32})$"
    },
    "key": {
      "type": "string",
      "pattern": "^[a-z0-9_]{1,64}$"
    },
    "value": {}
  },
  "required": [
    "ownerType",
    "ownerId",
    "namespace",
    "key",
    "value"
  ],
  "additionalProperties": false
}