Webhook events

Attribute option created

EVENT attribute_options/create App scope: read_products Staff permission: products:write

Fired when a new option is added to an attribute.

Payload fields

Field	Type	Description
`option.id`	`integer`	Always present
`option.store_seq_id`	`integer`	Selectable in the Payload builder
`option.attribute_id`	`integer`	Selectable in the Payload builder
`option.label`	`string`	Selectable in the Payload builder
`option.value`	`string`	Selectable in the Payload builder
`option.color`	`string`	Selectable in the Payload builder
`option.file_id`	`string`	Selectable in the Payload builder
`option.file_url`	`string`	Selectable in the Payload builder
`option.file_cdn_url`	`string`	Selectable in the Payload builder
`option.sort_order`	`integer`	Selectable in the Payload builder
`option.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "option": {
    "attribute_id": 1,
    "color": "#D64545",
    "created_at": "2026-06-09T12:00:00+05:30",
    "file_cdn_url": "",
    "file_id": null,
    "file_url": "",
    "id": 1,
    "label": "Red",
    "sort_order": 0,
    "store_seq_id": 1,
    "value": "red"
  }
}

Attribute option deleted

EVENT attribute_options/delete App scope: read_products Staff permission: products:write

Fired when an attribute option is removed.

Payload fields

Field	Type	Description
`option.id`	`integer`	Always present
`option.store_seq_id`	`integer`	Selectable in the Payload builder
`option.label`	`string`	Selectable in the Payload builder
`option.value`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "option": {
    "id": 1,
    "label": "Red",
    "store_seq_id": 1,
    "value": "red"
  }
}

Attribute options reordered

EVENT attribute_options/reorder App scope: read_products Staff permission: products:write

Fired when the sort order of options within an attribute changes. Payload carries the attribute_id plus the ordered option_id list.

Payload fields

Field	Type	Description
`attribute_id`	`integer`	Always present
`option_ids`	`array`	Always present

Payload shape

Sample payload

{
  "attribute_id": 7,
  "option_ids": [
    41,
    42,
    43
  ]
}

Attribute option translations deleted

EVENT attribute_options/translations/delete App scope: read_products Staff permission: products:write

Fired when an attribute option's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`option.id`	`integer`	Always present
`option.store_seq_id`	`integer`	Selectable in the Payload builder
`option.attribute_id`	`integer`	Selectable in the Payload builder
`option.label`	`string`	Selectable in the Payload builder
`option.value`	`string`	Selectable in the Payload builder
`option.color`	`string`	Selectable in the Payload builder
`option.file_id`	`string`	Selectable in the Payload builder
`option.file_url`	`string`	Selectable in the Payload builder
`option.file_cdn_url`	`string`	Selectable in the Payload builder
`option.sort_order`	`integer`	Selectable in the Payload builder
`option.created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.label`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "option": {
    "attribute_id": 1,
    "color": "#D64545",
    "created_at": "2026-06-09T12:00:00+05:30",
    "file_cdn_url": "",
    "file_id": null,
    "file_url": "",
    "id": 1,
    "label": "Red",
    "sort_order": 0,
    "store_seq_id": 1,
    "value": "red"
  },
  "translation": {
    "label": "",
    "value": ""
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Attribute option translations updated

EVENT attribute_options/translations/update App scope: read_products Staff permission: products:write

Fired when an attribute option's translations are added or updated for a locale. Payload carries only the fields that changed.

Payload fields

Field	Type	Description
`option.id`	`integer`	Always present
`option.store_seq_id`	`integer`	Selectable in the Payload builder
`option.attribute_id`	`integer`	Selectable in the Payload builder
`option.label`	`string`	Selectable in the Payload builder
`option.value`	`string`	Selectable in the Payload builder
`option.color`	`string`	Selectable in the Payload builder
`option.file_id`	`string`	Selectable in the Payload builder
`option.file_url`	`string`	Selectable in the Payload builder
`option.file_cdn_url`	`string`	Selectable in the Payload builder
`option.sort_order`	`integer`	Selectable in the Payload builder
`option.created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.label`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "option": {
    "attribute_id": 1,
    "color": "#D64545",
    "created_at": "2026-06-09T12:00:00+05:30",
    "file_cdn_url": "",
    "file_id": null,
    "file_url": "",
    "id": 1,
    "label": "Red",
    "sort_order": 0,
    "store_seq_id": 1,
    "value": "red"
  },
  "translation": {
    "label": "Rouge",
    "value": "rouge"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Attribute option updated

EVENT attribute_options/update App scope: read_products Staff permission: products:write

Fired when an existing attribute option is updated.

Payload fields

Field	Type	Description
`option.id`	`integer`	Always present
`option.store_seq_id`	`integer`	Selectable in the Payload builder
`option.attribute_id`	`integer`	Selectable in the Payload builder
`option.label`	`string`	Selectable in the Payload builder
`option.value`	`string`	Selectable in the Payload builder
`option.color`	`string`	Selectable in the Payload builder
`option.file_id`	`string`	Selectable in the Payload builder
`option.file_url`	`string`	Selectable in the Payload builder
`option.file_cdn_url`	`string`	Selectable in the Payload builder
`option.sort_order`	`integer`	Selectable in the Payload builder
`option.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "option": {
    "attribute_id": 1,
    "color": "#D64545",
    "created_at": "2026-06-09T12:00:00+05:30",
    "file_cdn_url": "",
    "file_id": null,
    "file_url": "",
    "id": 1,
    "label": "Red",
    "sort_order": 0,
    "store_seq_id": 1,
    "value": "red"
  }
}

Attribute created

EVENT attributes/create App scope: read_products Staff permission: products:write

Fired when a product attribute is created.

Payload fields

Field	Type	Description
`attribute.id`	`integer`	Always present
`attribute.store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.name`	`string`	Selectable in the Payload builder
`attribute.slug`	`string`	Selectable in the Payload builder
`attribute.description`	`string`	Selectable in the Payload builder
`attribute.sub_type`	`string`	Selectable in the Payload builder
`attribute.sort_order`	`integer`	Selectable in the Payload builder
`attribute.in_use`	`boolean`	Selectable in the Payload builder
`attribute.variant_usage_count`	`integer`	Selectable in the Payload builder
`attribute.created_at`	`string`	Selectable in the Payload builder
`attribute.updated_at`	`string`	Selectable in the Payload builder
`attribute.options[*].id`	`integer`	Always present
`attribute.options[*].store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.options[*].attribute_id`	`integer`	Selectable in the Payload builder
`attribute.options[*].label`	`string`	Selectable in the Payload builder
`attribute.options[*].value`	`string`	Selectable in the Payload builder
`attribute.options[*].color`	`string`	Selectable in the Payload builder
`attribute.options[*].file_id`	`string`	Selectable in the Payload builder
`attribute.options[*].file_url`	`string`	Selectable in the Payload builder
`attribute.options[*].file_cdn_url`	`string`	Selectable in the Payload builder
`attribute.options[*].sort_order`	`integer`	Selectable in the Payload builder
`attribute.options[*].created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "attribute": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Product color.",
    "id": 1,
    "in_use": false,
    "name": "Color",
    "options": [
      {
        "attribute_id": 1,
        "color": "#D64545",
        "created_at": "2026-06-09T12:00:00+05:30",
        "file_cdn_url": "",
        "file_id": null,
        "file_url": "",
        "id": 1,
        "label": "Red",
        "sort_order": 0,
        "store_seq_id": 1,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 0,
    "store_seq_id": 1,
    "sub_type": "swatch",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variant_usage_count": 0
  }
}

Attribute deleted

EVENT attributes/delete App scope: read_products Staff permission: products:write

Fired when a product attribute is deleted. Payload carries the attribute plus the options that cascaded with it.

Payload fields

Field	Type	Description
`attribute.id`	`integer`	Always present
`attribute.store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.name`	`string`	Selectable in the Payload builder
`attribute.slug`	`string`	Selectable in the Payload builder
`attribute.sub_type`	`string`	Selectable in the Payload builder
`attribute.options[*].id`	`integer`	Always present
`attribute.options[*].store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.options[*].label`	`string`	Selectable in the Payload builder
`attribute.options[*].value`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "attribute": {
    "id": 1,
    "name": "Color",
    "options": [
      {
        "id": 1,
        "label": "Red",
        "store_seq_id": 1,
        "value": "red"
      }
    ],
    "slug": "color",
    "store_seq_id": 1,
    "sub_type": "swatch"
  }
}

Attributes reordered

EVENT attributes/reorder App scope: read_products Staff permission: products:write

Fired when the sort order of attributes is changed. Payload carries the ordered id list.

Payload fields

Field	Type	Description
`attribute_ids`	`array`	Always present

Payload shape

Sample payload

{
  "attribute_ids": [
    7,
    8,
    9
  ]
}

Attribute translations deleted

EVENT attributes/translations/delete App scope: read_products Staff permission: products:write

Fired when an attribute's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`attribute.id`	`integer`	Always present
`attribute.store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.name`	`string`	Selectable in the Payload builder
`attribute.slug`	`string`	Selectable in the Payload builder
`attribute.description`	`string`	Selectable in the Payload builder
`attribute.sub_type`	`string`	Selectable in the Payload builder
`attribute.sort_order`	`integer`	Selectable in the Payload builder
`attribute.in_use`	`boolean`	Selectable in the Payload builder
`attribute.variant_usage_count`	`integer`	Selectable in the Payload builder
`attribute.created_at`	`string`	Selectable in the Payload builder
`attribute.updated_at`	`string`	Selectable in the Payload builder
`attribute.options[*].id`	`integer`	Always present
`attribute.options[*].store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.options[*].attribute_id`	`integer`	Selectable in the Payload builder
`attribute.options[*].label`	`string`	Selectable in the Payload builder
`attribute.options[*].value`	`string`	Selectable in the Payload builder
`attribute.options[*].color`	`string`	Selectable in the Payload builder
`attribute.options[*].file_id`	`string`	Selectable in the Payload builder
`attribute.options[*].file_url`	`string`	Selectable in the Payload builder
`attribute.options[*].file_cdn_url`	`string`	Selectable in the Payload builder
`attribute.options[*].sort_order`	`integer`	Selectable in the Payload builder
`attribute.options[*].created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "attribute": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Product color.",
    "id": 1,
    "in_use": true,
    "name": "Color",
    "options": [
      {
        "attribute_id": 1,
        "color": "#D64545",
        "created_at": "2026-06-09T12:00:00+05:30",
        "file_cdn_url": "",
        "file_id": null,
        "file_url": "",
        "id": 1,
        "label": "Red",
        "sort_order": 0,
        "store_seq_id": 1,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 0,
    "store_seq_id": 1,
    "sub_type": "swatch",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variant_usage_count": 12
  },
  "locale": "fr",
  "translation": {
    "description": "",
    "name": "",
    "slug": ""
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Attribute translations updated

EVENT attributes/translations/update App scope: read_products Staff permission: products:write

Fired when an attribute's translations are added or updated for a locale. Payload carries only the fields that changed.

Payload fields

Field	Type	Description
`attribute.id`	`integer`	Always present
`attribute.store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.name`	`string`	Selectable in the Payload builder
`attribute.slug`	`string`	Selectable in the Payload builder
`attribute.description`	`string`	Selectable in the Payload builder
`attribute.sub_type`	`string`	Selectable in the Payload builder
`attribute.sort_order`	`integer`	Selectable in the Payload builder
`attribute.in_use`	`boolean`	Selectable in the Payload builder
`attribute.variant_usage_count`	`integer`	Selectable in the Payload builder
`attribute.created_at`	`string`	Selectable in the Payload builder
`attribute.updated_at`	`string`	Selectable in the Payload builder
`attribute.options[*].id`	`integer`	Always present
`attribute.options[*].store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.options[*].attribute_id`	`integer`	Selectable in the Payload builder
`attribute.options[*].label`	`string`	Selectable in the Payload builder
`attribute.options[*].value`	`string`	Selectable in the Payload builder
`attribute.options[*].color`	`string`	Selectable in the Payload builder
`attribute.options[*].file_id`	`string`	Selectable in the Payload builder
`attribute.options[*].file_url`	`string`	Selectable in the Payload builder
`attribute.options[*].file_cdn_url`	`string`	Selectable in the Payload builder
`attribute.options[*].sort_order`	`integer`	Selectable in the Payload builder
`attribute.options[*].created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "attribute": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Product color.",
    "id": 1,
    "in_use": true,
    "name": "Color",
    "options": [
      {
        "attribute_id": 1,
        "color": "#D64545",
        "created_at": "2026-06-09T12:00:00+05:30",
        "file_cdn_url": "",
        "file_id": null,
        "file_url": "",
        "id": 1,
        "label": "Red",
        "sort_order": 0,
        "store_seq_id": 1,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 0,
    "store_seq_id": 1,
    "sub_type": "swatch",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variant_usage_count": 12
  },
  "locale": "fr",
  "translation": {
    "description": "Choix de couleur.",
    "name": "Couleur",
    "slug": "couleur"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Attribute updated

EVENT attributes/update App scope: read_products Staff permission: products:write

Fired when a product attribute is updated.

Payload fields

Field	Type	Description
`attribute.id`	`integer`	Always present
`attribute.store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.name`	`string`	Selectable in the Payload builder
`attribute.slug`	`string`	Selectable in the Payload builder
`attribute.description`	`string`	Selectable in the Payload builder
`attribute.sub_type`	`string`	Selectable in the Payload builder
`attribute.sort_order`	`integer`	Selectable in the Payload builder
`attribute.in_use`	`boolean`	Selectable in the Payload builder
`attribute.variant_usage_count`	`integer`	Selectable in the Payload builder
`attribute.created_at`	`string`	Selectable in the Payload builder
`attribute.updated_at`	`string`	Selectable in the Payload builder
`attribute.options[*].id`	`integer`	Always present
`attribute.options[*].store_seq_id`	`integer`	Selectable in the Payload builder
`attribute.options[*].attribute_id`	`integer`	Selectable in the Payload builder
`attribute.options[*].label`	`string`	Selectable in the Payload builder
`attribute.options[*].value`	`string`	Selectable in the Payload builder
`attribute.options[*].color`	`string`	Selectable in the Payload builder
`attribute.options[*].file_id`	`string`	Selectable in the Payload builder
`attribute.options[*].file_url`	`string`	Selectable in the Payload builder
`attribute.options[*].file_cdn_url`	`string`	Selectable in the Payload builder
`attribute.options[*].sort_order`	`integer`	Selectable in the Payload builder
`attribute.options[*].created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "attribute": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Product color.",
    "id": 1,
    "in_use": true,
    "name": "Color",
    "options": [
      {
        "attribute_id": 1,
        "color": "#D64545",
        "created_at": "2026-06-09T12:00:00+05:30",
        "file_cdn_url": "",
        "file_id": null,
        "file_url": "",
        "id": 1,
        "label": "Red",
        "sort_order": 0,
        "store_seq_id": 1,
        "value": "red"
      }
    ],
    "slug": "color",
    "sort_order": 0,
    "store_seq_id": 1,
    "sub_type": "swatch",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variant_usage_count": 12
  }
}

Blog author created

EVENT blog_authors/create App scope: read_blog Staff permission: blog:write

Fired when a blog author is created.

Payload fields

Field	Type	Description
`blog_author.id`	`string`	Always present
`blog_author.name`	`string`	Selectable in the Payload builder
`blog_author.slug`	`string`	Selectable in the Payload builder
`blog_author.bio`	`string`	Selectable in the Payload builder
`blog_author.avatar_url`	`string`	Selectable in the Payload builder
`blog_author.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_author": {
    "avatar_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "bio": "Writes product and company updates.",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "44bf70b7-88e2-4770-a30e-d7a1db522499",
    "name": "Avery Stone",
    "slug": "avery-stone"
  }
}

Blog author deleted

EVENT blog_authors/delete App scope: read_blog Staff permission: blog:write

Fired when a blog author is deleted.

Payload fields

Field	Type	Description
`blog_author.id`	`string`	Always present
`blog_author.name`	`string`	Selectable in the Payload builder
`blog_author.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_author": {
    "id": "44bf70b7-88e2-4770-a30e-d7a1db522499",
    "name": "Avery Stone",
    "slug": "avery-stone"
  }
}

Blog author updated

EVENT blog_authors/update App scope: read_blog Staff permission: blog:write

Fired when a blog author is updated.

Payload fields

Field	Type	Description
`blog_author.id`	`string`	Always present
`blog_author.name`	`string`	Selectable in the Payload builder
`blog_author.slug`	`string`	Selectable in the Payload builder
`blog_author.bio`	`string`	Selectable in the Payload builder
`blog_author.avatar_url`	`string`	Selectable in the Payload builder
`blog_author.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_author": {
    "avatar_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "bio": "Writes product and company updates.",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "44bf70b7-88e2-4770-a30e-d7a1db522499",
    "name": "Avery Stone",
    "slug": "avery-stone"
  }
}

Blog category created

EVENT blog_categories/create App scope: read_blog Staff permission: blog:write

Fired when a blog category is created.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`blog_category.description`	`string`	Selectable in the Payload builder
`blog_category.seo_title`	`string`	Selectable in the Payload builder
`blog_category.seo_description`	`string`	Selectable in the Payload builder
`blog_category.template_handle`	`string`	Selectable in the Payload builder
`blog_category.post_count`	`integer`	Selectable in the Payload builder
`blog_category.created_at`	`string`	Selectable in the Payload builder
`blog_category.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Updates and announcements from the company.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "post_count": 8,
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "template_handle": "default_blog_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Blog category deleted

EVENT blog_categories/delete App scope: read_blog Staff permission: blog:write

Fired when a blog category is deleted.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "slug": "company-news"
  }
}

Blog category translations deleted

EVENT blog_categories/translations/delete App scope: read_blog Staff permission: blog:write

Fired when a blog category's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`blog_category.description`	`string`	Selectable in the Payload builder
`blog_category.seo_title`	`string`	Selectable in the Payload builder
`blog_category.seo_description`	`string`	Selectable in the Payload builder
`blog_category.template_handle`	`string`	Selectable in the Payload builder
`blog_category.post_count`	`integer`	Selectable in the Payload builder
`blog_category.created_at`	`string`	Selectable in the Payload builder
`blog_category.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Updates and announcements from the company.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "post_count": 8,
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "template_handle": "default_blog_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "description": "",
    "name": "",
    "seo_description": "",
    "seo_title": "",
    "slug": ""
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog category translations updated

EVENT blog_categories/translations/update App scope: read_blog Staff permission: blog:write

Fired when a blog category's translations are added or updated for a locale.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`blog_category.description`	`string`	Selectable in the Payload builder
`blog_category.seo_title`	`string`	Selectable in the Payload builder
`blog_category.seo_description`	`string`	Selectable in the Payload builder
`blog_category.template_handle`	`string`	Selectable in the Payload builder
`blog_category.post_count`	`integer`	Selectable in the Payload builder
`blog_category.created_at`	`string`	Selectable in the Payload builder
`blog_category.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Updates and announcements from the company.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "post_count": 8,
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "template_handle": "default_blog_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "description": "Actualités et annonces de l’entreprise.",
    "name": "Actualités de l’entreprise",
    "seo_description": "Lisez les actualités et annonces de l’entreprise.",
    "seo_title": "Actualités de l’entreprise",
    "slug": "actualites-entreprise"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog category updated

EVENT blog_categories/update App scope: read_blog Staff permission: blog:write

Fired when a blog category is updated.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`blog_category.description`	`string`	Selectable in the Payload builder
`blog_category.seo_title`	`string`	Selectable in the Payload builder
`blog_category.seo_description`	`string`	Selectable in the Payload builder
`blog_category.template_handle`	`string`	Selectable in the Payload builder
`blog_category.post_count`	`integer`	Selectable in the Payload builder
`blog_category.created_at`	`string`	Selectable in the Payload builder
`blog_category.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Updates and announcements from the company.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "post_count": 8,
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "template_handle": "default_blog_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Blog category metafield value created

EVENT blog_category_metafields/create App scope: read_blog Staff permission: blog:write

Fired when a blog category metafield value is created.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "slug": "company-news"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "A short category subtitle.",
      "id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
      "is_translatable": true,
      "key": "subtitle",
      "max_list_items": null,
      "max_value_length": 120,
      "merchant_access": "read_write",
      "name": "Subtitle",
      "namespace": "details",
      "owner_type": "blog_category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "Latest company news",
    "display_value_map": {
      "en": "Latest company news"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Latest company news"
  }
}

Blog category metafield value deleted

EVENT blog_category_metafields/delete App scope: read_blog Staff permission: blog:write

Fired when a blog category metafield value is deleted, including when its blog category is deleted.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "slug": "company-news"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "A short category subtitle.",
      "id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
      "is_translatable": true,
      "key": "subtitle",
      "max_list_items": null,
      "max_value_length": 120,
      "merchant_access": "read_write",
      "name": "Subtitle",
      "namespace": "details",
      "owner_type": "blog_category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "Latest company news",
    "display_value_map": {
      "en": "Latest company news"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Latest company news"
  }
}

Blog category metafield translations deleted

EVENT blog_category_metafields/translations/delete App scope: read_blog Staff permission: blog:write

Fired when a blog category metafield's translation is cleared for a locale, including when its blog category is deleted.

Payload fields

Field	Type	Description
`metafield.blog_category_id`	`string`	Always present
`metafield.blog_category_name`	`string`	Selectable in the Payload builder
`metafield.blog_category_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "private",
    "app_id": null,
    "blog_category_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "blog_category_name": "Company News",
    "blog_category_slug": "company-news",
    "definition_id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
    "key": "subtitle",
    "merchant_access": "read_write",
    "name": "Subtitle",
    "namespace": "details",
    "type": "string"
  },
  "translation": {
    "value": null
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog category metafield translations updated

EVENT blog_category_metafields/translations/update App scope: read_blog Staff permission: blog:write

Fired when a blog category metafield's translation is added or updated for a locale.

Payload fields

Field	Type	Description
`metafield.blog_category_id`	`string`	Always present
`metafield.blog_category_name`	`string`	Selectable in the Payload builder
`metafield.blog_category_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "private",
    "app_id": null,
    "blog_category_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "blog_category_name": "Company News",
    "blog_category_slug": "company-news",
    "definition_id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
    "key": "subtitle",
    "merchant_access": "read_write",
    "name": "Subtitle",
    "namespace": "details",
    "type": "string"
  },
  "translation": {
    "value": "Dernières nouvelles"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog category metafield value updated

EVENT blog_category_metafields/update App scope: read_blog Staff permission: blog:write

Fired when a blog category metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "slug": "company-news"
  },
  "changed_fields": [
    "value"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "A short category subtitle.",
      "id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
      "is_translatable": true,
      "key": "subtitle",
      "max_list_items": null,
      "max_value_length": 120,
      "merchant_access": "read_write",
      "name": "Subtitle",
      "namespace": "details",
      "owner_type": "blog_category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "Latest company news",
    "display_value_map": {
      "en": "Latest company news"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Latest company news"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "A short category subtitle.",
      "id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
      "is_translatable": true,
      "key": "subtitle",
      "max_list_items": null,
      "max_value_length": 120,
      "merchant_access": "read_write",
      "name": "Subtitle",
      "namespace": "details",
      "owner_type": "blog_category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "Company updates",
    "display_value_map": {
      "en": "Company updates"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Company updates"
  }
}

Blog comment received

EVENT blog_comments/create App scope: read_blog Staff permission: blog:write

Fired when a shopper submits a blog comment (pending or approved per the store's moderation setting).

Payload fields

Field	Type	Description
`blog_comment.id`	`string`	Always present
`blog_comment.post_id`	`string`	Always present
`blog_comment.post_title`	`string`	Selectable in the Payload builder
`blog_comment.post_slug`	`string`	Selectable in the Payload builder
`blog_comment.customer_id`	`string`	Selectable in the Payload builder
`blog_comment.author_name`	`string`	Always present
`blog_comment.content`	`string`	Always present
`blog_comment.status`	`string`	Always present
`blog_comment.created_at`	`string`	Always present

Payload shape

Sample payload

{
  "blog_comment": {
    "author_name": "Avery Stone",
    "content": "Great update.",
    "created_at": "2026-09-01T12:00:00+05:30",
    "customer_id": null,
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "post_id": "3a588f80-fd8c-4d46-af1b-00a1c4a7f85a",
    "post_slug": "launch-notes",
    "post_title": "Launch notes",
    "status": "pending"
  }
}

Blog comment deleted

EVENT blog_comments/delete App scope: read_blog Staff permission: blog:write

Fired when a merchant permanently deletes a blog comment, including when deleting one or more parent posts cascades their comments.

Payload fields

Field	Type	Description
`blog_comment.id`	`string`	Always present
`blog_comment.post_id`	`string`	Always present
`blog_comment.post_title`	`string`	Selectable in the Payload builder
`blog_comment.post_slug`	`string`	Selectable in the Payload builder
`blog_comment.customer_id`	`string`	Selectable in the Payload builder
`blog_comment.author_name`	`string`	Always present
`blog_comment.content`	`string`	Always present
`blog_comment.status`	`string`	Always present
`blog_comment.created_at`	`string`	Always present

Payload shape

Sample payload

{
  "blog_comment": {
    "author_name": "Avery Stone",
    "content": "Great update.",
    "created_at": "2026-09-01T12:00:00+05:30",
    "customer_id": null,
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "post_id": "3a588f80-fd8c-4d46-af1b-00a1c4a7f85a",
    "post_slug": "launch-notes",
    "post_title": "Launch notes",
    "status": "pending"
  }
}

Blog comment updated

EVENT blog_comments/update App scope: read_blog Staff permission: blog:write

Fired when a merchant changes a blog comment's moderation status.

Payload fields

Field	Type	Description
`blog_comment.id`	`string`	Always present
`blog_comment.post_id`	`string`	Always present
`blog_comment.post_title`	`string`	Selectable in the Payload builder
`blog_comment.post_slug`	`string`	Selectable in the Payload builder
`blog_comment.customer_id`	`string`	Selectable in the Payload builder
`blog_comment.author_name`	`string`	Always present
`blog_comment.content`	`string`	Always present
`blog_comment.status`	`string`	Always present
`blog_comment.created_at`	`string`	Always present

Payload shape

Sample payload

{
  "blog_comment": {
    "author_name": "Avery Stone",
    "content": "Great update.",
    "created_at": "2026-09-01T12:00:00+05:30",
    "customer_id": null,
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "post_id": "3a588f80-fd8c-4d46-af1b-00a1c4a7f85a",
    "post_slug": "launch-notes",
    "post_title": "Launch notes",
    "status": "pending"
  }
}

Blog List SEO translations deleted

EVENT blog_list_seo/translations/delete App scope: read_blog Staff permission: blog:write

Fired when translated SEO fields are cleared for the public blog index in a locale.

Payload fields

Field	Type	Description
`blog_list_seo.page_type`	`string`	Always present The stable public blog-index identity, blog_list.
`blog_list_seo.seo_title`	`string`	Selectable in the Payload builder The blog index SEO title in the store's default language.
`blog_list_seo.seo_description`	`string`	Selectable in the Payload builder The blog index SEO description in the store's default language.
`blog_list_seo.social_title`	`string`	Selectable in the Payload builder The default-language social sharing title override.
`blog_list_seo.social_description`	`string`	Selectable in the Payload builder The default-language social sharing description override.
`blog_list_seo.social_image_id`	`string`	Selectable in the Payload builder The assigned site-asset image id, or null when no override is assigned.
`blog_list_seo.robots_index`	`boolean`	Selectable in the Payload builder Whether search engines may index the blog index.
`blog_list_seo.robots_follow`	`boolean`	Selectable in the Payload builder Whether search engines may follow links from the blog index.
`blog_list_seo.updated_at`	`string`	Selectable in the Payload builder When the source blog-index SEO settings last changed.
`locale`	`string`	Always present The locale whose Blog List SEO translation changed.
`translation.seo_title`	`string`	Selectable in the Payload builder The translated SEO title; empty on delete means it was removed.
`translation.seo_description`	`string`	Selectable in the Payload builder The translated SEO description; empty on delete means it was removed.
`translation.social_title`	`string`	Selectable in the Payload builder The translated social title; empty on delete means it was removed.
`translation.social_description`	`string`	Selectable in the Payload builder The translated social description; empty on delete means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's Blog List SEO translation changed.

Payload shape

Sample payload

{
  "blog_list_seo": {
    "page_type": "blog_list",
    "robots_follow": true,
    "robots_index": true,
    "seo_description": "News, guides, and updates.",
    "seo_title": "Stories from our store",
    "social_description": "Read our latest stories.",
    "social_image_id": null,
    "social_title": "Our blog",
    "updated_at": "2026-09-01T12:00:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "seo_description": "",
    "seo_title": "",
    "social_description": "",
    "social_title": ""
  },
  "updated_at": "2026-09-01T12:00:00+05:30"
}

Blog List SEO translations updated

EVENT blog_list_seo/translations/update App scope: read_blog Staff permission: blog:write

Fired when translated SEO fields are added or updated for the public blog index in a locale.

Payload fields

Field	Type	Description
`blog_list_seo.page_type`	`string`	Always present The stable public blog-index identity, blog_list.
`blog_list_seo.seo_title`	`string`	Selectable in the Payload builder The blog index SEO title in the store's default language.
`blog_list_seo.seo_description`	`string`	Selectable in the Payload builder The blog index SEO description in the store's default language.
`blog_list_seo.social_title`	`string`	Selectable in the Payload builder The default-language social sharing title override.
`blog_list_seo.social_description`	`string`	Selectable in the Payload builder The default-language social sharing description override.
`blog_list_seo.social_image_id`	`string`	Selectable in the Payload builder The assigned site-asset image id, or null when no override is assigned.
`blog_list_seo.robots_index`	`boolean`	Selectable in the Payload builder Whether search engines may index the blog index.
`blog_list_seo.robots_follow`	`boolean`	Selectable in the Payload builder Whether search engines may follow links from the blog index.
`blog_list_seo.updated_at`	`string`	Selectable in the Payload builder When the source blog-index SEO settings last changed.
`locale`	`string`	Always present The locale whose Blog List SEO translation changed.
`translation.seo_title`	`string`	Selectable in the Payload builder The translated SEO title; empty on delete means it was removed.
`translation.seo_description`	`string`	Selectable in the Payload builder The translated SEO description; empty on delete means it was removed.
`translation.social_title`	`string`	Selectable in the Payload builder The translated social title; empty on delete means it was removed.
`translation.social_description`	`string`	Selectable in the Payload builder The translated social description; empty on delete means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's Blog List SEO translation changed.

Payload shape

Sample payload

{
  "blog_list_seo": {
    "page_type": "blog_list",
    "robots_follow": true,
    "robots_index": true,
    "seo_description": "News, guides, and updates.",
    "seo_title": "Stories from our store",
    "social_description": "Read our latest stories.",
    "social_image_id": null,
    "social_title": "Our blog",
    "updated_at": "2026-09-01T12:00:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "seo_description": "Les dernières nouvelles.",
    "seo_title": "Actualités",
    "social_description": "Découvrez nos dernières histoires.",
    "social_title": "Notre blog"
  },
  "updated_at": "2026-09-01T12:00:00+05:30"
}

Blog List SEO updated

EVENT blog_list_seo/update App scope: read_blog Staff permission: blog:write

Fired when source SEO settings change for the public blog index.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

robots_follow robots_index seo_description seo_title social_description social_image_id social_title

Payload fields

Field	Type	Description
`blog_list_seo.page_type`	`string`	Always present The stable public blog-index identity, blog_list.
`blog_list_seo.seo_title`	`string`	Selectable in the Payload builder The blog index SEO title in the store's default language.
`blog_list_seo.seo_description`	`string`	Selectable in the Payload builder The blog index SEO description in the store's default language.
`blog_list_seo.social_title`	`string`	Selectable in the Payload builder The default-language social sharing title override.
`blog_list_seo.social_description`	`string`	Selectable in the Payload builder The default-language social sharing description override.
`blog_list_seo.social_image_id`	`string`	Selectable in the Payload builder The assigned site-asset image id, or null when no override is assigned.
`blog_list_seo.robots_index`	`boolean`	Selectable in the Payload builder Whether search engines may index the blog index.
`blog_list_seo.robots_follow`	`boolean`	Selectable in the Payload builder Whether search engines may follow links from the blog index.
`blog_list_seo.updated_at`	`string`	Selectable in the Payload builder When the source blog-index SEO settings last changed.
`changed_fields`	`array`	Always present The source Blog List SEO fields changed by this event.

Payload shape

Sample payload

{
  "blog_list_seo": {
    "page_type": "blog_list",
    "robots_follow": true,
    "robots_index": true,
    "seo_description": "News, guides, and updates.",
    "seo_title": "Stories from our store",
    "social_description": "Read our latest stories.",
    "social_image_id": null,
    "social_title": "Our blog",
    "updated_at": "2026-09-01T12:00:00+05:30"
  },
  "changed_fields": [
    "seo_title",
    "seo_description"
  ]
}

Blog post metafield value created

EVENT blog_post_metafields/create App scope: read_blog Staff permission: blog:write

Fired when a blog post metafield value is created.

Payload fields

Field	Type	Description
`blog_post.id`	`string`	Always present
`blog_post.title`	`string`	Selectable in the Payload builder
`blog_post.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_post": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "slug": "launch-notes",
    "title": "Launch notes"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "Estimated reading time shown to shoppers.",
      "id": "f1d9af5a-4d56-49aa-a4a5-f90053d637fd",
      "is_translatable": false,
      "key": "reading_time",
      "max_list_items": null,
      "max_value_length": 40,
      "merchant_access": "read_write",
      "name": "Reading time",
      "namespace": "details",
      "owner_type": "blog_post",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "5 minutes",
    "display_value_map": {
      "en": "5 minutes"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "5 minutes"
  }
}

Blog post metafield value deleted

EVENT blog_post_metafields/delete App scope: read_blog Staff permission: blog:write

Fired when a blog post metafield value is deleted, including when its blog post is deleted.

Payload fields

Field	Type	Description
`blog_post.id`	`string`	Always present
`blog_post.title`	`string`	Selectable in the Payload builder
`blog_post.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_post": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "slug": "launch-notes",
    "title": "Launch notes"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "Estimated reading time shown to shoppers.",
      "id": "f1d9af5a-4d56-49aa-a4a5-f90053d637fd",
      "is_translatable": false,
      "key": "reading_time",
      "max_list_items": null,
      "max_value_length": 40,
      "merchant_access": "read_write",
      "name": "Reading time",
      "namespace": "details",
      "owner_type": "blog_post",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "5 minutes",
    "display_value_map": {
      "en": "5 minutes"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "5 minutes"
  }
}

Blog post metafield translations deleted

EVENT blog_post_metafields/translations/delete App scope: read_blog Staff permission: blog:write

Fired when a blog post metafield's translation is cleared for a locale, including when its blog post is deleted.

Payload fields

Field	Type	Description
`metafield.blog_post_id`	`string`	Always present
`metafield.blog_post_title`	`string`	Selectable in the Payload builder
`metafield.blog_post_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "blog_post_id": "...",
    "blog_post_slug": "...",
    "blog_post_title": "...",
    "definition_id": "...",
    "key": "...",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "...",
    "type": "string"
  },
  "translation": {
    "value": ""
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog post metafield translations updated

EVENT blog_post_metafields/translations/update App scope: read_blog Staff permission: blog:write

Fired when a blog post metafield's translation is added or updated for a locale.

Payload fields

Field	Type	Description
`metafield.blog_post_id`	`string`	Always present
`metafield.blog_post_title`	`string`	Selectable in the Payload builder
`metafield.blog_post_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "blog_post_id": "...",
    "blog_post_slug": "...",
    "blog_post_title": "...",
    "definition_id": "...",
    "key": "...",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "...",
    "type": "string"
  },
  "translation": {
    "value": "5 minutes"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog post metafield value updated

EVENT blog_post_metafields/update App scope: read_blog Staff permission: blog:write

Fired when a blog post metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`blog_post.id`	`string`	Always present
`blog_post.title`	`string`	Selectable in the Payload builder
`blog_post.slug`	`string`	Selectable in the Payload builder
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_post": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "slug": "launch-notes",
    "title": "Launch notes"
  },
  "changed_fields": [
    "value"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "Estimated reading time shown to shoppers.",
      "id": "f1d9af5a-4d56-49aa-a4a5-f90053d637fd",
      "is_translatable": false,
      "key": "reading_time",
      "max_list_items": null,
      "max_value_length": 40,
      "merchant_access": "read_write",
      "name": "Reading time",
      "namespace": "details",
      "owner_type": "blog_post",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "5 minutes",
    "display_value_map": {
      "en": "5 minutes"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "5 minutes"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "Estimated reading time shown to shoppers.",
      "id": "f1d9af5a-4d56-49aa-a4a5-f90053d637fd",
      "is_translatable": false,
      "key": "reading_time",
      "max_list_items": null,
      "max_value_length": 40,
      "merchant_access": "read_write",
      "name": "Reading time",
      "namespace": "details",
      "owner_type": "blog_post",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "4 minutes",
    "display_value_map": {
      "en": "4 minutes"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "4 minutes"
  }
}

Blog post created

EVENT blog_posts/create App scope: read_blog Staff permission: blog:write

Fired when a blog post is created.

Payload fields

Field	Type	Description
`blog_post.id`	`string`	Always present
`blog_post.title`	`string`	Selectable in the Payload builder
`blog_post.slug`	`string`	Selectable in the Payload builder
`blog_post.content`	`string`	Selectable in the Payload builder
`blog_post.excerpt`	`string`	Selectable in the Payload builder
`blog_post.featured_image_id`	`string`	Selectable in the Payload builder
`blog_post.featured_image_url`	`string`	Selectable in the Payload builder
`blog_post.featured_image_cdn_url`	`string`	Selectable in the Payload builder
`blog_post.author_ref`	`string`	Selectable in the Payload builder
`blog_post.author.id`	`string`	Always present
`blog_post.author.name`	`string`	Selectable in the Payload builder
`blog_post.author.slug`	`string`	Selectable in the Payload builder
`blog_post.author.bio`	`string`	Selectable in the Payload builder
`blog_post.author.avatar_url`	`string`	Selectable in the Payload builder
`blog_post.author.created_at`	`string`	Selectable in the Payload builder
`blog_post.seo_title`	`string`	Selectable in the Payload builder
`blog_post.seo_description`	`string`	Selectable in the Payload builder
`blog_post.template_handle`	`string`	Selectable in the Payload builder
`blog_post.status`	`string`	Selectable in the Payload builder
`blog_post.publish_at`	`string`	Selectable in the Payload builder
`blog_post.published_at`	`string`	Selectable in the Payload builder
`blog_post.comment_count`	`integer`	Selectable in the Payload builder
`blog_post.categories[*].id`	`string`	Always present
`blog_post.categories[*].name`	`string`	Selectable in the Payload builder
`blog_post.categories[*].slug`	`string`	Selectable in the Payload builder
`blog_post.categories[*].description`	`string`	Selectable in the Payload builder
`blog_post.categories[*].seo_title`	`string`	Selectable in the Payload builder
`blog_post.categories[*].seo_description`	`string`	Selectable in the Payload builder
`blog_post.categories[*].template_handle`	`string`	Selectable in the Payload builder
`blog_post.categories[*].post_count`	`integer`	Selectable in the Payload builder
`blog_post.categories[*].created_at`	`string`	Selectable in the Payload builder
`blog_post.categories[*].updated_at`	`string`	Selectable in the Payload builder
`blog_post.tags[*].id`	`string`	Always present
`blog_post.tags[*].name`	`string`	Selectable in the Payload builder
`blog_post.tags[*].slug`	`string`	Selectable in the Payload builder
`blog_post.tags[*].post_count`	`integer`	Selectable in the Payload builder
`blog_post.tags[*].created_at`	`string`	Selectable in the Payload builder
`blog_post.created_at`	`string`	Selectable in the Payload builder
`blog_post.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_post": {
    "author": {
      "avatar_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
      "bio": "Writes product and company updates.",
      "created_at": "2026-06-09T12:00:00+05:30",
      "id": "44bf70b7-88e2-4770-a30e-d7a1db522499",
      "name": "Avery Stone",
      "slug": "avery-stone"
    },
    "author_ref": "44bf70b7-88e2-4770-a30e-d7a1db522499",
    "categories": [
      {
        "created_at": "2026-06-09T12:00:00+05:30",
        "description": "Updates and announcements from the company.",
        "id": "3a588f80-fd8c-4d46-af1b-00a1c4a7f85a",
        "name": "Company News",
        "post_count": 0,
        "seo_description": "Trail notes from 30km in our organic cotton tee.",
        "seo_title": "Field-Testing the Trailblazer Tee",
        "slug": "company-news",
        "template_handle": "default_blog_category",
        "updated_at": "2026-06-09T12:00:00+05:30"
      }
    ],
    "comment_count": 4,
    "content": "\u003cp\u003eWe took the Trailblazer Tee on a 30km ridge hike.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "excerpt": "We took the Trailblazer Tee on a 30km ridge hike.",
    "featured_image_cdn_url": "",
    "featured_image_id": null,
    "featured_image_url": "",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "publish_at": null,
    "published_at": "2026-06-09T12:00:00+05:30",
    "seo_description": "Trail notes from 30km in our organic cotton tee.",
    "seo_title": "Field-Testing the Trailblazer Tee",
    "slug": "launch-notes",
    "status": "published",
    "tags": [
      {
        "created_at": "2026-06-09T12:00:00+05:30",
        "id": "6e8b7dd1-7ad5-453d-8a87-67daf4ca9f93",
        "name": "Launch",
        "post_count": 0,
        "slug": "launch"
      }
    ],
    "template_handle": "default_blog",
    "title": "Launch notes",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Blog post deleted

EVENT blog_posts/delete App scope: read_blog Staff permission: blog:write

Fired when a blog post is deleted.

Payload fields

Field	Type	Description
`blog_post.id`	`string`	Always present
`blog_post.title`	`string`	Selectable in the Payload builder
`blog_post.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_post": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "slug": "launch-notes",
    "title": "Launch notes"
  }
}

Blog post translations deleted

EVENT blog_posts/translations/delete App scope: read_blog Staff permission: blog:write

Fired when a blog post's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`blog_post.id`	`string`	Always present
`blog_post.title`	`string`	Selectable in the Payload builder
`blog_post.slug`	`string`	Selectable in the Payload builder
`blog_post.content`	`string`	Selectable in the Payload builder
`blog_post.excerpt`	`string`	Selectable in the Payload builder
`blog_post.featured_image_id`	`string`	Selectable in the Payload builder
`blog_post.featured_image_url`	`string`	Selectable in the Payload builder
`blog_post.featured_image_cdn_url`	`string`	Selectable in the Payload builder
`blog_post.author_ref`	`string`	Selectable in the Payload builder
`blog_post.author.id`	`string`	Always present
`blog_post.author.name`	`string`	Selectable in the Payload builder
`blog_post.author.slug`	`string`	Selectable in the Payload builder
`blog_post.author.bio`	`string`	Selectable in the Payload builder
`blog_post.author.avatar_url`	`string`	Selectable in the Payload builder
`blog_post.author.created_at`	`string`	Selectable in the Payload builder
`blog_post.seo_title`	`string`	Selectable in the Payload builder
`blog_post.seo_description`	`string`	Selectable in the Payload builder
`blog_post.template_handle`	`string`	Selectable in the Payload builder
`blog_post.status`	`string`	Selectable in the Payload builder
`blog_post.publish_at`	`string`	Selectable in the Payload builder
`blog_post.published_at`	`string`	Selectable in the Payload builder
`blog_post.comment_count`	`integer`	Selectable in the Payload builder
`blog_post.categories[*].id`	`string`	Always present
`blog_post.categories[*].name`	`string`	Selectable in the Payload builder
`blog_post.categories[*].slug`	`string`	Selectable in the Payload builder
`blog_post.categories[*].description`	`string`	Selectable in the Payload builder
`blog_post.categories[*].seo_title`	`string`	Selectable in the Payload builder
`blog_post.categories[*].seo_description`	`string`	Selectable in the Payload builder
`blog_post.categories[*].template_handle`	`string`	Selectable in the Payload builder
`blog_post.categories[*].post_count`	`integer`	Selectable in the Payload builder
`blog_post.categories[*].created_at`	`string`	Selectable in the Payload builder
`blog_post.categories[*].updated_at`	`string`	Selectable in the Payload builder
`blog_post.tags[*].id`	`string`	Always present
`blog_post.tags[*].name`	`string`	Selectable in the Payload builder
`blog_post.tags[*].slug`	`string`	Selectable in the Payload builder
`blog_post.tags[*].post_count`	`integer`	Selectable in the Payload builder
`blog_post.tags[*].created_at`	`string`	Selectable in the Payload builder
`blog_post.created_at`	`string`	Selectable in the Payload builder
`blog_post.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.content`	`string`	Selectable in the Payload builder
`translation.excerpt`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_post": {
    "author": {
      "avatar_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
      "bio": "Writes product and company updates.",
      "created_at": "2026-06-09T12:00:00+05:30",
      "id": "44bf70b7-88e2-4770-a30e-d7a1db522499",
      "name": "Avery Stone",
      "slug": "avery-stone"
    },
    "author_ref": "44bf70b7-88e2-4770-a30e-d7a1db522499",
    "categories": [
      {
        "created_at": "2026-06-09T12:00:00+05:30",
        "description": "Updates and announcements from the company.",
        "id": "3a588f80-fd8c-4d46-af1b-00a1c4a7f85a",
        "name": "Company News",
        "post_count": 0,
        "seo_description": "Trail notes from 30km in our organic cotton tee.",
        "seo_title": "Field-Testing the Trailblazer Tee",
        "slug": "company-news",
        "template_handle": "default_blog_category",
        "updated_at": "2026-06-09T12:00:00+05:30"
      }
    ],
    "comment_count": 4,
    "content": "\u003cp\u003eWe took the Trailblazer Tee on a 30km ridge hike.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "excerpt": "We took the Trailblazer Tee on a 30km ridge hike.",
    "featured_image_cdn_url": "",
    "featured_image_id": null,
    "featured_image_url": "",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "publish_at": null,
    "published_at": "2026-06-09T12:00:00+05:30",
    "seo_description": "Trail notes from 30km in our organic cotton tee.",
    "seo_title": "Field-Testing the Trailblazer Tee",
    "slug": "launch-notes",
    "status": "published",
    "tags": [
      {
        "created_at": "2026-06-09T12:00:00+05:30",
        "id": "6e8b7dd1-7ad5-453d-8a87-67daf4ca9f93",
        "name": "Launch",
        "post_count": 0,
        "slug": "launch"
      }
    ],
    "template_handle": "default_blog",
    "title": "Launch notes",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "content": "",
    "excerpt": "",
    "seo_description": "",
    "seo_title": "",
    "slug": "",
    "title": ""
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog post translations updated

EVENT blog_posts/translations/update App scope: read_blog Staff permission: blog:write

Fired when a blog post's translations are added or updated for a locale.

Payload fields

Field	Type	Description
`blog_post.id`	`string`	Always present
`blog_post.title`	`string`	Selectable in the Payload builder
`blog_post.slug`	`string`	Selectable in the Payload builder
`blog_post.content`	`string`	Selectable in the Payload builder
`blog_post.excerpt`	`string`	Selectable in the Payload builder
`blog_post.featured_image_id`	`string`	Selectable in the Payload builder
`blog_post.featured_image_url`	`string`	Selectable in the Payload builder
`blog_post.featured_image_cdn_url`	`string`	Selectable in the Payload builder
`blog_post.author_ref`	`string`	Selectable in the Payload builder
`blog_post.author.id`	`string`	Always present
`blog_post.author.name`	`string`	Selectable in the Payload builder
`blog_post.author.slug`	`string`	Selectable in the Payload builder
`blog_post.author.bio`	`string`	Selectable in the Payload builder
`blog_post.author.avatar_url`	`string`	Selectable in the Payload builder
`blog_post.author.created_at`	`string`	Selectable in the Payload builder
`blog_post.seo_title`	`string`	Selectable in the Payload builder
`blog_post.seo_description`	`string`	Selectable in the Payload builder
`blog_post.template_handle`	`string`	Selectable in the Payload builder
`blog_post.status`	`string`	Selectable in the Payload builder
`blog_post.publish_at`	`string`	Selectable in the Payload builder
`blog_post.published_at`	`string`	Selectable in the Payload builder
`blog_post.comment_count`	`integer`	Selectable in the Payload builder
`blog_post.categories[*].id`	`string`	Always present
`blog_post.categories[*].name`	`string`	Selectable in the Payload builder
`blog_post.categories[*].slug`	`string`	Selectable in the Payload builder
`blog_post.categories[*].description`	`string`	Selectable in the Payload builder
`blog_post.categories[*].seo_title`	`string`	Selectable in the Payload builder
`blog_post.categories[*].seo_description`	`string`	Selectable in the Payload builder
`blog_post.categories[*].template_handle`	`string`	Selectable in the Payload builder
`blog_post.categories[*].post_count`	`integer`	Selectable in the Payload builder
`blog_post.categories[*].created_at`	`string`	Selectable in the Payload builder
`blog_post.categories[*].updated_at`	`string`	Selectable in the Payload builder
`blog_post.tags[*].id`	`string`	Always present
`blog_post.tags[*].name`	`string`	Selectable in the Payload builder
`blog_post.tags[*].slug`	`string`	Selectable in the Payload builder
`blog_post.tags[*].post_count`	`integer`	Selectable in the Payload builder
`blog_post.tags[*].created_at`	`string`	Selectable in the Payload builder
`blog_post.created_at`	`string`	Selectable in the Payload builder
`blog_post.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.content`	`string`	Selectable in the Payload builder
`translation.excerpt`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_post": {
    "author": {
      "avatar_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
      "bio": "Writes product and company updates.",
      "created_at": "2026-06-09T12:00:00+05:30",
      "id": "44bf70b7-88e2-4770-a30e-d7a1db522499",
      "name": "Avery Stone",
      "slug": "avery-stone"
    },
    "author_ref": "44bf70b7-88e2-4770-a30e-d7a1db522499",
    "categories": [
      {
        "created_at": "2026-06-09T12:00:00+05:30",
        "description": "Updates and announcements from the company.",
        "id": "3a588f80-fd8c-4d46-af1b-00a1c4a7f85a",
        "name": "Company News",
        "post_count": 0,
        "seo_description": "Trail notes from 30km in our organic cotton tee.",
        "seo_title": "Field-Testing the Trailblazer Tee",
        "slug": "company-news",
        "template_handle": "default_blog_category",
        "updated_at": "2026-06-09T12:00:00+05:30"
      }
    ],
    "comment_count": 4,
    "content": "\u003cp\u003eWe took the Trailblazer Tee on a 30km ridge hike.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "excerpt": "We took the Trailblazer Tee on a 30km ridge hike.",
    "featured_image_cdn_url": "",
    "featured_image_id": null,
    "featured_image_url": "",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "publish_at": null,
    "published_at": "2026-06-09T12:00:00+05:30",
    "seo_description": "Trail notes from 30km in our organic cotton tee.",
    "seo_title": "Field-Testing the Trailblazer Tee",
    "slug": "launch-notes",
    "status": "published",
    "tags": [
      {
        "created_at": "2026-06-09T12:00:00+05:30",
        "id": "6e8b7dd1-7ad5-453d-8a87-67daf4ca9f93",
        "name": "Launch",
        "post_count": 0,
        "slug": "launch"
      }
    ],
    "template_handle": "default_blog",
    "title": "Launch notes",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "content": "\u003cp\u003eDécouvrez les changements de cette version.\u003c/p\u003e",
    "excerpt": "Découvrez les changements de cette version.",
    "seo_description": "Découvrez les dernières notes de lancement.",
    "seo_title": "Notes de lancement",
    "slug": "notes-lancement",
    "title": "Notes de lancement"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog post updated

EVENT blog_posts/update App scope: read_blog Staff permission: blog:write

Fired when a blog post is updated.

Payload fields

Field	Type	Description
`blog_post.id`	`string`	Always present
`blog_post.title`	`string`	Selectable in the Payload builder
`blog_post.slug`	`string`	Selectable in the Payload builder
`blog_post.content`	`string`	Selectable in the Payload builder
`blog_post.excerpt`	`string`	Selectable in the Payload builder
`blog_post.featured_image_id`	`string`	Selectable in the Payload builder
`blog_post.featured_image_url`	`string`	Selectable in the Payload builder
`blog_post.featured_image_cdn_url`	`string`	Selectable in the Payload builder
`blog_post.author_ref`	`string`	Selectable in the Payload builder
`blog_post.author.id`	`string`	Always present
`blog_post.author.name`	`string`	Selectable in the Payload builder
`blog_post.author.slug`	`string`	Selectable in the Payload builder
`blog_post.author.bio`	`string`	Selectable in the Payload builder
`blog_post.author.avatar_url`	`string`	Selectable in the Payload builder
`blog_post.author.created_at`	`string`	Selectable in the Payload builder
`blog_post.seo_title`	`string`	Selectable in the Payload builder
`blog_post.seo_description`	`string`	Selectable in the Payload builder
`blog_post.template_handle`	`string`	Selectable in the Payload builder
`blog_post.status`	`string`	Selectable in the Payload builder
`blog_post.publish_at`	`string`	Selectable in the Payload builder
`blog_post.published_at`	`string`	Selectable in the Payload builder
`blog_post.comment_count`	`integer`	Selectable in the Payload builder
`blog_post.categories[*].id`	`string`	Always present
`blog_post.categories[*].name`	`string`	Selectable in the Payload builder
`blog_post.categories[*].slug`	`string`	Selectable in the Payload builder
`blog_post.categories[*].description`	`string`	Selectable in the Payload builder
`blog_post.categories[*].seo_title`	`string`	Selectable in the Payload builder
`blog_post.categories[*].seo_description`	`string`	Selectable in the Payload builder
`blog_post.categories[*].template_handle`	`string`	Selectable in the Payload builder
`blog_post.categories[*].post_count`	`integer`	Selectable in the Payload builder
`blog_post.categories[*].created_at`	`string`	Selectable in the Payload builder
`blog_post.categories[*].updated_at`	`string`	Selectable in the Payload builder
`blog_post.tags[*].id`	`string`	Always present
`blog_post.tags[*].name`	`string`	Selectable in the Payload builder
`blog_post.tags[*].slug`	`string`	Selectable in the Payload builder
`blog_post.tags[*].post_count`	`integer`	Selectable in the Payload builder
`blog_post.tags[*].created_at`	`string`	Selectable in the Payload builder
`blog_post.created_at`	`string`	Selectable in the Payload builder
`blog_post.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_post": {
    "author": {
      "avatar_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
      "bio": "Writes product and company updates.",
      "created_at": "2026-06-09T12:00:00+05:30",
      "id": "44bf70b7-88e2-4770-a30e-d7a1db522499",
      "name": "Avery Stone",
      "slug": "avery-stone"
    },
    "author_ref": "44bf70b7-88e2-4770-a30e-d7a1db522499",
    "categories": [
      {
        "created_at": "2026-06-09T12:00:00+05:30",
        "description": "Updates and announcements from the company.",
        "id": "3a588f80-fd8c-4d46-af1b-00a1c4a7f85a",
        "name": "Company News",
        "post_count": 0,
        "seo_description": "Trail notes from 30km in our organic cotton tee.",
        "seo_title": "Field-Testing the Trailblazer Tee",
        "slug": "company-news",
        "template_handle": "default_blog_category",
        "updated_at": "2026-06-09T12:00:00+05:30"
      }
    ],
    "comment_count": 4,
    "content": "\u003cp\u003eWe took the Trailblazer Tee on a 30km ridge hike.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "excerpt": "We took the Trailblazer Tee on a 30km ridge hike.",
    "featured_image_cdn_url": "",
    "featured_image_id": null,
    "featured_image_url": "",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "publish_at": null,
    "published_at": "2026-06-09T12:00:00+05:30",
    "seo_description": "Trail notes from 30km in our organic cotton tee.",
    "seo_title": "Field-Testing the Trailblazer Tee",
    "slug": "launch-notes",
    "status": "published",
    "tags": [
      {
        "created_at": "2026-06-09T12:00:00+05:30",
        "id": "6e8b7dd1-7ad5-453d-8a87-67daf4ca9f93",
        "name": "Launch",
        "post_count": 0,
        "slug": "launch"
      }
    ],
    "template_handle": "default_blog",
    "title": "Launch notes",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Blog settings updated

EVENT blog_settings/update App scope: read_blog Staff permission: blog:write

Fired when blog comment settings change.

Payload fields

Field	Type	Description
`settings.comments_mode`	`string`	Always present
`settings.comments_moderation`	`boolean`	Selectable in the Payload builder
`settings.updated_at`	`string`	Always present

Payload shape

Sample payload

{
  "settings": {
    "comments_mode": "registered",
    "comments_moderation": true,
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Blog tag created

EVENT blog_tags/create App scope: read_blog Staff permission: blog:write

Fired when a blog tag is created.

Payload fields

Field	Type	Description
`blog_tag.id`	`string`	Always present
`blog_tag.name`	`string`	Selectable in the Payload builder
`blog_tag.slug`	`string`	Selectable in the Payload builder
`blog_tag.post_count`	`integer`	Selectable in the Payload builder
`blog_tag.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Gear",
    "post_count": 0,
    "slug": "gear"
  }
}

Blog tag deleted

EVENT blog_tags/delete App scope: read_blog Staff permission: blog:write

Fired when a blog tag is deleted.

Payload fields

Field	Type	Description
`blog_tag.id`	`string`	Always present
`blog_tag.name`	`string`	Selectable in the Payload builder
`blog_tag.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_tag": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Gear",
    "slug": "gear"
  }
}

Blog tag translations deleted

EVENT blog_tags/translations/delete App scope: read_blog Staff permission: blog:write

Fired when a blog tag's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`blog_tag.id`	`string`	Always present
`blog_tag.name`	`string`	Selectable in the Payload builder
`blog_tag.slug`	`string`	Selectable in the Payload builder
`blog_tag.post_count`	`integer`	Selectable in the Payload builder
`blog_tag.created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Gear",
    "post_count": 0,
    "slug": "gear"
  },
  "locale": "fr",
  "translation": {
    "name": "",
    "slug": ""
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog tag translations updated

EVENT blog_tags/translations/update App scope: read_blog Staff permission: blog:write

Fired when a blog tag's translations are added or updated for a locale.

Payload fields

Field	Type	Description
`blog_tag.id`	`string`	Always present
`blog_tag.name`	`string`	Selectable in the Payload builder
`blog_tag.slug`	`string`	Selectable in the Payload builder
`blog_tag.post_count`	`integer`	Selectable in the Payload builder
`blog_tag.created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Gear",
    "post_count": 0,
    "slug": "gear"
  },
  "locale": "fr",
  "translation": {
    "name": "Équipement",
    "slug": "equipement"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Blog tag updated

EVENT blog_tags/update App scope: read_blog Staff permission: blog:write

Fired when a blog tag is updated.

Payload fields

Field	Type	Description
`blog_tag.id`	`string`	Always present
`blog_tag.name`	`string`	Selectable in the Payload builder
`blog_tag.slug`	`string`	Selectable in the Payload builder
`blog_tag.post_count`	`integer`	Selectable in the Payload builder
`blog_tag.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Gear",
    "post_count": 0,
    "slug": "gear"
  }
}

Brand metafield value created

EVENT brand_metafields/create App scope: read_products Staff permission: products:write

Fired when a brand metafield value is created.

Payload fields

Field	Type	Description
`brand.id`	`integer`	Always present
`brand.name`	`string`	Selectable in the Payload builder
`brand.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "brand": {
    "id": 7,
    "name": "Acme",
    "slug": "acme"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "The primary material used by this brand.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": true,
      "key": "material",
      "max_list_items": null,
      "max_value_length": 100,
      "merchant_access": "read_write",
      "name": "Material",
      "namespace": "app:catalog-sync.details",
      "owner_type": "brand",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  }
}

Brand metafield value deleted

EVENT brand_metafields/delete App scope: read_products Staff permission: products:write

Fired when a brand metafield value is deleted.

Payload fields

Field	Type	Description
`brand.id`	`integer`	Always present
`brand.name`	`string`	Selectable in the Payload builder
`brand.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "brand": {
    "id": 7,
    "name": "Acme",
    "slug": "acme"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "The primary material used by this brand.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": true,
      "key": "material",
      "max_list_items": null,
      "max_value_length": 100,
      "merchant_access": "read_write",
      "name": "Material",
      "namespace": "app:catalog-sync.details",
      "owner_type": "brand",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  }
}

Brand metafield translations deleted

EVENT brand_metafields/translations/delete App scope: read_products Staff permission: products:write

Fired when a brand metafield's translation is cleared for a locale.

Payload fields

Field	Type	Description
`metafield.brand_id`	`integer`	Always present The brand that holds the translated value.
`metafield.brand_name`	`string`	Selectable in the Payload builder The brand name when the event was created.
`metafield.brand_slug`	`string`	Selectable in the Payload builder The brand slug when the event was created.
`metafield.definition_id`	`string`	Always present The metafield definition ID.
`metafield.namespace`	`string`	Selectable in the Payload builder The definition namespace.
`metafield.key`	`string`	Selectable in the Payload builder The definition key within its namespace.
`metafield.name`	`string`	Selectable in the Payload builder The definition name.
`metafield.type`	`string`	Selectable in the Payload builder The metafield value type.
`metafield.app_id`	`string`	Selectable in the Payload builder The owning app ID, or null for a merchant-owned definition.
`metafield.app_access`	`string`	Selectable in the Payload builder Whether other apps can read the definition: `private` or `shared`.
`metafield.merchant_access`	`string`	Selectable in the Payload builder How a merchant token can access an app-owned definition: `hidden`, `read`, or `read_write`.
`locale`	`string`	Selectable in the Payload builder The locale whose translation changed.
`translation.value`	`string`	Selectable in the Payload builder The translated value; an empty string on a delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's translation changed.

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "brand_id": 7,
    "brand_name": "Acme",
    "brand_slug": "acme",
    "definition_id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
    "key": "material",
    "merchant_access": "read_write",
    "name": "Material",
    "namespace": "app:catalog-sync.details",
    "type": "string"
  },
  "translation": {
    "value": ""
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Brand metafield translations updated

EVENT brand_metafields/translations/update App scope: read_products Staff permission: products:write

Fired when a brand metafield's translation is added or updated for a locale.

Payload fields

Field	Type	Description
`metafield.brand_id`	`integer`	Always present The brand that holds the translated value.
`metafield.brand_name`	`string`	Selectable in the Payload builder The brand name when the event was created.
`metafield.brand_slug`	`string`	Selectable in the Payload builder The brand slug when the event was created.
`metafield.definition_id`	`string`	Always present The metafield definition ID.
`metafield.namespace`	`string`	Selectable in the Payload builder The definition namespace.
`metafield.key`	`string`	Selectable in the Payload builder The definition key within its namespace.
`metafield.name`	`string`	Selectable in the Payload builder The definition name.
`metafield.type`	`string`	Selectable in the Payload builder The metafield value type.
`metafield.app_id`	`string`	Selectable in the Payload builder The owning app ID, or null for a merchant-owned definition.
`metafield.app_access`	`string`	Selectable in the Payload builder Whether other apps can read the definition: `private` or `shared`.
`metafield.merchant_access`	`string`	Selectable in the Payload builder How a merchant token can access an app-owned definition: `hidden`, `read`, or `read_write`.
`locale`	`string`	Selectable in the Payload builder The locale whose translation changed.
`translation.value`	`string`	Selectable in the Payload builder The translated value; an empty string on a delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's translation changed.

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "brand_id": 7,
    "brand_name": "Acme",
    "brand_slug": "acme",
    "definition_id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
    "key": "material",
    "merchant_access": "read_write",
    "name": "Material",
    "namespace": "app:catalog-sync.details",
    "type": "string"
  },
  "translation": {
    "value": "Coton biologique"
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Brand metafield value updated

EVENT brand_metafields/update App scope: read_products Staff permission: products:write

Fired when a brand metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`brand.id`	`integer`	Always present
`brand.name`	`string`	Selectable in the Payload builder
`brand.slug`	`string`	Selectable in the Payload builder
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "brand": {
    "id": 7,
    "name": "Acme",
    "slug": "acme"
  },
  "changed_fields": [
    "value"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "The primary material used by this brand.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": true,
      "key": "material",
      "max_list_items": null,
      "max_value_length": 100,
      "merchant_access": "read_write",
      "name": "Material",
      "namespace": "app:catalog-sync.details",
      "owner_type": "brand",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-10T09:30:00+05:30",
    "value": "Recycled cotton"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "The primary material used by this brand.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": true,
      "key": "material",
      "max_list_items": null,
      "max_value_length": 100,
      "merchant_access": "read_write",
      "name": "Material",
      "namespace": "app:catalog-sync.details",
      "owner_type": "brand",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  }
}

Brand created

EVENT brands/create App scope: read_products Staff permission: products:write

Fired when a brand is created.

Payload fields

Field	Type	Description
`brand.id`	`integer`	Always present The stable Brand id.
`brand.name`	`string`	Selectable in the Payload builder The merchant-facing Brand name.
`brand.slug`	`string`	Selectable in the Payload builder The Brand's URL-safe identifier.
`brand.description`	`string`	Selectable in the Payload builder The Brand description in the store's default locale.
`brand.seo_title`	`string`	Selectable in the Payload builder The Brand page's SEO title in the store's default locale.
`brand.seo_description`	`string`	Selectable in the Payload builder The Brand page's SEO description in the store's default locale.
`brand.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image id, or null when no image is assigned.
`brand.image_url`	`string`	Selectable in the Payload builder The original URL recorded for the assigned image, or an empty string.
`brand.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string.
`brand.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the Brand.
`brand.template_handle`	`string`	Selectable in the Payload builder The storefront template handle assigned to the Brand.
`brand.created_at`	`string`	Selectable in the Payload builder When the Brand was created.
`brand.updated_at`	`string`	Selectable in the Payload builder When the Brand last changed.
`brand.translations_updated_at`	`string`	Selectable in the Payload builder When any Brand translation last changed, or null when none exist.

Payload shape

Sample payload

{
  "brand": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme makes durable outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme",
    "product_count": 0,
    "seo_description": "Shop Acme outdoor gear.",
    "seo_title": "Acme Outdoor Gear",
    "slug": "acme",
    "template_handle": "default_brand",
    "translations_updated_at": null,
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Brand deleted

EVENT brands/delete App scope: read_products Staff permission: products:write

Fired after a brand is deleted. A brand with translations also produces brands/translations/delete for each translated locale; those events and the deletion are atomic. Removed metafield values have separate delete events.

Payload fields

Field	Type	Description
`brand.id`	`integer`	Always present The stable id of the deleted Brand.
`brand.name`	`string`	Selectable in the Payload builder The Brand name at the time it was deleted.
`brand.slug`	`string`	Selectable in the Payload builder The Brand slug at the time it was deleted.

Payload shape

Sample payload

{
  "brand": {
    "id": 7,
    "name": "Acme",
    "slug": "acme"
  }
}

Brand translations deleted

EVENT brands/translations/delete App scope: read_products Staff permission: products:write

Fired when translated fields are cleared for a locale, including when the brand itself is deleted. A write that sets some translated fields and clears others can fire both translation events. Translation writes do not fire brands/update.

Payload fields

Field	Type	Description
`brand.id`	`integer`	Always present The stable Brand id.
`brand.name`	`string`	Selectable in the Payload builder The merchant-facing Brand name.
`brand.slug`	`string`	Selectable in the Payload builder The Brand's URL-safe identifier.
`brand.description`	`string`	Selectable in the Payload builder The Brand description in the store's default locale.
`brand.seo_title`	`string`	Selectable in the Payload builder The Brand page's SEO title in the store's default locale.
`brand.seo_description`	`string`	Selectable in the Payload builder The Brand page's SEO description in the store's default locale.
`brand.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image id, or null when no image is assigned.
`brand.image_url`	`string`	Selectable in the Payload builder The original URL recorded for the assigned image, or an empty string.
`brand.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string.
`brand.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the Brand.
`brand.template_handle`	`string`	Selectable in the Payload builder The storefront template handle assigned to the Brand.
`brand.created_at`	`string`	Selectable in the Payload builder When the Brand was created.
`brand.updated_at`	`string`	Selectable in the Payload builder When the Brand last changed.
`brand.translations_updated_at`	`string`	Selectable in the Payload builder When any Brand translation last changed, or null when none exist.
`locale`	`string`	Selectable in the Payload builder The locale whose Brand translation changed.
`translation.name`	`string`	Selectable in the Payload builder The translated Brand name; an empty string on a delete event means it was removed.
`translation.slug`	`string`	Selectable in the Payload builder The translated Brand slug; an empty string on a delete event means it was removed.
`translation.description`	`string`	Selectable in the Payload builder The translated Brand description; an empty string on a delete event means it was removed.
`translation.seo_title`	`string`	Selectable in the Payload builder The translated SEO title; an empty string on a delete event means it was removed.
`translation.seo_description`	`string`	Selectable in the Payload builder The translated SEO description; an empty string on a delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's Brand translation changed.

Payload shape

Sample payload

{
  "brand": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme makes durable outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme",
    "product_count": 12,
    "seo_description": "Shop Acme outdoor gear.",
    "seo_title": "Acme Outdoor Gear",
    "slug": "acme",
    "template_handle": "default_brand",
    "translations_updated_at": "2026-06-10T09:30:00+05:30",
    "updated_at": "2026-06-10T09:30:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "description": "",
    "name": "",
    "seo_description": "",
    "seo_title": "",
    "slug": ""
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Brand translations updated

EVENT brands/translations/update App scope: read_products Staff permission: products:write

Fired when a brand's translations are added or updated for a locale. Payload carries only the fields that changed. Translation writes do not fire brands/update.

Payload fields

Field	Type	Description
`brand.id`	`integer`	Always present The stable Brand id.
`brand.name`	`string`	Selectable in the Payload builder The merchant-facing Brand name.
`brand.slug`	`string`	Selectable in the Payload builder The Brand's URL-safe identifier.
`brand.description`	`string`	Selectable in the Payload builder The Brand description in the store's default locale.
`brand.seo_title`	`string`	Selectable in the Payload builder The Brand page's SEO title in the store's default locale.
`brand.seo_description`	`string`	Selectable in the Payload builder The Brand page's SEO description in the store's default locale.
`brand.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image id, or null when no image is assigned.
`brand.image_url`	`string`	Selectable in the Payload builder The original URL recorded for the assigned image, or an empty string.
`brand.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string.
`brand.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the Brand.
`brand.template_handle`	`string`	Selectable in the Payload builder The storefront template handle assigned to the Brand.
`brand.created_at`	`string`	Selectable in the Payload builder When the Brand was created.
`brand.updated_at`	`string`	Selectable in the Payload builder When the Brand last changed.
`brand.translations_updated_at`	`string`	Selectable in the Payload builder When any Brand translation last changed, or null when none exist.
`locale`	`string`	Selectable in the Payload builder The locale whose Brand translation changed.
`translation.name`	`string`	Selectable in the Payload builder The translated Brand name; an empty string on a delete event means it was removed.
`translation.slug`	`string`	Selectable in the Payload builder The translated Brand slug; an empty string on a delete event means it was removed.
`translation.description`	`string`	Selectable in the Payload builder The translated Brand description; an empty string on a delete event means it was removed.
`translation.seo_title`	`string`	Selectable in the Payload builder The translated SEO title; an empty string on a delete event means it was removed.
`translation.seo_description`	`string`	Selectable in the Payload builder The translated SEO description; an empty string on a delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's Brand translation changed.

Payload shape

Sample payload

{
  "brand": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme makes durable outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme",
    "product_count": 12,
    "seo_description": "Shop Acme outdoor gear.",
    "seo_title": "Acme Outdoor Gear",
    "slug": "acme",
    "template_handle": "default_brand",
    "translations_updated_at": "2026-06-10T09:30:00+05:30",
    "updated_at": "2026-06-10T09:30:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "description": "Acme fabrique du matériel de plein air durable.",
    "name": "Acme France",
    "seo_description": "Découvrez l’équipement de plein air Acme.",
    "seo_title": "Équipement de plein air Acme",
    "slug": "acme-france"
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Brand updated

EVENT brands/update App scope: read_products Staff permission: products:write

Fired when a brand changes. change_type is source for Brand field edits and assignments when product assignments change its product count. Source changes include previous and changed_fields; assignment changes report product_count in changed_fields. During a CSV product import, assignments changes are sent once per import chunk for each brand whose products changed, carrying the counts after the chunk.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

description image_id name product_count seo_description seo_title slug template_handle

Payload fields

Field	Type	Description
`brand.id`	`integer`	Always present The stable Brand id.
`brand.name`	`string`	Selectable in the Payload builder The merchant-facing Brand name.
`brand.slug`	`string`	Selectable in the Payload builder The Brand's URL-safe identifier.
`brand.description`	`string`	Selectable in the Payload builder The Brand description in the store's default locale.
`brand.seo_title`	`string`	Selectable in the Payload builder The Brand page's SEO title in the store's default locale.
`brand.seo_description`	`string`	Selectable in the Payload builder The Brand page's SEO description in the store's default locale.
`brand.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image id, or null when no image is assigned.
`brand.image_url`	`string`	Selectable in the Payload builder The original URL recorded for the assigned image, or an empty string.
`brand.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string.
`brand.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the Brand.
`brand.template_handle`	`string`	Selectable in the Payload builder The storefront template handle assigned to the Brand.
`brand.created_at`	`string`	Selectable in the Payload builder When the Brand was created.
`brand.updated_at`	`string`	Selectable in the Payload builder When the Brand last changed.
`brand.translations_updated_at`	`string`	Selectable in the Payload builder When any Brand translation last changed, or null when none exist.
`previous.id`	`integer`	Always present The stable Brand id. This value is from before the update.
`previous.name`	`string`	Selectable in the Payload builder The merchant-facing Brand name. This value is from before the update.
`previous.slug`	`string`	Selectable in the Payload builder The Brand's URL-safe identifier. This value is from before the update.
`previous.description`	`string`	Selectable in the Payload builder The Brand description in the store's default locale. This value is from before the update.
`previous.seo_title`	`string`	Selectable in the Payload builder The Brand page's SEO title in the store's default locale. This value is from before the update.
`previous.seo_description`	`string`	Selectable in the Payload builder The Brand page's SEO description in the store's default locale. This value is from before the update.
`previous.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image id, or null when no image is assigned. This value is from before the update.
`previous.image_url`	`string`	Selectable in the Payload builder The original URL recorded for the assigned image, or an empty string. This value is from before the update.
`previous.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string. This value is from before the update.
`previous.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the Brand. This value is from before the update.
`previous.template_handle`	`string`	Selectable in the Payload builder The storefront template handle assigned to the Brand. This value is from before the update.
`previous.created_at`	`string`	Selectable in the Payload builder When the Brand was created. This value is from before the update.
`previous.updated_at`	`string`	Selectable in the Payload builder When the Brand last changed. This value is from before the update.
`previous.translations_updated_at`	`string`	Selectable in the Payload builder When any Brand translation last changed, or null when none exist. This value is from before the update.
`changed_fields`	`array`	Always present The Brand fields changed by this event.
`change_type`	`string`	Always present Why brands/update fired: source for Brand field edits or assignments for product assignment-count changes.

Payload shape

Sample payload

{
  "brand": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme makes durable outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme",
    "product_count": 12,
    "seo_description": "Shop Acme outdoor gear.",
    "seo_title": "Acme Outdoor Gear",
    "slug": "acme",
    "template_handle": "default_brand",
    "translations_updated_at": "2026-06-09T12:00:00+05:30",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "change_type": "source",
  "changed_fields": [
    "name"
  ],
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme makes durable outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme",
    "product_count": 12,
    "seo_description": "Shop Acme outdoor gear.",
    "seo_title": "Acme Outdoor Gear",
    "slug": "acme",
    "template_handle": "default_brand",
    "translations_updated_at": "2026-06-09T12:00:00+05:30",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Category created

EVENT categories/create App scope: read_products Staff permission: products:write

Fired when a product category is created.

Payload fields

Field	Type	Description
`category.id`	`integer`	Always present
`category.parent_id`	`integer`	Selectable in the Payload builder
`category.name`	`string`	Selectable in the Payload builder
`category.slug`	`string`	Selectable in the Payload builder
`category.description`	`string`	Selectable in the Payload builder
`category.seo_title`	`string`	Selectable in the Payload builder
`category.seo_description`	`string`	Selectable in the Payload builder
`category.image_id`	`string`	Selectable in the Payload builder
`category.image_url`	`string`	Selectable in the Payload builder
`category.image_cdn_url`	`string`	Selectable in the Payload builder
`category.product_count`	`integer`	Selectable in the Payload builder
`category.template_handle`	`string`	Selectable in the Payload builder
`category.parent_name`	`string`	Selectable in the Payload builder
`category.has_children`	`boolean`	Selectable in the Payload builder
`category.created_at`	`string`	Selectable in the Payload builder
`category.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Clothing and accessories.",
    "has_children": false,
    "id": 5,
    "image_cdn_url": "",
    "image_id": null,
    "image_url": "",
    "name": "Apparel",
    "parent_id": null,
    "parent_name": null,
    "product_count": 0,
    "seo_description": "Shop apparel.",
    "seo_title": "Apparel",
    "slug": "apparel",
    "template_handle": "default_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Category deleted

EVENT categories/delete App scope: read_products Staff permission: products:write

Fired when a product category is deleted.

Payload fields

Field	Type	Description
`category.id`	`integer`	Always present
`category.name`	`string`	Selectable in the Payload builder
`category.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "category": {
    "id": 5,
    "name": "Apparel",
    "slug": "apparel"
  }
}

Category translations deleted

EVENT categories/translations/delete App scope: read_products Staff permission: products:write

Fired when a category's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`category.id`	`integer`	Always present
`category.parent_id`	`integer`	Selectable in the Payload builder
`category.name`	`string`	Selectable in the Payload builder
`category.slug`	`string`	Selectable in the Payload builder
`category.description`	`string`	Selectable in the Payload builder
`category.seo_title`	`string`	Selectable in the Payload builder
`category.seo_description`	`string`	Selectable in the Payload builder
`category.image_id`	`string`	Selectable in the Payload builder
`category.image_url`	`string`	Selectable in the Payload builder
`category.image_cdn_url`	`string`	Selectable in the Payload builder
`category.product_count`	`integer`	Selectable in the Payload builder
`category.template_handle`	`string`	Selectable in the Payload builder
`category.parent_name`	`string`	Selectable in the Payload builder
`category.has_children`	`boolean`	Selectable in the Payload builder
`category.created_at`	`string`	Selectable in the Payload builder
`category.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Clothing and accessories.",
    "has_children": true,
    "id": 5,
    "image_cdn_url": "",
    "image_id": null,
    "image_url": "",
    "name": "Apparel",
    "parent_id": null,
    "parent_name": null,
    "product_count": 87,
    "seo_description": "Shop apparel.",
    "seo_title": "Apparel",
    "slug": "apparel",
    "template_handle": "default_category",
    "updated_at": "2026-06-10T09:30:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "description": "",
    "name": "",
    "seo_description": "",
    "seo_title": "",
    "slug": ""
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Category translations updated

EVENT categories/translations/update App scope: read_products Staff permission: products:write

Fired when a category's translations are added or updated for a locale. Payload carries only the fields that changed.

Payload fields

Field	Type	Description
`category.id`	`integer`	Always present
`category.parent_id`	`integer`	Selectable in the Payload builder
`category.name`	`string`	Selectable in the Payload builder
`category.slug`	`string`	Selectable in the Payload builder
`category.description`	`string`	Selectable in the Payload builder
`category.seo_title`	`string`	Selectable in the Payload builder
`category.seo_description`	`string`	Selectable in the Payload builder
`category.image_id`	`string`	Selectable in the Payload builder
`category.image_url`	`string`	Selectable in the Payload builder
`category.image_cdn_url`	`string`	Selectable in the Payload builder
`category.product_count`	`integer`	Selectable in the Payload builder
`category.template_handle`	`string`	Selectable in the Payload builder
`category.parent_name`	`string`	Selectable in the Payload builder
`category.has_children`	`boolean`	Selectable in the Payload builder
`category.created_at`	`string`	Selectable in the Payload builder
`category.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Clothing and accessories.",
    "has_children": true,
    "id": 5,
    "image_cdn_url": "",
    "image_id": null,
    "image_url": "",
    "name": "Apparel",
    "parent_id": null,
    "parent_name": null,
    "product_count": 87,
    "seo_description": "Shop apparel.",
    "seo_title": "Apparel",
    "slug": "apparel",
    "template_handle": "default_category",
    "updated_at": "2026-06-10T09:30:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "description": "Vêtements et accessoires.",
    "name": "Vêtements",
    "seo_description": "Découvrez nos vêtements.",
    "seo_title": "Vêtements",
    "slug": "vetements"
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Category updated

EVENT categories/update App scope: read_products Staff permission: products:write

Fired when a product category is updated.

Payload fields

Field	Type	Description
`category.id`	`integer`	Always present
`category.parent_id`	`integer`	Selectable in the Payload builder
`category.name`	`string`	Selectable in the Payload builder
`category.slug`	`string`	Selectable in the Payload builder
`category.description`	`string`	Selectable in the Payload builder
`category.seo_title`	`string`	Selectable in the Payload builder
`category.seo_description`	`string`	Selectable in the Payload builder
`category.image_id`	`string`	Selectable in the Payload builder
`category.image_url`	`string`	Selectable in the Payload builder
`category.image_cdn_url`	`string`	Selectable in the Payload builder
`category.product_count`	`integer`	Selectable in the Payload builder
`category.template_handle`	`string`	Selectable in the Payload builder
`category.parent_name`	`string`	Selectable in the Payload builder
`category.has_children`	`boolean`	Selectable in the Payload builder
`category.created_at`	`string`	Selectable in the Payload builder
`category.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Always present

Payload shape

Sample payload

{
  "category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Clothing and accessories.",
    "has_children": true,
    "id": 5,
    "image_cdn_url": "",
    "image_id": null,
    "image_url": "",
    "name": "Apparel",
    "parent_id": null,
    "parent_name": null,
    "product_count": 87,
    "seo_description": "Shop apparel.",
    "seo_title": "Apparel",
    "slug": "apparel",
    "template_handle": "default_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "changed_fields": [
    "title",
    "status"
  ]
}

Category metafield value created

EVENT category_metafields/create App scope: read_products Staff permission: products:write

Fired when a category metafield value is created.

Payload fields

Field	Type	Description
`category.id`	`integer`	Always present
`category.name`	`string`	Selectable in the Payload builder
`category.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "category": {
    "id": 5,
    "name": "Apparel",
    "slug": "apparel"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "How to care for products in this category.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": true,
      "key": "care",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "Care instructions",
      "namespace": "app:catalog-sync.details",
      "owner_type": "category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Hand wash"
  }
}

Category metafield value deleted

EVENT category_metafields/delete App scope: read_products Staff permission: products:write

Fired when a category metafield value is deleted.

Payload fields

Field	Type	Description
`category.id`	`integer`	Always present
`category.name`	`string`	Selectable in the Payload builder
`category.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "category": {
    "id": 5,
    "name": "Apparel",
    "slug": "apparel"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "How to care for products in this category.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": true,
      "key": "care",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "Care instructions",
      "namespace": "app:catalog-sync.details",
      "owner_type": "category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Hand wash"
  }
}

Category metafield translation deleted

EVENT category_metafields/translations/delete App scope: read_products Staff permission: products:write

Fired when a category metafield translation is cleared for a locale.

Payload fields

Field	Type	Description
`metafield.category_id`	`integer`	Always present
`metafield.category_name`	`string`	Selectable in the Payload builder
`metafield.category_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "category_id": 5,
    "category_name": "Apparel",
    "category_slug": "apparel",
    "definition_id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
    "key": "care",
    "merchant_access": "read_write",
    "name": "Care instructions",
    "namespace": "app:catalog-sync.details",
    "type": "string"
  },
  "translation": {
    "value": ""
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Category metafield translation updated

EVENT category_metafields/translations/update App scope: read_products Staff permission: products:write

Fired when a category metafield translation is added or updated for a locale.

Payload fields

Field	Type	Description
`metafield.category_id`	`integer`	Always present
`metafield.category_name`	`string`	Selectable in the Payload builder
`metafield.category_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Always present
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "category_id": 5,
    "category_name": "Apparel",
    "category_slug": "apparel",
    "definition_id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
    "key": "care",
    "merchant_access": "read_write",
    "name": "Care instructions",
    "namespace": "app:catalog-sync.details",
    "type": "string"
  },
  "translation": {
    "value": "Lavage à la main"
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Category metafield value updated

EVENT category_metafields/update App scope: read_products Staff permission: products:write

Fired when a category metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`category.id`	`integer`	Always present
`category.name`	`string`	Selectable in the Payload builder
`category.slug`	`string`	Selectable in the Payload builder
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "category": {
    "id": 5,
    "name": "Apparel",
    "slug": "apparel"
  },
  "changed_fields": [
    "value"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "How to care for products in this category.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": true,
      "key": "care",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "Care instructions",
      "namespace": "app:catalog-sync.details",
      "owner_type": "category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-10T09:30:00+05:30",
    "value": "Machine wash cold"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "How to care for products in this category.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": true,
      "key": "care",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "Care instructions",
      "namespace": "app:catalog-sync.details",
      "owner_type": "category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Hand wash"
  }
}

Collection metafield value created

EVENT collection_metafields/create App scope: read_products Staff permission: products:write

Fired when a collection metafield value is created.

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Selectable in the Payload builder
`collection.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "collection": {
    "id": "...",
    "name": "...",
    "slug": "..."
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "...",
      "owner_type": "collection",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  }
}

Collection metafield value deleted

EVENT collection_metafields/delete App scope: read_products Staff permission: products:write

Fired when a collection metafield value is deleted, including when its collection is deleted.

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Selectable in the Payload builder
`collection.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "collection": {
    "id": "...",
    "name": "...",
    "slug": "..."
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "...",
      "owner_type": "collection",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  }
}

Collection metafield translations deleted

EVENT collection_metafields/translations/delete App scope: read_products Staff permission: products:write

Fired when a collection metafield's translation is cleared for a locale, including when its collection is deleted.

Payload fields

Field	Type	Description
`metafield.collection_id`	`string`	Always present
`metafield.collection_name`	`string`	Selectable in the Payload builder
`metafield.collection_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "collection_id": "...",
    "collection_name": "...",
    "collection_slug": "...",
    "definition_id": "...",
    "key": "...",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "...",
    "type": "string"
  },
  "translation": {
    "value": null
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Collection metafield translations updated

EVENT collection_metafields/translations/update App scope: read_products Staff permission: products:write

Fired when a collection metafield's translation is added or updated for a locale.

Payload fields

Field	Type	Description
`metafield.collection_id`	`string`	Always present
`metafield.collection_name`	`string`	Selectable in the Payload builder
`metafield.collection_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Always present
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "collection_id": "...",
    "collection_name": "...",
    "collection_slug": "...",
    "definition_id": "...",
    "key": "...",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "...",
    "type": "string"
  },
  "translation": {
    "value": null
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Collection metafield value updated

EVENT collection_metafields/update App scope: read_products Staff permission: products:write

Fired when a collection metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Selectable in the Payload builder
`collection.slug`	`string`	Selectable in the Payload builder
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "collection": {
    "id": "...",
    "name": "...",
    "slug": "..."
  },
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "...",
      "owner_type": "collection",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "...",
      "owner_type": "collection",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  }
}

Collection created

EVENT collections/create App scope: read_products Staff permission: products:write

Fired when a collection is created.

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Selectable in the Payload builder
`collection.slug`	`string`	Selectable in the Payload builder
`collection.description`	`string`	Selectable in the Payload builder
`collection.image_id`	`string`	Selectable in the Payload builder
`collection.image_url`	`string`	Selectable in the Payload builder
`collection.image_cdn_url`	`string`	Selectable in the Payload builder
`collection.seo_title`	`string`	Selectable in the Payload builder
`collection.seo_description`	`string`	Selectable in the Payload builder
`collection.template_handle`	`string`	Selectable in the Payload builder
`collection.match_type`	`string`	Selectable in the Payload builder
`collection.is_active`	`boolean`	Selectable in the Payload builder
`collection.product_count`	`integer`	Selectable in the Payload builder
`collection.materialized_at`	`string`	Selectable in the Payload builder
`collection.created_at`	`string`	Selectable in the Payload builder
`collection.updated_at`	`string`	Selectable in the Payload builder
`collection.rules[*].id`	`string`	Selectable in the Payload builder
`collection.rules[*].collection_id`	`string`	Selectable in the Payload builder
`collection.rules[*].field`	`string`	Selectable in the Payload builder
`collection.rules[*].operator`	`string`	Selectable in the Payload builder
`collection.rules[*].value`	`string`	Selectable in the Payload builder
`collection.rules[*].value_label`	`string`	Selectable in the Payload builder
`collection.rules[*].include_subcategories`	`boolean`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "collection": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Seasonal products for summer campaigns.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "image_cdn_url": "",
    "image_id": "8f2a1c2b-9d4e-4f74-a6cf-1d58f6f7c201",
    "image_url": "",
    "is_active": true,
    "match_type": "all",
    "materialized_at": "2026-06-09T12:00:00+05:30",
    "name": "Summer Sale",
    "product_count": 42,
    "rules": [
      {
        "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "field": "tag",
        "id": "8d8c22a3-7cf8-4d2c-a54b-45fa63693e83",
        "include_subcategories": false,
        "operator": "equals",
        "value": "7",
        "value_label": "Summer"
      }
    ],
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale",
    "template_handle": "default_collection",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Collection deleted

EVENT collections/delete App scope: read_products Staff permission: products:write

Fired when a collection is deleted.

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Selectable in the Payload builder
`collection.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "collection": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Summer Sale",
    "slug": "summer-sale"
  }
}

Collection translations deleted

EVENT collections/translations/delete App scope: read_products Staff permission: products:write

Fired when a collection's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Selectable in the Payload builder
`collection.slug`	`string`	Selectable in the Payload builder
`collection.description`	`string`	Selectable in the Payload builder
`collection.image_id`	`string`	Selectable in the Payload builder
`collection.image_url`	`string`	Selectable in the Payload builder
`collection.image_cdn_url`	`string`	Selectable in the Payload builder
`collection.seo_title`	`string`	Selectable in the Payload builder
`collection.seo_description`	`string`	Selectable in the Payload builder
`collection.template_handle`	`string`	Selectable in the Payload builder
`collection.match_type`	`string`	Selectable in the Payload builder
`collection.is_active`	`boolean`	Selectable in the Payload builder
`collection.product_count`	`integer`	Selectable in the Payload builder
`collection.materialized_at`	`string`	Selectable in the Payload builder
`collection.created_at`	`string`	Selectable in the Payload builder
`collection.updated_at`	`string`	Selectable in the Payload builder
`collection.rules[*].id`	`string`	Selectable in the Payload builder
`collection.rules[*].collection_id`	`string`	Selectable in the Payload builder
`collection.rules[*].field`	`string`	Selectable in the Payload builder
`collection.rules[*].operator`	`string`	Selectable in the Payload builder
`collection.rules[*].value`	`string`	Selectable in the Payload builder
`collection.rules[*].value_label`	`string`	Selectable in the Payload builder
`collection.rules[*].include_subcategories`	`boolean`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "collection": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Seasonal products for summer campaigns.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "image_cdn_url": "",
    "image_id": "8f2a1c2b-9d4e-4f74-a6cf-1d58f6f7c201",
    "image_url": "",
    "is_active": true,
    "match_type": "all",
    "materialized_at": "2026-06-09T12:00:00+05:30",
    "name": "Summer Sale",
    "product_count": 42,
    "rules": [
      {
        "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "field": "tag",
        "id": "8d8c22a3-7cf8-4d2c-a54b-45fa63693e83",
        "include_subcategories": false,
        "operator": "equals",
        "value": "7",
        "value_label": "Summer"
      }
    ],
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale",
    "template_handle": "default_collection",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "description": "Seasonal products for summer campaigns.",
    "name": "Summer Sale",
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Collection translations updated

EVENT collections/translations/update App scope: read_products Staff permission: products:write

Fired when a collection's translations are added or updated for a locale.

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Selectable in the Payload builder
`collection.slug`	`string`	Selectable in the Payload builder
`collection.description`	`string`	Selectable in the Payload builder
`collection.image_id`	`string`	Selectable in the Payload builder
`collection.image_url`	`string`	Selectable in the Payload builder
`collection.image_cdn_url`	`string`	Selectable in the Payload builder
`collection.seo_title`	`string`	Selectable in the Payload builder
`collection.seo_description`	`string`	Selectable in the Payload builder
`collection.template_handle`	`string`	Selectable in the Payload builder
`collection.match_type`	`string`	Selectable in the Payload builder
`collection.is_active`	`boolean`	Selectable in the Payload builder
`collection.product_count`	`integer`	Selectable in the Payload builder
`collection.materialized_at`	`string`	Selectable in the Payload builder
`collection.created_at`	`string`	Selectable in the Payload builder
`collection.updated_at`	`string`	Selectable in the Payload builder
`collection.rules[*].id`	`string`	Selectable in the Payload builder
`collection.rules[*].collection_id`	`string`	Selectable in the Payload builder
`collection.rules[*].field`	`string`	Selectable in the Payload builder
`collection.rules[*].operator`	`string`	Selectable in the Payload builder
`collection.rules[*].value`	`string`	Selectable in the Payload builder
`collection.rules[*].value_label`	`string`	Selectable in the Payload builder
`collection.rules[*].include_subcategories`	`boolean`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.name`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "collection": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Seasonal products for summer campaigns.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "image_cdn_url": "",
    "image_id": "8f2a1c2b-9d4e-4f74-a6cf-1d58f6f7c201",
    "image_url": "",
    "is_active": true,
    "match_type": "all",
    "materialized_at": "2026-06-09T12:00:00+05:30",
    "name": "Summer Sale",
    "product_count": 42,
    "rules": [
      {
        "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "field": "tag",
        "id": "8d8c22a3-7cf8-4d2c-a54b-45fa63693e83",
        "include_subcategories": false,
        "operator": "equals",
        "value": "7",
        "value_label": "Summer"
      }
    ],
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale",
    "template_handle": "default_collection",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "description": "Seasonal products for summer campaigns.",
    "name": "Summer Sale",
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Collection updated

EVENT collections/update App scope: read_products Staff permission: products:write

Fired when a collection is updated — including rule changes and image changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

description image_id is_active match_type memberships name rules seo_description seo_title slug template_handle

Payload fields

Field	Type	Description
`collection.id`	`string`	Always present
`collection.name`	`string`	Selectable in the Payload builder
`collection.slug`	`string`	Selectable in the Payload builder
`collection.description`	`string`	Selectable in the Payload builder
`collection.image_id`	`string`	Selectable in the Payload builder
`collection.image_url`	`string`	Selectable in the Payload builder
`collection.image_cdn_url`	`string`	Selectable in the Payload builder
`collection.seo_title`	`string`	Selectable in the Payload builder
`collection.seo_description`	`string`	Selectable in the Payload builder
`collection.template_handle`	`string`	Selectable in the Payload builder
`collection.match_type`	`string`	Selectable in the Payload builder
`collection.is_active`	`boolean`	Selectable in the Payload builder
`collection.product_count`	`integer`	Selectable in the Payload builder
`collection.materialized_at`	`string`	Selectable in the Payload builder
`collection.created_at`	`string`	Selectable in the Payload builder
`collection.updated_at`	`string`	Selectable in the Payload builder
`collection.rules[*].id`	`string`	Selectable in the Payload builder
`collection.rules[*].collection_id`	`string`	Selectable in the Payload builder
`collection.rules[*].field`	`string`	Selectable in the Payload builder
`collection.rules[*].operator`	`string`	Selectable in the Payload builder
`collection.rules[*].value`	`string`	Selectable in the Payload builder
`collection.rules[*].value_label`	`string`	Selectable in the Payload builder
`collection.rules[*].include_subcategories`	`boolean`	Selectable in the Payload builder
`changed_fields`	`array`	Always present

Payload shape

Sample payload

{
  "changed_fields": [
    "seo_title",
    "seo_description"
  ],
  "collection": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Seasonal products for summer campaigns.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "image_cdn_url": "",
    "image_id": "8f2a1c2b-9d4e-4f74-a6cf-1d58f6f7c201",
    "image_url": "",
    "is_active": true,
    "match_type": "all",
    "materialized_at": "2026-06-09T12:00:00+05:30",
    "name": "Summer Sale",
    "product_count": 42,
    "rules": [
      {
        "collection_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "field": "tag",
        "id": "8d8c22a3-7cf8-4d2c-a54b-45fa63693e83",
        "include_subcategories": false,
        "operator": "equals",
        "value": "7",
        "value_label": "Summer"
      }
    ],
    "seo_description": "Shop products in the Summer Sale collection.",
    "seo_title": "Summer Sale",
    "slug": "summer-sale",
    "template_handle": "default_collection",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Currency data removed

EVENT currencies/data_removed App scope: read_currencies Staff permission: settings.currencies:read

Fired after Remove currency data is confirmed and saved. The payload names the currency and counts, by type, how many prices, amounts, and settings in that currency were removed or cleared; removed is the total. Records that belong to a removed product feed go with it and are not counted. The currency itself stays in the store, and past orders, payments, and other financial records are never changed.

Payload fields

Field	Type	Description
`currency_id`	`string`	Always present The ID of the currency whose data was removed. The currency itself is not deleted.
`currency_code`	`string`	Always present The ISO 4217 code of that currency.
`removed`	`integer`	Selectable in the Payload builder The total number of references removed or cleared: the sum of every value in counts.
`counts.product_prices`	`integer`	Selectable in the Payload builder How many product prices in this currency were removed or cleared.
`counts.variant_prices`	`integer`	Selectable in the Payload builder How many variant prices in this currency were removed or cleared.
`counts.product_shipping_prices`	`integer`	Selectable in the Payload builder How many product shipping prices in this currency were removed or cleared.
`counts.variant_shipping_prices`	`integer`	Selectable in the Payload builder How many variant shipping prices in this currency were removed or cleared.
`counts.channel_feed_units`	`integer`	Selectable in the Payload builder How many sales-channel product feeds in this currency were removed or cleared.
`counts.shipping_rate_thresholds`	`integer`	Selectable in the Payload builder How many shipping rate thresholds in this currency were removed or cleared.
`counts.quantity_price_tiers`	`integer`	Selectable in the Payload builder How many quantity price tiers in this currency were removed or cleared.
`counts.market_currencies`	`integer`	Selectable in the Payload builder How many market currency assignments in this currency were removed or cleared.
`counts.market_country_currencies`	`integer`	Selectable in the Payload builder How many country currency selections in markets in this currency were removed or cleared.
`counts.shipping_rate_prices`	`integer`	Selectable in the Payload builder How many shipping rate prices in this currency were removed or cleared.
`counts.checkout_settings_amounts`	`integer`	Selectable in the Payload builder How many checkout setting amounts in this currency were removed or cleared.
`counts.checkout_fee_amounts`	`integer`	Selectable in the Payload builder How many checkout fee amounts in this currency were removed or cleared.
`counts.cod_settings_amounts`	`integer`	Selectable in the Payload builder How many cash-on-delivery setting amounts in this currency were removed or cleared.
`counts.cod_zone_amounts`	`integer`	Selectable in the Payload builder How many cash-on-delivery zone amounts in this currency were removed or cleared.
`counts.market_discount_amounts`	`integer`	Selectable in the Payload builder How many discount amounts in this currency were removed or cleared.
`counts.shipping_settings_amounts`	`integer`	Selectable in the Payload builder How many shipping setting amounts in this currency were removed or cleared.
`counts.duty_country_rules`	`integer`	Selectable in the Payload builder How many duty rules in this currency were removed or cleared.

Payload shape

Sample payload

{
  "counts": {
    "channel_feed_units": 1,
    "checkout_fee_amounts": 0,
    "checkout_settings_amounts": 0,
    "cod_settings_amounts": 0,
    "cod_zone_amounts": 0,
    "duty_country_rules": 0,
    "market_country_currencies": 1,
    "market_currencies": 1,
    "market_discount_amounts": 1,
    "product_prices": 3,
    "product_shipping_prices": 1,
    "quantity_price_tiers": 0,
    "shipping_rate_prices": 1,
    "shipping_rate_thresholds": 1,
    "shipping_settings_amounts": 0,
    "variant_prices": 2,
    "variant_shipping_prices": 0
  },
  "currency_code": "USD",
  "currency_id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
  "removed": 12
}

Exchange rates updated

EVENT currencies/rates_updated App scope: read_currencies Staff permission: settings.currencies:read

Fired when a market-rate refresh changes the rate a store with automatic exchange rates prices an enabled currency at. Only currencies whose rate changed are listed, each with its previous and new rate and its rounding rule. Prices set explicitly in a currency are unaffected. Use it to update converted prices you keep elsewhere, such as in a product feed. Stores with manual rates never receive it; their rate edits fire currencies/update.

Payload fields

Field	Type	Description
`base_currency_code`	`string`	Always present The store's base currency. Rates convert one unit of it into each listed currency.
`currencies[*].code`	`string`	Always present The ISO 4217 code of a currency whose rate changed.
`currencies[*].previous_rate`	`string`	Selectable in the Payload builder The rate prices in this currency used before the refresh, as a decimal string, or null when no current market rate existed.
`currencies[*].rate`	`string`	Always present The rate prices in this currency use now, as a decimal string.
`currencies[*].rounding_mode`	`string`	Selectable in the Payload builder The rounding rule applied to converted prices in this currency. A changed rate can leave rounded prices unchanged.
`updated_at`	`string`	Always present When the new rates took effect, in the store's time zone with its offset (RFC 3339).

Payload shape

Sample payload

{
  "base_currency_code": "INR",
  "currencies": [
    {
      "code": "EUR",
      "previous_rate": "0.010214",
      "rate": "0.010197",
      "rounding_mode": "nearest_99"
    }
  ],
  "updated_at": "2026-10-07T00:05:00+05:30"
}

Currency updated

EVENT currencies/update App scope: read_currencies Staff permission: settings.currencies:read

Fired after currencies are added, changed, enabled, disabled, rounded, or removed, after currency data is removed, or after multi-currency or automatic-rate mode changes. The currencies array contains the complete current store currency set, each with the rate prices use and its rate_source. change_type says what changed; branch on it. reason is display text. Changed currency IDs and codes are included only when applicable. Automatic market-rate refreshes fire currencies/rates_updated instead.

Payload fields

Field	Type	Description
`currencies[*].id`	`string`	Always present The store currency ID.
`currencies[*].code`	`string`	Selectable in the Payload builder The ISO 4217 currency code.
`currencies[*].name`	`string`	Selectable in the Payload builder The currency's English name.
`currencies[*].symbol`	`string`	Selectable in the Payload builder The currency symbol.
`currencies[*].decimals`	`integer`	Selectable in the Payload builder The number of decimal places amounts in this currency use.
`currencies[*].conversion_rate`	`string`	Selectable in the Payload builder The rate prices use, as a decimal string: one unit of the base currency equals this many units of this currency. The base currency is always 1.
`currencies[*].rate_source`	`string`	Selectable in the Payload builder Where conversion_rate comes from: manual (the merchant's saved rate), automatic (the current market rate), or automatic_unavailable (automatic rates are on but no current market rate exists, so prices in this currency cannot be charged until rates refresh).
`currencies[*].is_enabled`	`boolean`	Selectable in the Payload builder Whether the currency is enabled for the store. Market assignment still decides where shoppers can use it.
`currencies[*].is_base`	`boolean`	Selectable in the Payload builder True for the store's base currency, which is set when the store is created and never changes.
`currencies[*].rounding_mode`	`string`	Selectable in the Payload builder The rounding rule applied to converted prices in this currency. The base currency is always none.
`currencies[*].created_at`	`string`	Selectable in the Payload builder When the currency was added, in the store's time zone with its offset (RFC 3339).
`currencies[*].updated_at`	`string`	Selectable in the Payload builder When the currency last changed, in the store's time zone with its offset (RFC 3339).
`multi_currency_enabled`	`boolean`	Selectable in the Payload builder Whether the store sells in additional currencies after this change.
`use_auto_exchange_rates`	`boolean`	Selectable in the Payload builder Whether exchange rates follow the market automatically after this change.
`change_type`	`string`	Selectable in the Payload builder What changed. One of created, updated, deleted, rounding_updated, enabled, disabled, multi_currency_enabled, multi_currency_disabled, auto_rates_enabled, auto_rates_disabled, bulk_created, bulk_deleted, bulk_updated, bulk_enabled, bulk_disabled, data_removed. Branch on this field.
`reason`	`string`	Selectable in the Payload builder A short English description of the change for display or logs. Its wording can change; branch on change_type instead.
`changed_currency_id`	`string`	Selectable in the Payload builder The ID of the one currency that changed. Omitted when the change affects several currencies or no single currency.
`changed_currency_code`	`string`	Selectable in the Payload builder The code of the one currency that changed. Omitted when the change affects several currencies or no single currency.
`changed_currency_ids`	`array`	Selectable in the Payload builder The IDs of the currencies a bulk change affected. Omitted for a single-currency change.
`changed_currency_codes`	`array`	Selectable in the Payload builder The codes of the currencies a bulk change affected. Omitted for a single-currency change.

Payload shape

Sample payload

{
  "change_type": "updated",
  "changed_currency_code": "USD",
  "changed_currency_id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
  "currencies": [
    {
      "code": "INR",
      "conversion_rate": "1",
      "created_at": "2026-07-01T10:15:00+05:30",
      "decimals": 2,
      "id": "2c7c8547-cc7b-46b2-b32d-31c9f3f2abf8",
      "is_base": true,
      "is_enabled": true,
      "name": "Indian Rupee",
      "rate_source": "manual",
      "rounding_mode": "none",
      "symbol": "₹",
      "updated_at": "2026-07-01T10:15:00+05:30"
    },
    {
      "code": "USD",
      "conversion_rate": "0.0105",
      "created_at": "2026-07-01T10:16:00+05:30",
      "decimals": 2,
      "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
      "is_base": false,
      "is_enabled": true,
      "name": "US Dollar",
      "rate_source": "manual",
      "rounding_mode": "nearest_99",
      "symbol": "$",
      "updated_at": "2026-07-08T18:45:00+05:30"
    }
  ],
  "multi_currency_enabled": true,
  "reason": "conversion rate updated",
  "use_auto_exchange_rates": false
}

Customer address created

EVENT customer_addresses/create App scope: read_customers Staff permission: customers:write

Fired when a customer address is created through self-service, admin, Store API, or CSV import.

Payload fields

Field	Type	Description
`customer.id`	`string`	Always present
`customer.email`	`string`	Selectable in the Payload builder
`address.id`	`string`	Always present
`address.name`	`string`	Selectable in the Payload builder
`address.address_type`	`string`	Selectable in the Payload builder
`address.is_default`	`boolean`	Selectable in the Payload builder
`address.first_name`	`string`	Selectable in the Payload builder
`address.last_name`	`string`	Selectable in the Payload builder
`address.company`	`string`	Selectable in the Payload builder
`address.phone`	`string`	Selectable in the Payload builder
`address.address1`	`string`	Selectable in the Payload builder
`address.address2`	`string`	Selectable in the Payload builder
`address.city`	`string`	Selectable in the Payload builder
`address.province`	`string`	Selectable in the Payload builder
`address.province_code`	`string`	Selectable in the Payload builder
`address.country`	`string`	Selectable in the Payload builder
`address.country_code`	`string`	Selectable in the Payload builder
`address.postal_code`	`string`	Selectable in the Payload builder
`address.created_at`	`string`	Selectable in the Payload builder
`address.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "address": {
    "address1": "500 Market Street",
    "address2": null,
    "address_type": "shipping",
    "city": "San Francisco",
    "company": null,
    "country": "United States",
    "country_code": "US",
    "created_at": "2026-06-09T12:00:00+05:30",
    "first_name": "Jane",
    "id": "cus_5d2e8b1a",
    "is_default": true,
    "last_name": "Doe",
    "name": "Home",
    "phone": "+14155550123",
    "postal_code": "94105",
    "province": "California",
    "province_code": "CA",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "customer": {
    "email": "jane.doe@example.com",
    "id": "cus_5d2e8b1a"
  }
}

Customer address deleted

EVENT customer_addresses/delete App scope: read_customers Staff permission: customers:write

Fired when a customer address is removed.

Payload fields

Field	Type	Description
`customer.id`	`string`	Always present
`customer.email`	`string`	Selectable in the Payload builder
`address.id`	`string`	Always present
`address.name`	`string`	Selectable in the Payload builder
`address.address_type`	`string`	Selectable in the Payload builder
`address.is_default`	`boolean`	Selectable in the Payload builder
`address.first_name`	`string`	Selectable in the Payload builder
`address.last_name`	`string`	Selectable in the Payload builder
`address.company`	`string`	Selectable in the Payload builder
`address.phone`	`string`	Selectable in the Payload builder
`address.address1`	`string`	Selectable in the Payload builder
`address.address2`	`string`	Selectable in the Payload builder
`address.city`	`string`	Selectable in the Payload builder
`address.province`	`string`	Selectable in the Payload builder
`address.province_code`	`string`	Selectable in the Payload builder
`address.country`	`string`	Selectable in the Payload builder
`address.country_code`	`string`	Selectable in the Payload builder
`address.postal_code`	`string`	Selectable in the Payload builder
`address.created_at`	`string`	Selectable in the Payload builder
`address.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "address": {
    "address1": "500 Market Street",
    "address2": null,
    "address_type": "shipping",
    "city": "San Francisco",
    "company": null,
    "country": "United States",
    "country_code": "US",
    "created_at": "2026-06-09T12:00:00+05:30",
    "first_name": "Jane",
    "id": "cus_5d2e8b1a",
    "is_default": true,
    "last_name": "Doe",
    "name": "Home",
    "phone": "+14155550123",
    "postal_code": "94105",
    "province": "California",
    "province_code": "CA",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "customer": {
    "email": "jane.doe@example.com",
    "id": "cus_5d2e8b1a"
  }
}

Customer address updated

EVENT customer_addresses/update App scope: read_customers Staff permission: customers:write

Fired when a customer address changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

address1 address2 address_type city company country country_code first_name is_default last_name name phone postal_code province province_code

Payload fields

Field	Type	Description
`customer.id`	`string`	Always present
`customer.email`	`string`	Selectable in the Payload builder
`previous.id`	`string`	Always present
`previous.name`	`string`	Selectable in the Payload builder
`previous.address_type`	`string`	Selectable in the Payload builder
`previous.is_default`	`boolean`	Selectable in the Payload builder
`previous.first_name`	`string`	Selectable in the Payload builder
`previous.last_name`	`string`	Selectable in the Payload builder
`previous.company`	`string`	Selectable in the Payload builder
`previous.phone`	`string`	Selectable in the Payload builder
`previous.address1`	`string`	Selectable in the Payload builder
`previous.address2`	`string`	Selectable in the Payload builder
`previous.city`	`string`	Selectable in the Payload builder
`previous.province`	`string`	Selectable in the Payload builder
`previous.province_code`	`string`	Selectable in the Payload builder
`previous.country`	`string`	Selectable in the Payload builder
`previous.country_code`	`string`	Selectable in the Payload builder
`previous.postal_code`	`string`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.id`	`string`	Always present
`current.name`	`string`	Selectable in the Payload builder
`current.address_type`	`string`	Selectable in the Payload builder
`current.is_default`	`boolean`	Selectable in the Payload builder
`current.first_name`	`string`	Selectable in the Payload builder
`current.last_name`	`string`	Selectable in the Payload builder
`current.company`	`string`	Selectable in the Payload builder
`current.phone`	`string`	Selectable in the Payload builder
`current.address1`	`string`	Selectable in the Payload builder
`current.address2`	`string`	Selectable in the Payload builder
`current.city`	`string`	Selectable in the Payload builder
`current.province`	`string`	Selectable in the Payload builder
`current.province_code`	`string`	Selectable in the Payload builder
`current.country`	`string`	Selectable in the Payload builder
`current.country_code`	`string`	Selectable in the Payload builder
`current.postal_code`	`string`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "address1",
    "postal_code"
  ],
  "current": {
    "address1": "500 Market Street",
    "address2": null,
    "address_type": "shipping",
    "city": "San Francisco",
    "company": null,
    "country": "United States",
    "country_code": "US",
    "created_at": "2026-06-09T12:00:00+05:30",
    "first_name": "Jane",
    "id": "cus_5d2e8b1a",
    "is_default": true,
    "last_name": "Doe",
    "name": "Home",
    "phone": "+14155550123",
    "postal_code": "94105",
    "province": "California",
    "province_code": "CA",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "customer": {
    "email": "jane.doe@example.com",
    "id": "cus_5d2e8b1a"
  },
  "previous": {
    "address1": "500 Market Street",
    "address2": null,
    "address_type": "shipping",
    "city": "San Francisco",
    "company": null,
    "country": "United States",
    "country_code": "US",
    "created_at": "2026-06-09T12:00:00+05:30",
    "first_name": "Jane",
    "id": "cus_5d2e8b1a",
    "is_default": true,
    "last_name": "Doe",
    "name": "Home",
    "phone": "+14155550123",
    "postal_code": "94105",
    "province": "California",
    "province_code": "CA",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Customer group created

EVENT customer_groups/create App scope: read_customers Staff permission: customers:write

Fired when a customer group is created.

Payload fields

Field	Type	Description
`group.id`	`string`	Always present
`group.name`	`string`	Selectable in the Payload builder
`group.slug`	`string`	Selectable in the Payload builder
`group.description`	`string`	Selectable in the Payload builder
`group.type`	`string`	Selectable in the Payload builder
`group.match_type`	`string`	Selectable in the Payload builder
`group.member_count`	`integer`	Selectable in the Payload builder
`group.created_at`	`string`	Selectable in the Payload builder
`group.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "group": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Customers with lifetime spend over $500.",
    "id": "cus_5d2e8b1a",
    "match_type": "all",
    "member_count": 128,
    "name": "VIP customers",
    "slug": "vip-customers",
    "type": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Customer group deleted

EVENT customer_groups/delete App scope: read_customers Staff permission: customers:write

Fired when a customer group is deleted.

Payload fields

Field	Type	Description
`group.id`	`string`	Always present
`group.name`	`string`	Selectable in the Payload builder
`group.slug`	`string`	Selectable in the Payload builder
`group.description`	`string`	Selectable in the Payload builder
`group.type`	`string`	Selectable in the Payload builder
`group.match_type`	`string`	Selectable in the Payload builder
`group.member_count`	`integer`	Selectable in the Payload builder
`group.created_at`	`string`	Selectable in the Payload builder
`group.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "group": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Customers with lifetime spend over $500.",
    "id": "cus_5d2e8b1a",
    "match_type": "all",
    "member_count": 128,
    "name": "VIP customers",
    "slug": "vip-customers",
    "type": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Customer group updated

EVENT customer_groups/update App scope: read_customers Staff permission: customers:write

Fired when a customer group's definition changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

description match_type name rules slug

Payload fields

Field	Type	Description
`previous.id`	`string`	Always present
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.description`	`string`	Selectable in the Payload builder
`previous.type`	`string`	Selectable in the Payload builder
`previous.match_type`	`string`	Selectable in the Payload builder
`previous.member_count`	`integer`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.id`	`string`	Always present
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.description`	`string`	Selectable in the Payload builder
`current.type`	`string`	Selectable in the Payload builder
`current.match_type`	`string`	Selectable in the Payload builder
`current.member_count`	`integer`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "name",
    "rules"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Customers with lifetime spend over $500.",
    "id": "cus_5d2e8b1a",
    "match_type": "all",
    "member_count": 128,
    "name": "VIP customers",
    "slug": "vip-customers",
    "type": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Customers with lifetime spend over $500.",
    "id": "cus_5d2e8b1a",
    "match_type": "all",
    "member_count": 128,
    "name": "VIP customers",
    "slug": "vip-customers",
    "type": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Customer metafield value created

EVENT customer_metafields/create App scope: read_customers Staff permission: customers:write

Fired when a customer metafield value is created.

Payload fields

Field	Type	Description
`customer.customer_id`	`string`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "customer": {
    "customer_id": "943b4b91-be6e-4d96-aebf-cbcaf685246d"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  }
}

Customer metafield value deleted

EVENT customer_metafields/delete App scope: read_customers Staff permission: customers:write

Fired when a customer metafield value is deleted.

Payload fields

Field	Type	Description
`customer.customer_id`	`string`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "customer": {
    "customer_id": "943b4b91-be6e-4d96-aebf-cbcaf685246d"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  }
}

Customer metafield value updated

EVENT customer_metafields/update App scope: read_customers Staff permission: customers:write

Fired when a customer metafield value changes.

Payload fields

Field	Type	Description
`customer.customer_id`	`string`	Always present
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  },
  "customer": {
    "customer_id": "943b4b91-be6e-4d96-aebf-cbcaf685246d"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  }
}

Customer tag created

EVENT customer_tags/create App scope: read_customers Staff permission: customers:write

Fired when a customer tag is created.

Payload fields

Field	Type	Description
`tag.id`	`string`	Always present
`tag.name`	`string`	Selectable in the Payload builder
`tag.slug`	`string`	Selectable in the Payload builder
`tag.customer_count`	`integer`	Selectable in the Payload builder
`tag.created_at`	`string`	Selectable in the Payload builder
`tag.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "customer_count": 128,
    "id": "cus_5d2e8b1a",
    "name": "VIP",
    "slug": "vip",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Customer tag deleted

EVENT customer_tags/delete App scope: read_customers Staff permission: customers:write

Fired when a customer tag is deleted; assignments cascade.

Payload fields

Field	Type	Description
`tag.id`	`string`	Always present
`tag.name`	`string`	Selectable in the Payload builder
`tag.slug`	`string`	Selectable in the Payload builder
`tag.customer_count`	`integer`	Selectable in the Payload builder
`tag.created_at`	`string`	Selectable in the Payload builder
`tag.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "customer_count": 128,
    "id": "cus_5d2e8b1a",
    "name": "VIP",
    "slug": "vip",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Customer tag updated

EVENT customer_tags/update App scope: read_customers Staff permission: customers:write

Fired when a customer tag is renamed.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

name slug

Payload fields

Field	Type	Description
`previous.id`	`string`	Always present
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.customer_count`	`integer`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.id`	`string`	Always present
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.customer_count`	`integer`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "name",
    "slug"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "customer_count": 128,
    "id": "cus_5d2e8b1a",
    "name": "VIP",
    "slug": "vip",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "customer_count": 128,
    "id": "cus_5d2e8b1a",
    "name": "VIP",
    "slug": "vip",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Customer created

EVENT customers/create App scope: read_customers Staff permission: customers:read

Fired when a customer is created — by a merchant in the admin or by self-registration on the storefront.

Payload fields

Field	Type	Description
`customer.id`	`string`	Always present
`customer.email`	`string`	Selectable in the Payload builder
`customer.first_name`	`string`	Selectable in the Payload builder
`customer.last_name`	`string`	Selectable in the Payload builder
`customer.phone`	`string`	Selectable in the Payload builder
`customer.status`	`string`	Selectable in the Payload builder
`customer.email_verified`	`boolean`	Selectable in the Payload builder
`customer.accepts_marketing`	`boolean`	Selectable in the Payload builder
`customer.text_marketing`	`string`	Selectable in the Payload builder
`customer.tags`	`array`	Selectable in the Payload builder
`customer.created_at`	`string`	Selectable in the Payload builder
`customer.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "customer": {
    "accepts_marketing": true,
    "created_at": "2026-06-09T12:00:00+05:30",
    "email": "jane.doe@example.com",
    "email_verified": true,
    "first_name": "Jane",
    "id": "cus_5d2e8b1a",
    "last_name": "Doe",
    "phone": "+14155550123",
    "status": "active",
    "tags": [
      "vip"
    ],
    "text_marketing": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Customer data requested

EVENT customers/data_request App scope: read_customers Staff permission: customers:read

Fired when a shopper's request for a copy of their data is being handled. Send the store the data your app holds about them.

Payload fields

Field	Type	Description
`privacy_request.id`	`string`	Always present
`privacy_request.reference`	`string`	Always present
`privacy_request.created_at`	`string`	Always present
`customer.id`	`string`	Selectable in the Payload builder
`customer.email`	`string`	Always present

Payload shape

Sample payload

{
  "customer": {
    "email": "jane.doe@example.com",
    "id": "cus_5d2e8b1a"
  },
  "privacy_request": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "cus_5d2e8b1a",
    "reference": "..."
  }
}

Customer deleted

EVENT customers/delete App scope: read_customers Staff permission: customers:read

Fired when a customer is deleted (single or bulk; one event per customer).

Payload fields

Field	Type	Description
`customer.id`	`string`	Always present
`customer.email`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "customer": {
    "email": "jane.doe@example.com",
    "id": "cus_5d2e8b1a"
  }
}

Customer data erased

EVENT customers/redact App scope: read_customers Staff permission: customers:read

Fired when the store has erased a shopper's data at their request. Delete what your app holds about them, unless the law requires you to keep it.

Payload fields

Field	Type	Description
`privacy_request.id`	`string`	Always present
`privacy_request.reference`	`string`	Always present
`privacy_request.created_at`	`string`	Always present
`customer.id`	`string`	Selectable in the Payload builder
`customer.email`	`string`	Always present

Payload shape

Sample payload

{
  "customer": {
    "email": "jane.doe@example.com",
    "id": "cus_5d2e8b1a"
  },
  "privacy_request": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "cus_5d2e8b1a",
    "reference": "..."
  }
}

Customer updated

EVENT customers/update App scope: read_customers Staff permission: customers:read

Fired when a customer's profile or status changes. Bulk operations fire one event per affected customer.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

accepts_marketing date_of_birth email first_name last_name note phone phone_country_code status tags

Payload fields

Field	Type	Description
`customer.id`	`string`	Always present
`customer.email`	`string`	Selectable in the Payload builder
`customer.first_name`	`string`	Selectable in the Payload builder
`customer.last_name`	`string`	Selectable in the Payload builder
`customer.phone`	`string`	Selectable in the Payload builder
`customer.status`	`string`	Selectable in the Payload builder
`customer.email_verified`	`boolean`	Selectable in the Payload builder
`customer.accepts_marketing`	`boolean`	Selectable in the Payload builder
`customer.text_marketing`	`string`	Selectable in the Payload builder
`customer.tags`	`array`	Selectable in the Payload builder
`customer.created_at`	`string`	Selectable in the Payload builder
`customer.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "first_name",
    "tags"
  ],
  "customer": {
    "accepts_marketing": true,
    "created_at": "2026-06-09T12:00:00+05:30",
    "email": "jane.doe@example.com",
    "email_verified": true,
    "first_name": "Jane",
    "id": "cus_5d2e8b1a",
    "last_name": "Doe",
    "phone": "+14155550123",
    "status": "active",
    "tags": [
      "vip"
    ],
    "text_marketing": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Store Credit granted

EVENT store_credit/grant App scope: read_customers Staff permission: customers:write

Fired when a merchant grants Store Credit to a customer.

Payload fields

Field	Type	Description
`store_credit.id`	`string`	Always present
`store_credit.customer_id`	`string`	Always present
`store_credit.currency_code`	`string`	Selectable in the Payload builder
`store_credit.balance`	`string`	Selectable in the Payload builder
`store_credit.updated_at`	`string`	Selectable in the Payload builder
`movement.id`	`string`	Always present
`movement.kind`	`string`	Selectable in the Payload builder
`movement.amount`	`string`	Selectable in the Payload builder
`movement.currency_code`	`string`	Selectable in the Payload builder
`movement.balance_after`	`string`	Selectable in the Payload builder
`movement.source`	`string`	Selectable in the Payload builder
`movement.reason`	`string`	Selectable in the Payload builder
`movement.reference_type`	`string`	Selectable in the Payload builder
`movement.reference_id`	`string`	Selectable in the Payload builder
`movement.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "movement": {
    "amount": "...",
    "balance_after": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "...",
    "id": "...",
    "kind": "...",
    "reason": null,
    "reference_id": null,
    "reference_type": null,
    "source": "..."
  },
  "store_credit": {
    "balance": "...",
    "currency_code": "...",
    "customer_id": "...",
    "id": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Store Credit redeemed

EVENT store_credit/redeem App scope: read_customers Staff permission: customers:write

Fired when Store Credit is applied to an order.

Payload fields

Field	Type	Description
`store_credit.id`	`string`	Always present
`store_credit.customer_id`	`string`	Always present
`store_credit.currency_code`	`string`	Selectable in the Payload builder
`store_credit.balance`	`string`	Selectable in the Payload builder
`store_credit.updated_at`	`string`	Selectable in the Payload builder
`movement.id`	`string`	Always present
`movement.kind`	`string`	Selectable in the Payload builder
`movement.amount`	`string`	Selectable in the Payload builder
`movement.currency_code`	`string`	Selectable in the Payload builder
`movement.balance_after`	`string`	Selectable in the Payload builder
`movement.source`	`string`	Selectable in the Payload builder
`movement.reason`	`string`	Selectable in the Payload builder
`movement.reference_type`	`string`	Selectable in the Payload builder
`movement.reference_id`	`string`	Selectable in the Payload builder
`movement.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "movement": {
    "amount": "...",
    "balance_after": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "...",
    "id": "...",
    "kind": "...",
    "reason": null,
    "reference_id": null,
    "reference_type": null,
    "source": "..."
  },
  "store_credit": {
    "balance": "...",
    "currency_code": "...",
    "customer_id": "...",
    "id": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Store Credit redemption reversed

EVENT store_credit/redemption_reversed App scope: read_customers Staff permission: customers:write

Fired when a Store Credit redemption is returned because its order was not placed.

Payload fields

Field	Type	Description
`store_credit.id`	`string`	Always present
`store_credit.customer_id`	`string`	Always present
`store_credit.currency_code`	`string`	Selectable in the Payload builder
`store_credit.balance`	`string`	Selectable in the Payload builder
`store_credit.updated_at`	`string`	Selectable in the Payload builder
`movement.id`	`string`	Always present
`movement.kind`	`string`	Selectable in the Payload builder
`movement.amount`	`string`	Selectable in the Payload builder
`movement.currency_code`	`string`	Selectable in the Payload builder
`movement.balance_after`	`string`	Selectable in the Payload builder
`movement.source`	`string`	Selectable in the Payload builder
`movement.reason`	`string`	Selectable in the Payload builder
`movement.reference_type`	`string`	Selectable in the Payload builder
`movement.reference_id`	`string`	Selectable in the Payload builder
`movement.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "movement": {
    "amount": "...",
    "balance_after": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "...",
    "id": "...",
    "kind": "...",
    "reason": null,
    "reference_id": null,
    "reference_type": null,
    "source": "..."
  },
  "store_credit": {
    "balance": "...",
    "currency_code": "...",
    "customer_id": "...",
    "id": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Store Credit refunded

EVENT store_credit/refund App scope: read_customers Staff permission: customers:write

Fired when an order refund is issued as Store Credit.

Payload fields

Field	Type	Description
`store_credit.id`	`string`	Always present
`store_credit.customer_id`	`string`	Always present
`store_credit.currency_code`	`string`	Selectable in the Payload builder
`store_credit.balance`	`string`	Selectable in the Payload builder
`store_credit.updated_at`	`string`	Selectable in the Payload builder
`movement.id`	`string`	Always present
`movement.kind`	`string`	Selectable in the Payload builder
`movement.amount`	`string`	Selectable in the Payload builder
`movement.currency_code`	`string`	Selectable in the Payload builder
`movement.balance_after`	`string`	Selectable in the Payload builder
`movement.source`	`string`	Selectable in the Payload builder
`movement.reason`	`string`	Selectable in the Payload builder
`movement.reference_type`	`string`	Selectable in the Payload builder
`movement.reference_id`	`string`	Selectable in the Payload builder
`movement.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "movement": {
    "amount": "...",
    "balance_after": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "...",
    "id": "...",
    "kind": "...",
    "reason": null,
    "reference_id": null,
    "reference_type": null,
    "source": "..."
  },
  "store_credit": {
    "balance": "...",
    "currency_code": "...",
    "customer_id": "...",
    "id": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Store Credit deducted

EVENT store_credit/revoke App scope: read_customers Staff permission: customers:write

Fired when Store Credit is deducted from a customer, including when a deleted customer's balance is removed.

Payload fields

Field	Type	Description
`store_credit.id`	`string`	Always present
`store_credit.customer_id`	`string`	Always present
`store_credit.currency_code`	`string`	Selectable in the Payload builder
`store_credit.balance`	`string`	Selectable in the Payload builder
`store_credit.updated_at`	`string`	Selectable in the Payload builder
`movement.id`	`string`	Always present
`movement.kind`	`string`	Selectable in the Payload builder
`movement.amount`	`string`	Selectable in the Payload builder
`movement.currency_code`	`string`	Selectable in the Payload builder
`movement.balance_after`	`string`	Selectable in the Payload builder
`movement.source`	`string`	Selectable in the Payload builder
`movement.reason`	`string`	Selectable in the Payload builder
`movement.reference_type`	`string`	Selectable in the Payload builder
`movement.reference_id`	`string`	Selectable in the Payload builder
`movement.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "movement": {
    "amount": "...",
    "balance_after": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "...",
    "id": "...",
    "kind": "...",
    "reason": null,
    "reference_id": null,
    "reference_type": null,
    "source": "..."
  },
  "store_credit": {
    "balance": "...",
    "currency_code": "...",
    "customer_id": "...",
    "id": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Text marketing consent changed

EVENT text_marketing_consents/update App scope: read_customers Staff permission: customers:read

Fired when a phone number gives or withdraws SMS or WhatsApp marketing consent — at checkout, in the admin, through the API or with the opt-out link in a marketing text.

Payload fields

Field	Type	Description
`consent.id`	`string`	Always present
`consent.phone`	`string`	Always present
`consent.channel`	`string`	Always present
`consent.customer_id`	`string`	Selectable in the Payload builder
`consent.status`	`string`	Always present
`consent.source`	`string`	Always present
`consent.updated_at`	`string`	Always present

Payload shape

Sample payload

{
  "consent": {
    "channel": "...",
    "customer_id": "...",
    "id": "...",
    "phone": "...",
    "source": "...",
    "status": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Domain added

EVENT domains/create App scope: read_domains Staff permission: settings.domains:read

Fired when a custom domain is added to the store. New domains start pending until their DNS is verified.

Payload fields

Field	Type	Description
`domain.id`	`string`	Always present
`domain.domain`	`string`	Selectable in the Payload builder
`domain.status`	`string`	Selectable in the Payload builder
`domain.connection_status`	`string`	Selectable in the Payload builder
`domain.dns_management`	`string`	Selectable in the Payload builder
`domain.storefront_id`	`string`	Selectable in the Payload builder
`domain.is_primary`	`boolean`	Selectable in the Payload builder
`domain.role`	`string`	Selectable in the Payload builder
`domain.default_country`	`string`	Selectable in the Payload builder
`domain.default_locale`	`string`	Selectable in the Payload builder
`domain.verified_at`	`string`	Selectable in the Payload builder
`domain.unverified_expires_at`	`string`	Selectable in the Payload builder
`domain.created_at`	`string`	Selectable in the Payload builder
`domain.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "domain": "shop.example.com"
}

Domain removed

EVENT domains/delete App scope: read_domains Staff permission: settings.domains:read

Fired when a custom domain is removed — by a member, after staying unverified for 7 days, or when its owner claims it from this store.

Payload fields

Field	Type	Description
`domain.id`	`string`	Always present
`domain.domain`	`string`	Selectable in the Payload builder
`domain.reason`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "domain": "shop.example.com"
}

Domain updated

EVENT domains/update App scope: read_domains Staff permission: settings.domains:read

Fired when a custom domain changes: verified, failed or disabled, assigned to or removed from a storefront, made primary, or pinned to a country. The payload carries the domain as it is now.

Payload fields

Field	Type	Description
`domain.id`	`string`	Always present
`domain.domain`	`string`	Selectable in the Payload builder
`domain.status`	`string`	Selectable in the Payload builder
`domain.connection_status`	`string`	Selectable in the Payload builder
`domain.dns_management`	`string`	Selectable in the Payload builder
`domain.storefront_id`	`string`	Selectable in the Payload builder
`domain.is_primary`	`boolean`	Selectable in the Payload builder
`domain.role`	`string`	Selectable in the Payload builder
`domain.default_country`	`string`	Selectable in the Payload builder
`domain.default_locale`	`string`	Selectable in the Payload builder
`domain.verified_at`	`string`	Selectable in the Payload builder
`domain.unverified_expires_at`	`string`	Selectable in the Payload builder
`domain.created_at`	`string`	Selectable in the Payload builder
`domain.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "domain": "shop.example.com"
}

Sending domain updated

EVENT email_domains/update App scope: read_email_settings Staff permission: settings.email:read

Fired when a sending domain becomes verified or can no longer send email.

Payload fields

Field	Type	Description
`email_domain.id`	`string`	Always present
`email_domain.domain`	`string`	Selectable in the Payload builder
`email_domain.status`	`string`	Selectable in the Payload builder
`email_domain.sending_ready`	`boolean`	Selectable in the Payload builder
`email_domain.reason`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "email_domain": {
    "domain": "mail.example.com",
    "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
    "reason": "...",
    "sending_ready": true,
    "status": "verified"
  }
}

Email bounced

EVENT emails/bounced App scope: read_email_settings Staff permission: settings.email:read

Fired when an email the store sent bounces. A permanent bounce stops further emails to that address until the merchant lifts it.

Payload fields

Field	Type	Description
`email.id`	`string`	Always present
`email.type`	`string`	Selectable in the Payload builder
`email.recipient_email`	`string`	Selectable in the Payload builder
`email.order_id`	`string`	Selectable in the Payload builder
`email.bounce_type`	`string`	Selectable in the Payload builder
`email.suppressed`	`boolean`	Selectable in the Payload builder
`email.occurred_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "email": {
    "bounce_type": "permanent",
    "id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e",
    "occurred_at": "2026-09-30T10:00:00+05:30",
    "order_id": null,
    "recipient_email": "customer@example.net",
    "suppressed": true,
    "type": "transactional"
  }
}

Email marked as spam

EVENT emails/complained App scope: read_email_settings Staff permission: settings.email:read

Fired when a recipient marks an email the store sent as spam. Further emails to that address stop.

Payload fields

Field	Type	Description
`email.id`	`string`	Always present
`email.type`	`string`	Selectable in the Payload builder
`email.recipient_email`	`string`	Selectable in the Payload builder
`email.order_id`	`string`	Selectable in the Payload builder
`email.bounce_type`	`string`	Selectable in the Payload builder
`email.suppressed`	`boolean`	Selectable in the Payload builder
`email.occurred_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "email": {
    "bounce_type": "...",
    "id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e",
    "occurred_at": "2026-09-30T10:00:00+05:30",
    "order_id": null,
    "recipient_email": "customer@example.net",
    "suppressed": true,
    "type": "transactional"
  }
}

File created

EVENT files/create App scope: read_files Staff permission: files:read

Payload fields

Field	Type	Description
`file.id`	`string`	Always present The stable file id.
`file.type`	`string`	Always present The file namespace: upload or site_asset.
`file.media_type`	`string`	Always present The detected media class: image, video, document, or 3d.
`file.filename`	`string`	Always present The file name assigned when the file was created; use original_filename for its editable display name.
`file.original_filename`	`string`	Always present The merchant-facing filename.
`file.size_bytes`	`integer`	Always present The validated source size in bytes.
`file.mime_type`	`string`	Always present The MIME type detected from the source bytes.
`file.width`	`integer`	Selectable in the Payload builder The source width in pixels when applicable.
`file.height`	`integer`	Selectable in the Payload builder The source height in pixels when applicable.
`file.alt_text`	`string`	Selectable in the Payload builder The file's accessibility description.
`file.revision`	`integer`	Always present The current source revision.
`file.preview_status`	`string`	Always present Preview lifecycle state: none, pending, ready, or failed.
`file.preview_error_code`	`string`	Selectable in the Payload builder `STORAGE_PREVIEW_FAILED` when preview_status is failed; absent otherwise.
`file.preview_revision`	`integer`	Always present The source revision represented by the current preview; zero means no preview.
`file.preview_requested_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when preview work was most recently requested.
`file.preview_completed_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when the current preview became ready.
`file.created_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when the file became ready.
`file.updated_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when file metadata or preview state last changed.

Payload shape

Sample payload

{
  "file": {
    "alt_text": "Trail shoe in black",
    "created_at": "2026-06-09T12:00:00+05:30",
    "filename": "8f2a1c2b-9d4e-4a56-b789-0123456789ab.glb",
    "height": null,
    "id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "media_type": "3d",
    "mime_type": "model/gltf-binary",
    "original_filename": "trail-shoe.glb",
    "preview_completed_at": null,
    "preview_error_code": null,
    "preview_requested_at": null,
    "preview_revision": 0,
    "preview_status": "none",
    "revision": 1,
    "size_bytes": 8421934,
    "type": "upload",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "width": null
  }
}

File deleted

EVENT files/delete App scope: read_files Staff permission: files:read

Payload fields

Field	Type	Description
`file.id`	`string`	Always present The stable file id.
`file.type`	`string`	Always present The file namespace: upload or site_asset.
`file.media_type`	`string`	Always present The detected media class: image, video, document, or 3d.
`file.filename`	`string`	Always present The file name assigned when the file was created; use original_filename for its editable display name.
`file.original_filename`	`string`	Always present The merchant-facing filename.
`file.size_bytes`	`integer`	Always present The validated source size in bytes.
`file.mime_type`	`string`	Always present The MIME type detected from the source bytes.
`file.width`	`integer`	Selectable in the Payload builder The source width in pixels when applicable.
`file.height`	`integer`	Selectable in the Payload builder The source height in pixels when applicable.
`file.alt_text`	`string`	Selectable in the Payload builder The file's accessibility description.
`file.revision`	`integer`	Always present The current source revision.
`file.preview_status`	`string`	Always present Preview lifecycle state: none, pending, ready, or failed.
`file.preview_error_code`	`string`	Selectable in the Payload builder `STORAGE_PREVIEW_FAILED` when preview_status is failed; absent otherwise.
`file.preview_revision`	`integer`	Always present The source revision represented by the current preview; zero means no preview.
`file.preview_requested_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when preview work was most recently requested.
`file.preview_completed_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when the current preview became ready.
`file.created_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when the file became ready.
`file.updated_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when file metadata or preview state last changed.
`deleted_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when the file was deleted.

Payload shape

Sample payload

{
  "deleted_at": "2026-06-10T09:30:00+05:30",
  "file": {
    "alt_text": "Trail shoe in black",
    "created_at": "2026-06-09T12:00:00+05:30",
    "filename": "8f2a1c2b-9d4e-4a56-b789-0123456789ab.glb",
    "height": null,
    "id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "media_type": "3d",
    "mime_type": "model/gltf-binary",
    "original_filename": "trail-shoe.glb",
    "preview_completed_at": "2026-06-09T12:01:10+05:30",
    "preview_error_code": null,
    "preview_requested_at": "2026-06-09T12:00:02+05:30",
    "preview_revision": 1,
    "preview_status": "ready",
    "revision": 1,
    "size_bytes": 8421934,
    "type": "upload",
    "updated_at": "2026-06-09T12:01:10+05:30",
    "width": null
  }
}

File updated

EVENT files/update App scope: read_files Staff permission: files:read

Payload fields

Field	Type	Description
`file.id`	`string`	Always present The stable file id.
`file.type`	`string`	Always present The file namespace: upload or site_asset.
`file.media_type`	`string`	Always present The detected media class: image, video, document, or 3d.
`file.filename`	`string`	Always present The file name assigned when the file was created; use original_filename for its editable display name.
`file.original_filename`	`string`	Always present The merchant-facing filename.
`file.size_bytes`	`integer`	Always present The validated source size in bytes.
`file.mime_type`	`string`	Always present The MIME type detected from the source bytes.
`file.width`	`integer`	Selectable in the Payload builder The source width in pixels when applicable.
`file.height`	`integer`	Selectable in the Payload builder The source height in pixels when applicable.
`file.alt_text`	`string`	Selectable in the Payload builder The file's accessibility description.
`file.revision`	`integer`	Always present The current source revision.
`file.preview_status`	`string`	Always present Preview lifecycle state: none, pending, ready, or failed.
`file.preview_error_code`	`string`	Selectable in the Payload builder `STORAGE_PREVIEW_FAILED` when preview_status is failed; absent otherwise.
`file.preview_revision`	`integer`	Always present The source revision represented by the current preview; zero means no preview.
`file.preview_requested_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when preview work was most recently requested.
`file.preview_completed_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when the current preview became ready.
`file.created_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when the file became ready.
`file.updated_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when file metadata or preview state last changed.
`changed_fields`	`array`	Always present The file fields changed by this event.

Payload shape

Sample payload

{
  "changed_fields": [
    "preview_status",
    "preview_revision",
    "preview_completed_at"
  ],
  "file": {
    "alt_text": "Trail shoe in black",
    "created_at": "2026-06-09T12:00:00+05:30",
    "filename": "8f2a1c2b-9d4e-4a56-b789-0123456789ab.glb",
    "height": null,
    "id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "media_type": "3d",
    "mime_type": "model/gltf-binary",
    "original_filename": "trail-shoe.glb",
    "preview_completed_at": "2026-06-09T12:01:10+05:30",
    "preview_error_code": null,
    "preview_requested_at": "2026-06-09T12:00:02+05:30",
    "preview_revision": 1,
    "preview_status": "ready",
    "revision": 1,
    "size_bytes": 8421934,
    "type": "upload",
    "updated_at": "2026-06-09T12:01:10+05:30",
    "width": null
  }
}

Gift Card cancelled

EVENT gift_cards/cancel App scope: read_gift_cards Staff permission: gift_cards:write

Fired when a Gift Card is cancelled.

Payload fields

Field	Type	Description
`gift_card.id`	`string`	Always present
`gift_card.code_last4`	`string`	Selectable in the Payload builder
`gift_card.currency_code`	`string`	Selectable in the Payload builder
`gift_card.initial_amount`	`string`	Selectable in the Payload builder
`gift_card.balance`	`string`	Selectable in the Payload builder
`gift_card.status`	`string`	Selectable in the Payload builder
`gift_card.source`	`string`	Selectable in the Payload builder
`gift_card.source_order_id`	`string`	Selectable in the Payload builder
`gift_card.recipient_email`	`string`	Selectable in the Payload builder
`gift_card.issued_at`	`string`	Selectable in the Payload builder
`gift_card.activated_at`	`string`	Selectable in the Payload builder
`gift_card.expires_at`	`string`	Selectable in the Payload builder
`gift_card.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "gift_card": {
    "activated_at": null,
    "balance": "...",
    "code_last4": "...",
    "currency_code": "...",
    "expires_at": null,
    "id": "...",
    "initial_amount": "...",
    "issued_at": "...",
    "recipient_email": null,
    "source": "...",
    "source_order_id": null,
    "status": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Gift Card issued

EVENT gift_cards/create App scope: read_gift_cards Staff permission: gift_cards:write

Fired when a Gift Card is issued.

Payload fields

Field	Type	Description
`gift_card.id`	`string`	Always present
`gift_card.code_last4`	`string`	Selectable in the Payload builder
`gift_card.currency_code`	`string`	Selectable in the Payload builder
`gift_card.initial_amount`	`string`	Selectable in the Payload builder
`gift_card.balance`	`string`	Selectable in the Payload builder
`gift_card.status`	`string`	Selectable in the Payload builder
`gift_card.source`	`string`	Selectable in the Payload builder
`gift_card.source_order_id`	`string`	Selectable in the Payload builder
`gift_card.recipient_email`	`string`	Selectable in the Payload builder
`gift_card.issued_at`	`string`	Selectable in the Payload builder
`gift_card.activated_at`	`string`	Selectable in the Payload builder
`gift_card.expires_at`	`string`	Selectable in the Payload builder
`gift_card.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "gift_card": {
    "activated_at": null,
    "balance": "...",
    "code_last4": "...",
    "currency_code": "...",
    "expires_at": null,
    "id": "...",
    "initial_amount": "...",
    "issued_at": "...",
    "recipient_email": null,
    "source": "...",
    "source_order_id": null,
    "status": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Gift Card expired

EVENT gift_cards/expire App scope: read_gift_cards Staff permission: gift_cards:write

Fired when a Gift Card expires with its final balance snapshot.

Payload fields

Field	Type	Description
`gift_card.id`	`string`	Always present
`gift_card.code_last4`	`string`	Selectable in the Payload builder
`gift_card.currency_code`	`string`	Selectable in the Payload builder
`gift_card.initial_amount`	`string`	Selectable in the Payload builder
`gift_card.balance`	`string`	Selectable in the Payload builder
`gift_card.status`	`string`	Selectable in the Payload builder
`gift_card.source`	`string`	Selectable in the Payload builder
`gift_card.source_order_id`	`string`	Selectable in the Payload builder
`gift_card.recipient_email`	`string`	Selectable in the Payload builder
`gift_card.issued_at`	`string`	Selectable in the Payload builder
`gift_card.activated_at`	`string`	Selectable in the Payload builder
`gift_card.expires_at`	`string`	Selectable in the Payload builder
`gift_card.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "gift_card": {
    "activated_at": null,
    "balance": "...",
    "code_last4": "...",
    "currency_code": "...",
    "expires_at": null,
    "id": "...",
    "initial_amount": "...",
    "issued_at": "...",
    "recipient_email": null,
    "source": "...",
    "source_order_id": null,
    "status": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Gift Card redeemed

EVENT gift_cards/redeem App scope: read_gift_cards Staff permission: gift_cards:write

Fired when Gift Card value settles against an order.

Payload fields

Field	Type	Description
`gift_card.id`	`string`	Always present
`gift_card.code_last4`	`string`	Selectable in the Payload builder
`gift_card.currency_code`	`string`	Selectable in the Payload builder
`gift_card.initial_amount`	`string`	Selectable in the Payload builder
`gift_card.balance`	`string`	Selectable in the Payload builder
`gift_card.status`	`string`	Selectable in the Payload builder
`gift_card.source`	`string`	Selectable in the Payload builder
`gift_card.source_order_id`	`string`	Selectable in the Payload builder
`gift_card.recipient_email`	`string`	Selectable in the Payload builder
`gift_card.issued_at`	`string`	Selectable in the Payload builder
`gift_card.activated_at`	`string`	Selectable in the Payload builder
`gift_card.expires_at`	`string`	Selectable in the Payload builder
`gift_card.updated_at`	`string`	Selectable in the Payload builder
`movement.id`	`string`	Always present
`movement.gift_card_id`	`string`	Selectable in the Payload builder
`movement.kind`	`string`	Selectable in the Payload builder
`movement.amount`	`string`	Selectable in the Payload builder
`movement.currency_code`	`string`	Selectable in the Payload builder
`movement.balance_after`	`string`	Selectable in the Payload builder
`movement.order_id`	`string`	Selectable in the Payload builder
`movement.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "gift_card": {
    "activated_at": null,
    "balance": "...",
    "code_last4": "...",
    "currency_code": "...",
    "expires_at": null,
    "id": "...",
    "initial_amount": "...",
    "issued_at": "...",
    "recipient_email": null,
    "source": "...",
    "source_order_id": null,
    "status": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "movement": {
    "amount": "...",
    "balance_after": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "...",
    "gift_card_id": "...",
    "id": "...",
    "kind": "...",
    "order_id": null
  }
}

Gift Card redemption reversed

EVENT gift_cards/redemption_reversed App scope: read_gift_cards Staff permission: gift_cards:write

Fired when a Gift Card redemption is reversed.

Payload fields

Field	Type	Description
`gift_card.id`	`string`	Always present
`gift_card.code_last4`	`string`	Selectable in the Payload builder
`gift_card.currency_code`	`string`	Selectable in the Payload builder
`gift_card.initial_amount`	`string`	Selectable in the Payload builder
`gift_card.balance`	`string`	Selectable in the Payload builder
`gift_card.status`	`string`	Selectable in the Payload builder
`gift_card.source`	`string`	Selectable in the Payload builder
`gift_card.source_order_id`	`string`	Selectable in the Payload builder
`gift_card.recipient_email`	`string`	Selectable in the Payload builder
`gift_card.issued_at`	`string`	Selectable in the Payload builder
`gift_card.activated_at`	`string`	Selectable in the Payload builder
`gift_card.expires_at`	`string`	Selectable in the Payload builder
`gift_card.updated_at`	`string`	Selectable in the Payload builder
`movement.id`	`string`	Always present
`movement.gift_card_id`	`string`	Selectable in the Payload builder
`movement.kind`	`string`	Selectable in the Payload builder
`movement.amount`	`string`	Selectable in the Payload builder
`movement.currency_code`	`string`	Selectable in the Payload builder
`movement.balance_after`	`string`	Selectable in the Payload builder
`movement.order_id`	`string`	Selectable in the Payload builder
`movement.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "gift_card": {
    "activated_at": null,
    "balance": "...",
    "code_last4": "...",
    "currency_code": "...",
    "expires_at": null,
    "id": "...",
    "initial_amount": "...",
    "issued_at": "...",
    "recipient_email": null,
    "source": "...",
    "source_order_id": null,
    "status": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "movement": {
    "amount": "...",
    "balance_after": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "...",
    "gift_card_id": "...",
    "id": "...",
    "kind": "...",
    "order_id": null
  }
}

Gift Card refunded

EVENT gift_cards/refund App scope: read_gift_cards Staff permission: gift_cards:write

Fired when value is returned to a Gift Card.

Payload fields

Field	Type	Description
`gift_card.id`	`string`	Always present
`gift_card.code_last4`	`string`	Selectable in the Payload builder
`gift_card.currency_code`	`string`	Selectable in the Payload builder
`gift_card.initial_amount`	`string`	Selectable in the Payload builder
`gift_card.balance`	`string`	Selectable in the Payload builder
`gift_card.status`	`string`	Selectable in the Payload builder
`gift_card.source`	`string`	Selectable in the Payload builder
`gift_card.source_order_id`	`string`	Selectable in the Payload builder
`gift_card.recipient_email`	`string`	Selectable in the Payload builder
`gift_card.issued_at`	`string`	Selectable in the Payload builder
`gift_card.activated_at`	`string`	Selectable in the Payload builder
`gift_card.expires_at`	`string`	Selectable in the Payload builder
`gift_card.updated_at`	`string`	Selectable in the Payload builder
`movement.id`	`string`	Always present
`movement.gift_card_id`	`string`	Selectable in the Payload builder
`movement.kind`	`string`	Selectable in the Payload builder
`movement.amount`	`string`	Selectable in the Payload builder
`movement.currency_code`	`string`	Selectable in the Payload builder
`movement.balance_after`	`string`	Selectable in the Payload builder
`movement.order_id`	`string`	Selectable in the Payload builder
`movement.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "gift_card": {
    "activated_at": null,
    "balance": "...",
    "code_last4": "...",
    "currency_code": "...",
    "expires_at": null,
    "id": "...",
    "initial_amount": "...",
    "issued_at": "...",
    "recipient_email": null,
    "source": "...",
    "source_order_id": null,
    "status": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "movement": {
    "amount": "...",
    "balance_after": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "...",
    "gift_card_id": "...",
    "id": "...",
    "kind": "...",
    "order_id": null
  }
}

Gift Card updated

EVENT gift_cards/update App scope: read_gift_cards Staff permission: gift_cards:write

Fired when a Gift Card's status, recipient, delivery, or expiry state changes.

Payload fields

Field	Type	Description
`gift_card.id`	`string`	Always present
`gift_card.code_last4`	`string`	Selectable in the Payload builder
`gift_card.currency_code`	`string`	Selectable in the Payload builder
`gift_card.initial_amount`	`string`	Selectable in the Payload builder
`gift_card.balance`	`string`	Selectable in the Payload builder
`gift_card.status`	`string`	Selectable in the Payload builder
`gift_card.source`	`string`	Selectable in the Payload builder
`gift_card.source_order_id`	`string`	Selectable in the Payload builder
`gift_card.recipient_email`	`string`	Selectable in the Payload builder
`gift_card.issued_at`	`string`	Selectable in the Payload builder
`gift_card.activated_at`	`string`	Selectable in the Payload builder
`gift_card.expires_at`	`string`	Selectable in the Payload builder
`gift_card.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "gift_card": {
    "activated_at": null,
    "balance": "...",
    "code_last4": "...",
    "currency_code": "...",
    "expires_at": null,
    "id": "...",
    "initial_amount": "...",
    "issued_at": "...",
    "recipient_email": null,
    "source": "...",
    "source_order_id": null,
    "status": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Low stock alert

EVENT inventory/low_stock App scope: read_inventory Staff permission: inventory:write

Fired when available inventory reaches or falls below the low stock threshold, for one location or across all locations. While the item stays low the alert repeats only after the alert cooldown; after available rises above the threshold, the next drop alerts again at once.

Payload fields

Field	Type	Description
`item_type`	`string`	Selectable in the Payload builder `simple` (a simple product), `variant` or `group` (an inventory group). inventory_levels/update names the same items `product`, `variant` and `inventory_group`.
`scope`	`string`	Selectable in the Payload builder `location` for one location's threshold, or `overall` for the item's overall threshold across all locations.
`group_id`	`string`	Selectable in the Payload builder The inventory group, for group alerts.
`group_name`	`string`	Selectable in the Payload builder The inventory group's name, for group alerts.
`product_id`	`integer`	Selectable in the Payload builder The product, or the variant's parent product.
`variant_id`	`integer`	Selectable in the Payload builder The variant, for variant alerts.
`product_title`	`string`	Selectable in the Payload builder The product title.
`variant_sku`	`string`	Selectable in the Payload builder The variant's SKU, for variant alerts.
`variant_title`	`string`	Selectable in the Payload builder The variant title, for variant alerts.
`location_id`	`string`	Selectable in the Payload builder The location, for location alerts.
`location_name`	`string`	Selectable in the Payload builder The location's name, for location alerts.
`available`	`integer`	Selectable in the Payload builder Available units (on hand minus held) when the alert fired. The alert fires when this is at or below threshold.
`threshold`	`integer`	Selectable in the Payload builder The threshold that was reached. While the item stays at or below it, the alert repeats only after the alert cooldown; after available rises above it, the next drop alerts again at once.

Payload shape

Sample payload

{
  "available": 4,
  "item_type": "variant",
  "location_id": "af720cef-7f1b-40f4-a5f8-8a55ea5b0d84",
  "location_name": "Main warehouse",
  "product_id": 42,
  "product_title": "Classic Tee",
  "scope": "location",
  "threshold": 5,
  "variant_id": 1007,
  "variant_sku": "TEE-BLK-M",
  "variant_title": "Black / M"
}

Inventory group created

EVENT inventory_groups/create App scope: read_inventory Staff permission: inventory:write

Fired when an inventory group is created.

Payload fields

Field	Type	Description
`resource_type`	`string`	Always present
`resource_id`	`string`	Always present
`occurred_at`	`string`	Always present
`previous.id`	`string`	Always present
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.sku`	`string`	Selectable in the Payload builder
`previous.description`	`string`	Selectable in the Payload builder
`previous.quantity`	`integer`	Selectable in the Payload builder
`previous.reserved`	`integer`	Selectable in the Payload builder
`previous.checkout_held`	`integer`	Selectable in the Payload builder
`previous.order_committed`	`integer`	Selectable in the Payload builder
`previous.other_held`	`integer`	Selectable in the Payload builder
`previous.low_stock_threshold`	`integer`	Selectable in the Payload builder
`previous.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`current.id`	`string`	Always present
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.sku`	`string`	Selectable in the Payload builder
`current.description`	`string`	Selectable in the Payload builder
`current.quantity`	`integer`	Selectable in the Payload builder
`current.reserved`	`integer`	Selectable in the Payload builder
`current.checkout_held`	`integer`	Selectable in the Payload builder
`current.order_committed`	`integer`	Selectable in the Payload builder
`current.other_held`	`integer`	Selectable in the Payload builder
`current.low_stock_threshold`	`integer`	Selectable in the Payload builder
`current.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": null,
  "current": {
    "checkout_held": 2,
    "description": "Shared stock pool for tee variants.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "low_stock_threshold": 20,
    "name": "Tee Fabric Pool",
    "order_committed": 7,
    "other_held": 3,
    "overall_low_stock_threshold": 20,
    "quantity": 340,
    "reserved": 12,
    "sku": "POOL-TEE",
    "slug": "tee-fabric-pool",
    "store_id": "74e634ea-84ec-43b8-b66b-986214c2c5a3"
  },
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous": null,
  "resource_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
  "resource_type": "inventory_group"
}

Inventory group deleted

EVENT inventory_groups/delete App scope: read_inventory Staff permission: inventory:write

Fired when an inventory group is deleted.

Payload fields

Field	Type	Description
`resource_type`	`string`	Always present
`resource_id`	`string`	Always present
`occurred_at`	`string`	Always present
`previous.id`	`string`	Always present
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.sku`	`string`	Selectable in the Payload builder
`previous.description`	`string`	Selectable in the Payload builder
`previous.quantity`	`integer`	Selectable in the Payload builder
`previous.reserved`	`integer`	Selectable in the Payload builder
`previous.checkout_held`	`integer`	Selectable in the Payload builder
`previous.order_committed`	`integer`	Selectable in the Payload builder
`previous.other_held`	`integer`	Selectable in the Payload builder
`previous.low_stock_threshold`	`integer`	Selectable in the Payload builder
`previous.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`current.id`	`string`	Always present
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.sku`	`string`	Selectable in the Payload builder
`current.description`	`string`	Selectable in the Payload builder
`current.quantity`	`integer`	Selectable in the Payload builder
`current.reserved`	`integer`	Selectable in the Payload builder
`current.checkout_held`	`integer`	Selectable in the Payload builder
`current.order_committed`	`integer`	Selectable in the Payload builder
`current.other_held`	`integer`	Selectable in the Payload builder
`current.low_stock_threshold`	`integer`	Selectable in the Payload builder
`current.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": null,
  "current": null,
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous": {
    "checkout_held": 2,
    "description": "Shared stock pool for tee variants.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "low_stock_threshold": 20,
    "name": "Tee Fabric Pool",
    "order_committed": 7,
    "other_held": 3,
    "overall_low_stock_threshold": 20,
    "quantity": 340,
    "reserved": 12,
    "sku": "POOL-TEE",
    "slug": "tee-fabric-pool",
    "store_id": "74e634ea-84ec-43b8-b66b-986214c2c5a3"
  },
  "resource_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
  "resource_type": "inventory_group"
}

Inventory group updated

EVENT inventory_groups/update App scope: read_inventory Staff permission: inventory:write

Fired when an inventory group's fields change, including the group-wide low-stock threshold that follows a per-location threshold change. Stock quantity changes fire the stock level event, not this one.

Payload fields

Field	Type	Description
`resource_type`	`string`	Always present
`resource_id`	`string`	Always present
`occurred_at`	`string`	Always present
`previous.id`	`string`	Always present
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.sku`	`string`	Selectable in the Payload builder
`previous.description`	`string`	Selectable in the Payload builder
`previous.quantity`	`integer`	Selectable in the Payload builder
`previous.reserved`	`integer`	Selectable in the Payload builder
`previous.checkout_held`	`integer`	Selectable in the Payload builder
`previous.order_committed`	`integer`	Selectable in the Payload builder
`previous.other_held`	`integer`	Selectable in the Payload builder
`previous.low_stock_threshold`	`integer`	Selectable in the Payload builder
`previous.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`current.id`	`string`	Always present
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.sku`	`string`	Selectable in the Payload builder
`current.description`	`string`	Selectable in the Payload builder
`current.quantity`	`integer`	Selectable in the Payload builder
`current.reserved`	`integer`	Selectable in the Payload builder
`current.checkout_held`	`integer`	Selectable in the Payload builder
`current.order_committed`	`integer`	Selectable in the Payload builder
`current.other_held`	`integer`	Selectable in the Payload builder
`current.low_stock_threshold`	`integer`	Selectable in the Payload builder
`current.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "name",
    "description"
  ],
  "current": {
    "checkout_held": 2,
    "description": "Shared stock pool for tee variants.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "low_stock_threshold": 20,
    "name": "Tee Fabric Pool",
    "order_committed": 7,
    "other_held": 3,
    "overall_low_stock_threshold": 20,
    "quantity": 340,
    "reserved": 12,
    "sku": "POOL-TEE",
    "slug": "tee-fabric-pool",
    "store_id": "74e634ea-84ec-43b8-b66b-986214c2c5a3"
  },
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous": {
    "checkout_held": 2,
    "description": "Shared stock pool for tee variants.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "low_stock_threshold": 20,
    "name": "Tee Fabric Pool",
    "order_committed": 7,
    "other_held": 3,
    "overall_low_stock_threshold": 20,
    "quantity": 340,
    "reserved": 12,
    "sku": "POOL-TEE",
    "slug": "tee-fabric-pool",
    "store_id": "74e634ea-84ec-43b8-b66b-986214c2c5a3"
  },
  "resource_id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
  "resource_type": "inventory_group"
}

Stock level changed

EVENT inventory_levels/update App scope: read_inventory Staff permission: inventory:read

Fired when stock at a location changes — one event per affected item and location (product, variant or inventory group), carrying the new on-hand quantity, the held amounts, available, the quantity change and the reason. change is 0 when only held amounts move.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

checkout_held low_stock_threshold order_committed other_held quantity reserved

Payload fields

Field	Type	Description
`item_type`	`string`	Always present `product` (a simple product), `variant` or `inventory_group`. inventory/low_stock names the same items `simple`, `variant` and `group`.
`product_id`	`integer`	Selectable in the Payload builder The product, for product events, and the variant's parent product, for variant events.
`variant_id`	`integer`	Selectable in the Payload builder The variant, for variant events.
`group_id`	`string`	Selectable in the Payload builder The inventory group, for inventory_group events.
`sku`	`string`	Selectable in the Payload builder The inventory group's SKU on group stock edits and transfers, and the product's or variant's SKU on transfer events. Omitted on order-driven events and on other product and variant events; identify the item by product_id, variant_id or group_id.
`location_id`	`string`	Selectable in the Payload builder The location whose stock changed. One event is sent per affected item and location.
`quantity`	`integer`	Selectable in the Payload builder On-hand units at the location after the change.
`reserved`	`integer`	Selectable in the Payload builder All held units: checkout_held + order_committed + other_held.
`checkout_held`	`integer`	Selectable in the Payload builder Units held for checkouts waiting for an online payment.
`order_committed`	`integer`	Selectable in the Payload builder Units committed to placed orders that have not shipped.
`other_held`	`integer`	Selectable in the Payload builder Units set aside for stock transfers (In transfers in Store Admin).
`available`	`integer`	Selectable in the Payload builder quantity - reserved: the units that can still be sold at this location. Never below zero.
`low_stock_threshold`	`integer`	Selectable in the Payload builder The location's low-stock threshold, or null when none is set.
`change`	`integer`	Selectable in the Payload builder The change in on-hand quantity. 0 when only held amounts or the threshold changed.
`reason`	`string`	Selectable in the Payload builder Why the level changed. Stock edits by staff, apps, the Store API and stock CSV imports: `received`, `returned`, `damaged`, `shrinkage`, `recount` or `correction`; `initial` (first stock entered when a product, variant or group location is created), `set_quantity` (stock saved with a product or variant), `threshold_updated` (a group location's threshold changed) or `location_removed` (an empty group location was removed). Orders: `order_reserved` (an order or an order edit took stock), `payment_captured` (a checkout hold became committed, or a released hold was taken again after a late payment), `payment_retry` (a retried payment took stock again), `provider_init_failed`, `payment_failed` or `checkout_hold_expired` (a checkout hold was released), `order_released` (an order was cancelled or removed), `order_edited` (an edit or a refund released units), `order_edit_abandoned` (a discarded edit released units), `sold` (a fulfillment shipped units, or items that don't need shipping were sold when committed) or `returned` (units went back on hand: a restock, a cancelled fulfillment, or an undone order or edit). Transfers: `transfer_reserved` (a transfer was shipped and its units set aside at the source), `transferred` (units were received or a transfer completed), `transfer_damaged` (units received damaged), `transfer_short` (units reported short) or `transfer_released` (an in-transit transfer was cancelled).
`changed_fields`	`array`	Selectable in the Payload builder Which values changed: any of `quantity`, `reserved`, `checkout_held`, `order_committed`, `other_held` and `low_stock_threshold`.
`occurred_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when the change happened.

Payload shape

Sample payload

{
  "available": 32,
  "change": -2,
  "changed_fields": [
    "quantity",
    "reserved",
    "order_committed"
  ],
  "checkout_held": 1,
  "item_type": "variant",
  "location_id": "af720cef-7f1b-40f4-a5f8-8a55ea5b0d84",
  "low_stock_threshold": 10,
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "order_committed": 4,
  "other_held": 1,
  "product_id": 42,
  "quantity": 38,
  "reason": "sold",
  "reserved": 6,
  "variant_id": 1007
}

Transfer created

EVENT transfers/create App scope: read_inventory Staff permission: inventory:write

Fired when a stock transfer is created (status pending).

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`store_seq_id`	`integer`	Selectable in the Payload builder
`transfer_number`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`status`	`string`	Selectable in the Payload builder
`previous_status`	`string`	Selectable in the Payload builder
`from_location_id`	`string`	Selectable in the Payload builder
`from_location_name`	`string`	Selectable in the Payload builder
`to_location_id`	`string`	Selectable in the Payload builder
`to_location_name`	`string`	Selectable in the Payload builder
`reference_number`	`string`	Selectable in the Payload builder
`item_count`	`integer`	Selectable in the Payload builder
`total_quantity`	`integer`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "from_location_id": null,
  "from_location_name": "...",
  "item_count": 0,
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous_status": "...",
  "reference_number": null,
  "resource_id": "...",
  "resource_type": "...",
  "status": "...",
  "store_seq_id": 0,
  "to_location_id": null,
  "to_location_name": "...",
  "total_quantity": 0,
  "transfer_number": "..."
}

Transfer deleted

EVENT transfers/delete App scope: read_inventory Staff permission: inventory:write

Fired when a Pending stock transfer document is deleted.

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`store_seq_id`	`integer`	Selectable in the Payload builder
`transfer_number`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`status`	`string`	Selectable in the Payload builder
`previous_status`	`string`	Selectable in the Payload builder
`from_location_id`	`string`	Selectable in the Payload builder
`from_location_name`	`string`	Selectable in the Payload builder
`to_location_id`	`string`	Selectable in the Payload builder
`to_location_name`	`string`	Selectable in the Payload builder
`reference_number`	`string`	Selectable in the Payload builder
`item_count`	`integer`	Selectable in the Payload builder
`total_quantity`	`integer`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "from_location_id": null,
  "from_location_name": "...",
  "item_count": 0,
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous_status": "...",
  "reference_number": null,
  "resource_id": "...",
  "resource_type": "...",
  "status": "...",
  "store_seq_id": 0,
  "to_location_id": null,
  "to_location_name": "...",
  "total_quantity": 0,
  "transfer_number": "..."
}

Transfer received

EVENT transfers/received App scope: read_inventory Staff permission: inventory:write

Fired for every receipt recorded against an in-transit transfer, with the received, short and damaged units per line. A receipt that accounts for every remaining unit also fires the transfer status event. Stock changes arrive separately as the stock level event.

Payload fields

Field	Type	Description
`TransfersEventPayload.resource_type`	`string`	Selectable in the Payload builder
`TransfersEventPayload.resource_id`	`string`	Selectable in the Payload builder
`TransfersEventPayload.store_seq_id`	`integer`	Selectable in the Payload builder
`TransfersEventPayload.transfer_number`	`string`	Selectable in the Payload builder
`TransfersEventPayload.occurred_at`	`string`	Selectable in the Payload builder
`TransfersEventPayload.status`	`string`	Selectable in the Payload builder
`TransfersEventPayload.previous_status`	`string`	Selectable in the Payload builder
`TransfersEventPayload.from_location_id`	`string`	Selectable in the Payload builder
`TransfersEventPayload.from_location_name`	`string`	Selectable in the Payload builder
`TransfersEventPayload.to_location_id`	`string`	Selectable in the Payload builder
`TransfersEventPayload.to_location_name`	`string`	Selectable in the Payload builder
`TransfersEventPayload.reference_number`	`string`	Selectable in the Payload builder
`TransfersEventPayload.item_count`	`integer`	Selectable in the Payload builder
`TransfersEventPayload.total_quantity`	`integer`	Selectable in the Payload builder
`receipt_id`	`string`	Selectable in the Payload builder
`receipt_number`	`integer`	Selectable in the Payload builder
`lines[*].transfer_item_id`	`string`	Selectable in the Payload builder
`lines[*].item_type`	`string`	Selectable in the Payload builder
`lines[*].product_id`	`integer`	Selectable in the Payload builder
`lines[*].variant_id`	`integer`	Selectable in the Payload builder
`lines[*].group_id`	`string`	Selectable in the Payload builder
`lines[*].sku`	`string`	Selectable in the Payload builder
`lines[*].received_quantity`	`integer`	Selectable in the Payload builder
`lines[*].short_quantity`	`integer`	Selectable in the Payload builder
`lines[*].damaged_quantity`	`integer`	Selectable in the Payload builder
`lines[*].remaining_quantity`	`integer`	Selectable in the Payload builder
`received_quantity_total`	`integer`	Selectable in the Payload builder
`short_quantity_total`	`integer`	Selectable in the Payload builder
`damaged_quantity_total`	`integer`	Selectable in the Payload builder
`remaining_quantity_total`	`integer`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "TransfersEventPayload": {
    "from_location_id": null,
    "from_location_name": "...",
    "item_count": 0,
    "occurred_at": "2026-06-09T12:00:00+05:30",
    "previous_status": "...",
    "reference_number": null,
    "resource_id": "...",
    "resource_type": "...",
    "status": "...",
    "store_seq_id": 0,
    "to_location_id": null,
    "to_location_name": "...",
    "total_quantity": 0,
    "transfer_number": "..."
  },
  "damaged_quantity_total": 0,
  "lines": [
    {
      "damaged_quantity": 0,
      "group_id": null,
      "item_type": "...",
      "product_id": null,
      "received_quantity": 0,
      "remaining_quantity": 0,
      "short_quantity": 0,
      "sku": "...",
      "transfer_item_id": "...",
      "variant_id": null
    }
  ],
  "receipt_id": "...",
  "receipt_number": 0,
  "received_quantity_total": 0,
  "remaining_quantity_total": 0,
  "short_quantity_total": 0
}

Transfer status changed

EVENT transfers/status_changed App scope: read_inventory Staff permission: inventory:write

Fired on every transfer status transition (pending → in_transit → completed / cancelled), carrying the previous and new status. Completion stock changes arrive separately as the stock level event.

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`store_seq_id`	`integer`	Selectable in the Payload builder
`transfer_number`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`status`	`string`	Selectable in the Payload builder
`previous_status`	`string`	Selectable in the Payload builder
`from_location_id`	`string`	Selectable in the Payload builder
`from_location_name`	`string`	Selectable in the Payload builder
`to_location_id`	`string`	Selectable in the Payload builder
`to_location_name`	`string`	Selectable in the Payload builder
`reference_number`	`string`	Selectable in the Payload builder
`item_count`	`integer`	Selectable in the Payload builder
`total_quantity`	`integer`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "from_location_id": null,
  "from_location_name": "...",
  "item_count": 0,
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous_status": "...",
  "reference_number": null,
  "resource_id": "...",
  "resource_type": "...",
  "status": "...",
  "store_seq_id": 0,
  "to_location_id": null,
  "to_location_name": "...",
  "total_quantity": 0,
  "transfer_number": "..."
}

Location activated

EVENT locations/activated App scope: read_locations Staff permission: locations:read

Fired when a location's is_active flips from false to true.

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`previous.id`	`string`	Selectable in the Payload builder
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.app_id`	`string`	Selectable in the Payload builder
`previous.is_app_managed`	`boolean`	Selectable in the Payload builder
`previous.is_primary`	`boolean`	Selectable in the Payload builder
`previous.is_active`	`boolean`	Selectable in the Payload builder
`previous.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`previous.fulfillment_priority`	`integer`	Selectable in the Payload builder
`previous.address_line1`	`string`	Selectable in the Payload builder
`previous.address_line2`	`string`	Selectable in the Payload builder
`previous.city`	`string`	Selectable in the Payload builder
`previous.state_province`	`string`	Selectable in the Payload builder
`previous.postal_code`	`string`	Selectable in the Payload builder
`previous.country_code`	`string`	Selectable in the Payload builder
`previous.phone`	`string`	Selectable in the Payload builder
`previous.is_archived`	`boolean`	Selectable in the Payload builder
`previous.previous_app_id`	`string`	Selectable in the Payload builder
`previous.previous_app_name`	`string`	Selectable in the Payload builder
`current.id`	`string`	Selectable in the Payload builder
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.app_id`	`string`	Selectable in the Payload builder
`current.is_app_managed`	`boolean`	Selectable in the Payload builder
`current.is_primary`	`boolean`	Selectable in the Payload builder
`current.is_active`	`boolean`	Selectable in the Payload builder
`current.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`current.fulfillment_priority`	`integer`	Selectable in the Payload builder
`current.address_line1`	`string`	Selectable in the Payload builder
`current.address_line2`	`string`	Selectable in the Payload builder
`current.city`	`string`	Selectable in the Payload builder
`current.state_province`	`string`	Selectable in the Payload builder
`current.postal_code`	`string`	Selectable in the Payload builder
`current.country_code`	`string`	Selectable in the Payload builder
`current.phone`	`string`	Selectable in the Payload builder
`current.is_archived`	`boolean`	Selectable in the Payload builder
`current.previous_app_id`	`string`	Selectable in the Payload builder
`current.previous_app_name`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "is_active"
  ],
  "current": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": false,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "resource_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
  "resource_type": "location"
}

Location created

EVENT locations/create App scope: read_locations Staff permission: locations:read

Fired when a new location is created.

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`current.id`	`string`	Selectable in the Payload builder
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.app_id`	`string`	Selectable in the Payload builder
`current.is_app_managed`	`boolean`	Selectable in the Payload builder
`current.is_primary`	`boolean`	Selectable in the Payload builder
`current.is_active`	`boolean`	Selectable in the Payload builder
`current.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`current.fulfillment_priority`	`integer`	Selectable in the Payload builder
`current.address_line1`	`string`	Selectable in the Payload builder
`current.address_line2`	`string`	Selectable in the Payload builder
`current.city`	`string`	Selectable in the Payload builder
`current.state_province`	`string`	Selectable in the Payload builder
`current.postal_code`	`string`	Selectable in the Payload builder
`current.country_code`	`string`	Selectable in the Payload builder
`current.phone`	`string`	Selectable in the Payload builder
`current.is_archived`	`boolean`	Selectable in the Payload builder
`current.previous_app_id`	`string`	Selectable in the Payload builder
`current.previous_app_name`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "current": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "resource_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
  "resource_type": "location"
}

Location deactivated

EVENT locations/deactivated App scope: read_locations Staff permission: locations:read

Fired when a location's is_active flips from true to false. Fulfillment integrations typically reassign pending work on this event.

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`previous.id`	`string`	Selectable in the Payload builder
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.app_id`	`string`	Selectable in the Payload builder
`previous.is_app_managed`	`boolean`	Selectable in the Payload builder
`previous.is_primary`	`boolean`	Selectable in the Payload builder
`previous.is_active`	`boolean`	Selectable in the Payload builder
`previous.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`previous.fulfillment_priority`	`integer`	Selectable in the Payload builder
`previous.address_line1`	`string`	Selectable in the Payload builder
`previous.address_line2`	`string`	Selectable in the Payload builder
`previous.city`	`string`	Selectable in the Payload builder
`previous.state_province`	`string`	Selectable in the Payload builder
`previous.postal_code`	`string`	Selectable in the Payload builder
`previous.country_code`	`string`	Selectable in the Payload builder
`previous.phone`	`string`	Selectable in the Payload builder
`previous.is_archived`	`boolean`	Selectable in the Payload builder
`previous.previous_app_id`	`string`	Selectable in the Payload builder
`previous.previous_app_name`	`string`	Selectable in the Payload builder
`current.id`	`string`	Selectable in the Payload builder
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.app_id`	`string`	Selectable in the Payload builder
`current.is_app_managed`	`boolean`	Selectable in the Payload builder
`current.is_primary`	`boolean`	Selectable in the Payload builder
`current.is_active`	`boolean`	Selectable in the Payload builder
`current.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`current.fulfillment_priority`	`integer`	Selectable in the Payload builder
`current.address_line1`	`string`	Selectable in the Payload builder
`current.address_line2`	`string`	Selectable in the Payload builder
`current.city`	`string`	Selectable in the Payload builder
`current.state_province`	`string`	Selectable in the Payload builder
`current.postal_code`	`string`	Selectable in the Payload builder
`current.country_code`	`string`	Selectable in the Payload builder
`current.phone`	`string`	Selectable in the Payload builder
`current.is_archived`	`boolean`	Selectable in the Payload builder
`current.previous_app_id`	`string`	Selectable in the Payload builder
`current.previous_app_name`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "is_active"
  ],
  "current": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": false,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "resource_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
  "resource_type": "location"
}

Location deleted

EVENT locations/delete App scope: read_locations Staff permission: locations:read

Fired when a location is deleted.

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`previous.id`	`string`	Selectable in the Payload builder
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.app_id`	`string`	Selectable in the Payload builder
`previous.is_app_managed`	`boolean`	Selectable in the Payload builder
`previous.is_primary`	`boolean`	Selectable in the Payload builder
`previous.is_active`	`boolean`	Selectable in the Payload builder
`previous.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`previous.fulfillment_priority`	`integer`	Selectable in the Payload builder
`previous.address_line1`	`string`	Selectable in the Payload builder
`previous.address_line2`	`string`	Selectable in the Payload builder
`previous.city`	`string`	Selectable in the Payload builder
`previous.state_province`	`string`	Selectable in the Payload builder
`previous.postal_code`	`string`	Selectable in the Payload builder
`previous.country_code`	`string`	Selectable in the Payload builder
`previous.phone`	`string`	Selectable in the Payload builder
`previous.is_archived`	`boolean`	Selectable in the Payload builder
`previous.previous_app_id`	`string`	Selectable in the Payload builder
`previous.previous_app_name`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "resource_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
  "resource_type": "location"
}

Location fulfillment disabled

EVENT locations/fulfillment_disabled App scope: read_locations Staff permission: locations:read

Fired when a location's fulfills_online_orders flips from true to false. Fulfillment integrations should stop routing new online orders here.

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`previous.id`	`string`	Selectable in the Payload builder
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.app_id`	`string`	Selectable in the Payload builder
`previous.is_app_managed`	`boolean`	Selectable in the Payload builder
`previous.is_primary`	`boolean`	Selectable in the Payload builder
`previous.is_active`	`boolean`	Selectable in the Payload builder
`previous.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`previous.fulfillment_priority`	`integer`	Selectable in the Payload builder
`previous.address_line1`	`string`	Selectable in the Payload builder
`previous.address_line2`	`string`	Selectable in the Payload builder
`previous.city`	`string`	Selectable in the Payload builder
`previous.state_province`	`string`	Selectable in the Payload builder
`previous.postal_code`	`string`	Selectable in the Payload builder
`previous.country_code`	`string`	Selectable in the Payload builder
`previous.phone`	`string`	Selectable in the Payload builder
`previous.is_archived`	`boolean`	Selectable in the Payload builder
`previous.previous_app_id`	`string`	Selectable in the Payload builder
`previous.previous_app_name`	`string`	Selectable in the Payload builder
`current.id`	`string`	Selectable in the Payload builder
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.app_id`	`string`	Selectable in the Payload builder
`current.is_app_managed`	`boolean`	Selectable in the Payload builder
`current.is_primary`	`boolean`	Selectable in the Payload builder
`current.is_active`	`boolean`	Selectable in the Payload builder
`current.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`current.fulfillment_priority`	`integer`	Selectable in the Payload builder
`current.address_line1`	`string`	Selectable in the Payload builder
`current.address_line2`	`string`	Selectable in the Payload builder
`current.city`	`string`	Selectable in the Payload builder
`current.state_province`	`string`	Selectable in the Payload builder
`current.postal_code`	`string`	Selectable in the Payload builder
`current.country_code`	`string`	Selectable in the Payload builder
`current.phone`	`string`	Selectable in the Payload builder
`current.is_archived`	`boolean`	Selectable in the Payload builder
`current.previous_app_id`	`string`	Selectable in the Payload builder
`current.previous_app_name`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "fulfills_online_orders"
  ],
  "current": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "resource_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
  "resource_type": "location"
}

Location fulfillment enabled

EVENT locations/fulfillment_enabled App scope: read_locations Staff permission: locations:read

Fired when a location's fulfills_online_orders flips from false to true.

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`previous.id`	`string`	Selectable in the Payload builder
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.app_id`	`string`	Selectable in the Payload builder
`previous.is_app_managed`	`boolean`	Selectable in the Payload builder
`previous.is_primary`	`boolean`	Selectable in the Payload builder
`previous.is_active`	`boolean`	Selectable in the Payload builder
`previous.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`previous.fulfillment_priority`	`integer`	Selectable in the Payload builder
`previous.address_line1`	`string`	Selectable in the Payload builder
`previous.address_line2`	`string`	Selectable in the Payload builder
`previous.city`	`string`	Selectable in the Payload builder
`previous.state_province`	`string`	Selectable in the Payload builder
`previous.postal_code`	`string`	Selectable in the Payload builder
`previous.country_code`	`string`	Selectable in the Payload builder
`previous.phone`	`string`	Selectable in the Payload builder
`previous.is_archived`	`boolean`	Selectable in the Payload builder
`previous.previous_app_id`	`string`	Selectable in the Payload builder
`previous.previous_app_name`	`string`	Selectable in the Payload builder
`current.id`	`string`	Selectable in the Payload builder
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.app_id`	`string`	Selectable in the Payload builder
`current.is_app_managed`	`boolean`	Selectable in the Payload builder
`current.is_primary`	`boolean`	Selectable in the Payload builder
`current.is_active`	`boolean`	Selectable in the Payload builder
`current.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`current.fulfillment_priority`	`integer`	Selectable in the Payload builder
`current.address_line1`	`string`	Selectable in the Payload builder
`current.address_line2`	`string`	Selectable in the Payload builder
`current.city`	`string`	Selectable in the Payload builder
`current.state_province`	`string`	Selectable in the Payload builder
`current.postal_code`	`string`	Selectable in the Payload builder
`current.country_code`	`string`	Selectable in the Payload builder
`current.phone`	`string`	Selectable in the Payload builder
`current.is_archived`	`boolean`	Selectable in the Payload builder
`current.previous_app_id`	`string`	Selectable in the Payload builder
`current.previous_app_name`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "fulfills_online_orders"
  ],
  "current": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "resource_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
  "resource_type": "location"
}

Location updated

EVENT locations/update App scope: read_locations Staff permission: locations:read

Fired when a location's non-state fields change, including fulfillment_priority changes from a reorder. State transitions fire their specific topic instead; if state and non-state fields change in one save, both fire. Archiving or restoring a location, and an uninstall handing an app's locations to the merchant, also fire this topic with is_archived or app_id and previous_app_id/previous_app_name in changed_fields.

Payload fields

Field	Type	Description
`resource_type`	`string`	Selectable in the Payload builder
`resource_id`	`string`	Selectable in the Payload builder
`occurred_at`	`string`	Selectable in the Payload builder
`previous.id`	`string`	Selectable in the Payload builder
`previous.name`	`string`	Selectable in the Payload builder
`previous.slug`	`string`	Selectable in the Payload builder
`previous.app_id`	`string`	Selectable in the Payload builder
`previous.is_app_managed`	`boolean`	Selectable in the Payload builder
`previous.is_primary`	`boolean`	Selectable in the Payload builder
`previous.is_active`	`boolean`	Selectable in the Payload builder
`previous.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`previous.fulfillment_priority`	`integer`	Selectable in the Payload builder
`previous.address_line1`	`string`	Selectable in the Payload builder
`previous.address_line2`	`string`	Selectable in the Payload builder
`previous.city`	`string`	Selectable in the Payload builder
`previous.state_province`	`string`	Selectable in the Payload builder
`previous.postal_code`	`string`	Selectable in the Payload builder
`previous.country_code`	`string`	Selectable in the Payload builder
`previous.phone`	`string`	Selectable in the Payload builder
`previous.is_archived`	`boolean`	Selectable in the Payload builder
`previous.previous_app_id`	`string`	Selectable in the Payload builder
`previous.previous_app_name`	`string`	Selectable in the Payload builder
`current.id`	`string`	Selectable in the Payload builder
`current.name`	`string`	Selectable in the Payload builder
`current.slug`	`string`	Selectable in the Payload builder
`current.app_id`	`string`	Selectable in the Payload builder
`current.is_app_managed`	`boolean`	Selectable in the Payload builder
`current.is_primary`	`boolean`	Selectable in the Payload builder
`current.is_active`	`boolean`	Selectable in the Payload builder
`current.fulfills_online_orders`	`boolean`	Selectable in the Payload builder
`current.fulfillment_priority`	`integer`	Selectable in the Payload builder
`current.address_line1`	`string`	Selectable in the Payload builder
`current.address_line2`	`string`	Selectable in the Payload builder
`current.city`	`string`	Selectable in the Payload builder
`current.state_province`	`string`	Selectable in the Payload builder
`current.postal_code`	`string`	Selectable in the Payload builder
`current.country_code`	`string`	Selectable in the Payload builder
`current.phone`	`string`	Selectable in the Payload builder
`current.is_archived`	`boolean`	Selectable in the Payload builder
`current.previous_app_id`	`string`	Selectable in the Payload builder
`current.previous_app_name`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "name"
  ],
  "current": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Bay Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "occurred_at": "2026-06-09T12:00:00+05:30",
  "previous": {
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "app_id": null,
    "city": "San Francisco",
    "country_code": "US",
    "fulfillment_priority": 0,
    "fulfills_online_orders": true,
    "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "is_active": true,
    "is_app_managed": false,
    "is_archived": false,
    "is_primary": true,
    "name": "Main Warehouse",
    "phone": "+14155550123",
    "postal_code": "94105",
    "previous_app_id": null,
    "previous_app_name": null,
    "slug": "main-warehouse",
    "state_province": "CA"
  },
  "resource_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
  "resource_type": "location"
}

Newsletter subscriber added

EVENT subscribers/create App scope: read_marketing Staff permission: marketing:write

Fired when a newsletter subscriber becomes active — direct opt-in, or the confirmation click when double opt-in is on.

Payload fields

Field	Type	Description
`subscriber.id`	`string`	Always present
`subscriber.email`	`string`	Always present
`subscriber.customer_id`	`string`	Selectable in the Payload builder
`subscriber.status`	`string`	Always present
`subscriber.source`	`string`	Always present
`subscriber.confirmed_at`	`string`	Selectable in the Payload builder
`subscriber.created_at`	`string`	Always present

Payload shape

Sample payload

{
  "subscriber": {
    "confirmed_at": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "customer_id": "...",
    "email": "...",
    "id": "...",
    "source": "...",
    "status": "..."
  }
}

Checkout fee created

EVENT checkout_fees/create App scope: read_markets Staff permission: markets:write

Subscribe to receive a checkout fee after it is created in a market.

Payload fields

Field	Type	Description
`checkout_fee.id`	`string`	Always present
`checkout_fee.market_id`	`string`	Selectable in the Payload builder
`checkout_fee.name`	`string`	Selectable in the Payload builder
`checkout_fee.description`	`string`	Selectable in the Payload builder
`checkout_fee.fee_type`	`string`	Selectable in the Payload builder
`checkout_fee.percent_value`	`string`	Selectable in the Payload builder
`checkout_fee.fee_amounts`	`object`	Selectable in the Payload builder
`checkout_fee.apply_per`	`string`	Selectable in the Payload builder
`checkout_fee.tax_class_id`	`string`	Selectable in the Payload builder
`checkout_fee.hsn_code`	`string`	Selectable in the Payload builder
`checkout_fee.is_enabled`	`boolean`	Selectable in the Payload builder
`checkout_fee.is_optional`	`boolean`	Selectable in the Payload builder
`checkout_fee.sort_order`	`integer`	Selectable in the Payload builder
`checkout_fee.created_at`	`string`	Selectable in the Payload builder
`checkout_fee.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "checkout_fee": {
    "apply_per": "order",
    "created_at": "2026-07-01T10:15:00+05:30",
    "description": "Wrap the order before dispatch",
    "fee_amounts": {
      "USD": "5.00"
    },
    "fee_type": "fixed",
    "hsn_code": "996812",
    "id": "6a9d2e4f-1b3c-4785-9a0d-2e4f6a8b1c3d",
    "is_enabled": true,
    "is_optional": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "Gift wrapping",
    "percent_value": null,
    "sort_order": 2,
    "tax_class_id": "4be5c5d1-0999-48ea-a2e0-f86703d99169",
    "updated_at": "2026-07-21T14:30:00+05:30"
  }
}

Checkout fee deleted

EVENT checkout_fees/delete App scope: read_markets Staff permission: markets:write

Subscribe to remove a deleted checkout fee from your integration. The payload keeps its id, market id, and last known name.

Payload fields

Field	Type	Description
`checkout_fee.id`	`string`	Always present
`checkout_fee.market_id`	`string`	Selectable in the Payload builder
`checkout_fee.name`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "checkout_fee": {
    "id": "6a9d2e4f-1b3c-4785-9a0d-2e4f6a8b1c3d",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "Gift wrapping"
  }
}

Checkout fees reordered

EVENT checkout_fees/reorder App scope: read_markets Staff permission: markets:write

Subscribe to receive the complete checkout fee order after fees are rearranged in a market.

Payload fields

Field	Type	Description
`market_id`	`string`	Always present
`fee_ids`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "fee_ids": [
    "2a7f1c3d-4e5b-4890-a6c8-1d3e5f7a9b0c",
    "6a9d2e4f-1b3c-4785-9a0d-2e4f6a8b1c3d"
  ],
  "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789"
}

Checkout fee updated

EVENT checkout_fees/update App scope: read_markets Staff permission: markets:write

Subscribe to receive the current checkout fee after its amount, application, tax treatment, availability, or position changes.

Payload fields

Field	Type	Description
`checkout_fee.id`	`string`	Always present
`checkout_fee.market_id`	`string`	Selectable in the Payload builder
`checkout_fee.name`	`string`	Selectable in the Payload builder
`checkout_fee.description`	`string`	Selectable in the Payload builder
`checkout_fee.fee_type`	`string`	Selectable in the Payload builder
`checkout_fee.percent_value`	`string`	Selectable in the Payload builder
`checkout_fee.fee_amounts`	`object`	Selectable in the Payload builder
`checkout_fee.apply_per`	`string`	Selectable in the Payload builder
`checkout_fee.tax_class_id`	`string`	Selectable in the Payload builder
`checkout_fee.hsn_code`	`string`	Selectable in the Payload builder
`checkout_fee.is_enabled`	`boolean`	Selectable in the Payload builder
`checkout_fee.is_optional`	`boolean`	Selectable in the Payload builder
`checkout_fee.sort_order`	`integer`	Selectable in the Payload builder
`checkout_fee.created_at`	`string`	Selectable in the Payload builder
`checkout_fee.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "checkout_fee": {
    "apply_per": "order",
    "created_at": "2026-07-01T10:15:00+05:30",
    "description": "Wrap the order before dispatch",
    "fee_amounts": {
      "USD": "5.00"
    },
    "fee_type": "fixed",
    "hsn_code": "996812",
    "id": "6a9d2e4f-1b3c-4785-9a0d-2e4f6a8b1c3d",
    "is_enabled": true,
    "is_optional": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "Gift wrapping",
    "percent_value": null,
    "sort_order": 2,
    "tax_class_id": "4be5c5d1-0999-48ea-a2e0-f86703d99169",
    "updated_at": "2026-07-21T14:30:00+05:30"
  }
}

Checkout limits updated

EVENT checkout_settings/update App scope: read_markets Staff permission: markets:write

Subscribe to receive the current minimum and maximum merchandise subtotal rules after checkout limits change for a market.

Payload fields

Field	Type	Description
`checkout_settings.id`	`string`	Always present
`checkout_settings.market_id`	`string`	Selectable in the Payload builder
`checkout_settings.min_order_enabled`	`boolean`	Selectable in the Payload builder
`checkout_settings.min_order_amounts`	`object`	Selectable in the Payload builder
`checkout_settings.max_order_enabled`	`boolean`	Selectable in the Payload builder
`checkout_settings.max_order_amounts`	`object`	Selectable in the Payload builder
`checkout_settings.created_at`	`string`	Selectable in the Payload builder
`checkout_settings.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "checkout_settings": {
    "created_at": "2026-07-01T10:15:00+05:30",
    "id": "8d4f1b2c-6a7e-4890-9c3d-5e6f708192a3",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "max_order_amounts": {
      "CHF": "950.00",
      "EUR": "1000.00"
    },
    "max_order_enabled": true,
    "min_order_amounts": {
      "CHF": "45.00",
      "EUR": "50.00"
    },
    "min_order_enabled": true,
    "updated_at": "2026-07-21T14:30:00+05:30"
  }
}

Cash on delivery settings updated

EVENT cod_settings/update App scope: read_markets Staff permission: markets:write

Fired when a market's cash-on-delivery mode, availability, fee, threshold, or fee-tax settings change.

Payload fields

Field	Type	Description
`cod_settings.id`	`string`	Always present
`cod_settings.market_id`	`string`	Selectable in the Payload builder
`cod_settings.mode`	`string`	Selectable in the Payload builder
`cod_settings.is_enabled`	`boolean`	Selectable in the Payload builder
`cod_settings.fee_type`	`string`	Selectable in the Payload builder
`cod_settings.percent_value`	`string`	Selectable in the Payload builder
`cod_settings.fee_amounts`	`object`	Selectable in the Payload builder
`cod_settings.min_order_enabled`	`boolean`	Selectable in the Payload builder
`cod_settings.min_order_amounts`	`object`	Selectable in the Payload builder
`cod_settings.max_order_enabled`	`boolean`	Selectable in the Payload builder
`cod_settings.max_order_amounts`	`object`	Selectable in the Payload builder
`cod_settings.waive_fee_enabled`	`boolean`	Selectable in the Payload builder
`cod_settings.waive_fee_over_amounts`	`object`	Selectable in the Payload builder
`cod_settings.tax_class_id`	`string`	Selectable in the Payload builder
`cod_settings.hsn_code`	`string`	Selectable in the Payload builder
`cod_settings.unavailable_display`	`string`	Selectable in the Payload builder
`cod_settings.unavailable_message`	`string`	Selectable in the Payload builder
`cod_settings.created_at`	`string`	Selectable in the Payload builder
`cod_settings.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "cod_settings": {
    "created_at": "2026-07-01T10:15:00+05:30",
    "fee_amounts": {
      "INR": "25.00"
    },
    "fee_type": "fixed",
    "hsn_code": "996812",
    "id": "2c7c8547-cc7b-46b2-b32d-31c9f3f2abf8",
    "is_enabled": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "max_order_amounts": {
      "INR": "10000.00"
    },
    "max_order_enabled": true,
    "min_order_amounts": {
      "INR": "500.00"
    },
    "min_order_enabled": true,
    "mode": "simple",
    "percent_value": null,
    "tax_class_id": "4be5c5d1-0999-48ea-a2e0-f86703d99169",
    "unavailable_display": "show_reason",
    "unavailable_message": "Please choose online payment for this destination.",
    "updated_at": "2026-07-08T18:40:00+05:30",
    "waive_fee_enabled": true,
    "waive_fee_over_amounts": {
      "INR": "2500.00"
    }
  }
}

Cash on delivery zone created

EVENT cod_zones/create App scope: read_markets Staff permission: markets:write

Fired when a cash-on-delivery zone is created in a market.

Payload fields

Field	Type	Description
`cod_zone.id`	`string`	Always present
`cod_zone.market_id`	`string`	Selectable in the Payload builder
`cod_zone.name`	`string`	Selectable in the Payload builder
`cod_zone.description`	`string`	Selectable in the Payload builder
`cod_zone.countries`	`array`	Selectable in the Payload builder
`cod_zone.subdivisions`	`array`	Selectable in the Payload builder
`cod_zone.is_default`	`boolean`	Selectable in the Payload builder
`cod_zone.priority`	`integer`	Selectable in the Payload builder
`cod_zone.is_enabled`	`boolean`	Selectable in the Payload builder
`cod_zone.fee_type`	`string`	Selectable in the Payload builder
`cod_zone.percent_value`	`string`	Selectable in the Payload builder
`cod_zone.fee_amounts`	`object`	Selectable in the Payload builder
`cod_zone.min_order_enabled`	`boolean`	Selectable in the Payload builder
`cod_zone.min_order_amounts`	`object`	Selectable in the Payload builder
`cod_zone.max_order_enabled`	`boolean`	Selectable in the Payload builder
`cod_zone.max_order_amounts`	`object`	Selectable in the Payload builder
`cod_zone.waive_fee_enabled`	`boolean`	Selectable in the Payload builder
`cod_zone.waive_fee_over_amounts`	`object`	Selectable in the Payload builder
`cod_zone.tax_class_id`	`string`	Selectable in the Payload builder
`cod_zone.hsn_code`	`string`	Selectable in the Payload builder
`cod_zone.created_at`	`string`	Selectable in the Payload builder
`cod_zone.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "cod_zone": {
    "countries": [
      "IN"
    ],
    "created_at": "2026-07-01T10:15:00+05:30",
    "description": "Cash on delivery for northern states",
    "fee_amounts": {
      "INR": "35.00"
    },
    "fee_type": "fixed",
    "hsn_code": "996812",
    "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "is_default": false,
    "is_enabled": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "max_order_amounts": {
      "INR": "7500.00"
    },
    "max_order_enabled": true,
    "min_order_amounts": {},
    "min_order_enabled": false,
    "name": "North India",
    "percent_value": null,
    "priority": 10,
    "subdivisions": [
      "IN-UP"
    ],
    "tax_class_id": "4be5c5d1-0999-48ea-a2e0-f86703d99169",
    "updated_at": "2026-07-08T18:40:00+05:30",
    "waive_fee_enabled": false,
    "waive_fee_over_amounts": {}
  }
}

Cash on delivery zone deleted

EVENT cod_zones/delete App scope: read_markets Staff permission: markets:write

Fired when a cash-on-delivery zone is deleted.

Payload fields

Field	Type	Description
`cod_zone.id`	`string`	Always present
`cod_zone.market_id`	`string`	Selectable in the Payload builder
`cod_zone.name`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "cod_zone": {
    "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "North India"
  }
}

Cash on delivery zone updated

EVENT cod_zones/update App scope: read_markets Staff permission: markets:write

Fired when a cash-on-delivery zone changes.

Payload fields

Field	Type	Description
`cod_zone.id`	`string`	Always present
`cod_zone.market_id`	`string`	Selectable in the Payload builder
`cod_zone.name`	`string`	Selectable in the Payload builder
`cod_zone.description`	`string`	Selectable in the Payload builder
`cod_zone.countries`	`array`	Selectable in the Payload builder
`cod_zone.subdivisions`	`array`	Selectable in the Payload builder
`cod_zone.is_default`	`boolean`	Selectable in the Payload builder
`cod_zone.priority`	`integer`	Selectable in the Payload builder
`cod_zone.is_enabled`	`boolean`	Selectable in the Payload builder
`cod_zone.fee_type`	`string`	Selectable in the Payload builder
`cod_zone.percent_value`	`string`	Selectable in the Payload builder
`cod_zone.fee_amounts`	`object`	Selectable in the Payload builder
`cod_zone.min_order_enabled`	`boolean`	Selectable in the Payload builder
`cod_zone.min_order_amounts`	`object`	Selectable in the Payload builder
`cod_zone.max_order_enabled`	`boolean`	Selectable in the Payload builder
`cod_zone.max_order_amounts`	`object`	Selectable in the Payload builder
`cod_zone.waive_fee_enabled`	`boolean`	Selectable in the Payload builder
`cod_zone.waive_fee_over_amounts`	`object`	Selectable in the Payload builder
`cod_zone.tax_class_id`	`string`	Selectable in the Payload builder
`cod_zone.hsn_code`	`string`	Selectable in the Payload builder
`cod_zone.created_at`	`string`	Selectable in the Payload builder
`cod_zone.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "cod_zone": {
    "countries": [
      "IN"
    ],
    "created_at": "2026-07-01T10:15:00+05:30",
    "description": "Cash on delivery for northern states",
    "fee_amounts": {
      "INR": "35.00"
    },
    "fee_type": "fixed",
    "hsn_code": "996812",
    "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "is_default": false,
    "is_enabled": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "max_order_amounts": {
      "INR": "7500.00"
    },
    "max_order_enabled": true,
    "min_order_amounts": {},
    "min_order_enabled": false,
    "name": "North India",
    "percent_value": null,
    "priority": 10,
    "subdivisions": [
      "IN-UP"
    ],
    "tax_class_id": "4be5c5d1-0999-48ea-a2e0-f86703d99169",
    "updated_at": "2026-07-08T18:40:00+05:30",
    "waive_fee_enabled": false,
    "waive_fee_over_amounts": {}
  }
}

Discount settings updated

EVENT discount_settings/update App scope: read_markets Staff permission: markets:write

Subscribe when your app needs the current rules for combining discounts in a market.

Payload fields

Field	Type	Description
`discount_settings.market_id`	`string`	Always present The market whose combination settings changed.
`discount_settings.stacking_mode`	`string`	Selectable in the Payload builder single applies one discount per order, chosen by priority_mode; stack applies every eligible automatic discount plus codes up to coupon_limit.
`discount_settings.priority_mode`	`string`	Selectable in the Payload builder How discounts are ranked: best_for_customer by each discount's own saving, manual by priority number, lowest first. The ranking picks the single discount, fills the coupon limit, and decides which offer keeps items two offers both need.
`discount_settings.coupon_limit`	`integer`	Selectable in the Payload builder The maximum number of codes that can apply to one order in stack mode. Automatic discounts do not count.
`discount_settings.auto_coupon_combine`	`boolean`	Selectable in the Payload builder In stack mode, true lets codes apply alongside automatic discounts; false lets codes apply only when no automatic discount applies. No effect in single mode.
`discount_settings.apply_to_quantity_priced`	`boolean`	Selectable in the Payload builder When false, items with quantity pricing get no discount and do not count toward minimum spend, minimum quantity or tiers.

Payload shape

Sample payload

{
  "discount_settings": {
    "apply_to_quantity_priced": false,
    "auto_coupon_combine": true,
    "coupon_limit": 2,
    "market_id": "1c807b16-8a93-4f13-b998-1226c87d57ac",
    "priority_mode": "best_for_customer",
    "stacking_mode": "stack"
  }
}

Discount created

EVENT discounts/create App scope: read_markets Staff permission: markets:write

Subscribe to receive the complete discount definition after a discount is created in a market.

Payload fields

Field	Type	Description
`discount.gift_mode`	`string`	Selectable in the Payload builder Whether unlocked gifts are offered to claim (offer) or inserted automatically (auto_add).
`discount.gift_items[*].product_id`	`integer`	Selectable in the Payload builder The gift-only product id.
`discount.gift_items[*].variant_id`	`integer`	Selectable in the Payload builder The exact gift variant id for a variable product; omitted for a simple product.
`discount.gift_items[*].quantity`	`integer`	Selectable in the Payload builder Granted quantity per cart while the offer qualifies.
`discount.tier_value_kind`	`string`	Selectable in the Payload builder percentage or fixed_amount for tiered discounts.
`discount.tiers[*].min_subtotal`	`string`	Selectable in the Payload builder Ascending threshold in the store base currency. Only the highest reached tier applies.
`discount.tiers[*].value`	`string`	Selectable in the Payload builder Percentage or base-currency amount granted by this tier.
`discount.id`	`string`	Always present The stable discount id.
`discount.market_id`	`string`	Selectable in the Payload builder The market where this discount is evaluated.
`discount.name`	`string`	Selectable in the Payload builder The merchant-facing name of the discount.
`discount.type`	`string`	Selectable in the Payload builder The pricing rule: percentage, fixed amount, Buy X Get Y, bundle, free gift, or tiered.
`discount.activation`	`string`	Selectable in the Payload builder Whether the discount applies automatically or after a coupon code is entered.
`discount.code`	`string`	Selectable in the Payload builder The coupon code, or null for an automatic discount.
`discount.status`	`string`	Selectable in the Payload builder The current effective status after applying the schedule and enabled state.
`discount.priority`	`integer`	Selectable in the Payload builder The merchant-defined order used when priority decides between competing offers.
`discount.value`	`number`	Selectable in the Payload builder The percentage value for a percentage discount; null for other types.
`discount.amounts`	`object`	Selectable in the Payload builder Fixed discount amounts keyed by currency code; empty for other types.
`discount.applies_to`	`string`	Selectable in the Payload builder The merchandise scope selected by the merchant.
`discount.exclude_sale_items`	`boolean`	Selectable in the Payload builder Whether items already on sale are excluded.
`discount.min_subtotal`	`object`	Selectable in the Payload builder The qualifying merchandise subtotal keyed by currency code.
`discount.min_quantity`	`integer`	Selectable in the Payload builder The minimum qualifying item quantity, or null when unused.
`discount.max_discount`	`object`	Selectable in the Payload builder The cap on the amount saved, keyed by currency code (percentage, bundle and tiered discounts).
`discount.usage_limit`	`integer`	Selectable in the Payload builder The total number of uses allowed, or null when unlimited.
`discount.per_customer_limit`	`integer`	Selectable in the Payload builder The number of uses allowed per customer (recognised by account or email), or null when unlimited.
`discount.customer_eligibility`	`string`	Selectable in the Payload builder Whether everyone, selected customers, or selected customer groups qualify.
`discount.first_order_only`	`boolean`	Selectable in the Payload builder Whether only a customer's first paid order qualifies; guests are recognised by email.
`discount.refund_restores_usage`	`boolean`	Selectable in the Payload builder Whether a fully refunded order gives its use back to the total and per-customer limits.
`discount.show_in_cart`	`boolean`	Selectable in the Payload builder Whether an eligible coupon may be surfaced before checkout.
`discount.bxgy_buy_quantity`	`integer`	Selectable in the Payload builder The quantity required from the Buy X set.
`discount.bxgy_get_quantity`	`integer`	Selectable in the Payload builder The quantity rewarded from the Get Y set.
`discount.bxgy_get_type`	`string`	Selectable in the Payload builder Whether reward items are free, reduced by a percentage, or reduced by a fixed amount off each item.
`discount.bxgy_get_value`	`number`	Selectable in the Payload builder The percentage off, or the fixed base-currency amount off, each reward item; null when rewards are free.
`discount.bxgy_max_uses`	`integer`	Selectable in the Payload builder The maximum number of complete Buy X Get Y sets per order.
`discount.bxgy_buy_items[*].item_type`	`string`	Selectable in the Payload builder The kind of Buy X target: simple product, exact variant, collection, or category.
`discount.bxgy_buy_items[*].item_id`	`string`	Selectable in the Payload builder The id of the Buy X target.
`discount.bxgy_get_items[*].item_type`	`string`	Selectable in the Payload builder The kind of Get Y target: simple product, exact variant, collection, or category.
`discount.bxgy_get_items[*].item_id`	`string`	Selectable in the Payload builder The id of the Get Y target.
`discount.bundle_value_mode`	`string`	Selectable in the Payload builder Whether a complete bundle has a fixed set price or a percentage reduction.
`discount.bundle_percentage`	`number`	Selectable in the Payload builder The percentage reduction for each complete bundle set.
`discount.bundle_prices`	`object`	Selectable in the Payload builder The fixed price of one complete bundle keyed by currency code.
`discount.bundle_max_sets`	`integer`	Selectable in the Payload builder The maximum number of complete bundle sets discounted per order, or null when unlimited.
`discount.bundle_items[*].item_type`	`string`	Selectable in the Payload builder product (matches any variant of the product) or variant (matches only that variant).
`discount.bundle_items[*].item_id`	`string`	Selectable in the Payload builder The product or variant id for this component.
`discount.bundle_items[*].quantity`	`integer`	Selectable in the Payload builder The quantity required in each complete bundle set.
`discount.product_ids`	`array`	Selectable in the Payload builder Product ids used when the discount targets selected products.
`discount.variant_ids`	`array`	Selectable in the Payload builder Exact variant ids used when the discount targets selected products or variants.
`discount.collection_ids`	`array`	Selectable in the Payload builder Collection ids used when the discount targets selected collections.
`discount.category_ids`	`array`	Selectable in the Payload builder Category ids used when the discount targets selected categories.
`discount.customer_ids`	`array`	Selectable in the Payload builder Customer ids used when eligibility is limited to selected customers.
`discount.group_ids`	`array`	Selectable in the Payload builder Customer-group ids used when eligibility is limited to selected groups.
`discount.starts_at`	`string`	Selectable in the Payload builder The optional start of the discount window, in the store's time zone with its offset.
`discount.ends_at`	`string`	Selectable in the Payload builder The optional end of the discount window, in the store's time zone with its offset.
`discount.created_at`	`string`	Selectable in the Payload builder When the discount was created.
`discount.updated_at`	`string`	Selectable in the Payload builder When the discount last changed.

Payload shape

Sample payload

{
  "discount": {
    "activation": "automatic",
    "amounts": {},
    "applies_to": "entire_order",
    "bundle_items": [],
    "bundle_max_sets": null,
    "bundle_percentage": null,
    "bundle_prices": {},
    "bundle_value_mode": null,
    "bxgy_buy_items": [
      {
        "item_id": "42",
        "item_type": "product"
      }
    ],
    "bxgy_buy_quantity": 2,
    "bxgy_get_items": [
      {
        "item_id": "57",
        "item_type": "product"
      }
    ],
    "bxgy_get_quantity": 1,
    "bxgy_get_type": "free",
    "bxgy_get_value": null,
    "bxgy_max_uses": 3,
    "category_ids": [],
    "code": null,
    "collection_ids": [],
    "created_at": "2026-06-09T12:00:00+05:30",
    "customer_eligibility": "everyone",
    "customer_ids": [],
    "ends_at": null,
    "exclude_sale_items": false,
    "first_order_only": false,
    "gift_items": [],
    "gift_mode": null,
    "group_ids": [],
    "id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
    "market_id": "1c807b16-8a93-4f13-b998-1226c87d57ac",
    "max_discount": {},
    "min_quantity": null,
    "min_subtotal": {
      "USD": "50.00"
    },
    "name": "Buy two tees, get one free",
    "per_customer_limit": null,
    "priority": 10,
    "product_ids": [],
    "refund_restores_usage": false,
    "show_in_cart": false,
    "starts_at": null,
    "status": "active",
    "tier_value_kind": null,
    "tiers": [],
    "type": "buy_x_get_y",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "usage_limit": null,
    "value": null,
    "variant_ids": []
  }
}

Discount deleted

EVENT discounts/delete App scope: read_markets Staff permission: markets:write

Subscribe to remove a deleted discount from your integration. The payload keeps its id, market id, and last known name.

Payload fields

Field	Type	Description
`id`	`string`	Always present The stable id of the deleted discount.
`market_id`	`string`	Selectable in the Payload builder The market that owned the discount.
`name`	`string`	Selectable in the Payload builder The discount name at the time it was deleted.

Payload shape

Sample payload

{
  "id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
  "market_id": "1c807b16-8a93-4f13-b998-1226c87d57ac",
  "name": "Buy two tees, get one free"
}

Discount updated

EVENT discounts/update App scope: read_markets Staff permission: markets:write

Subscribe to receive the current discount definition after its offer, targeting, schedule, limits, or enabled state changes.

Payload fields

Field	Type	Description
`discount.gift_mode`	`string`	Selectable in the Payload builder Whether unlocked gifts are offered to claim (offer) or inserted automatically (auto_add).
`discount.gift_items[*].product_id`	`integer`	Selectable in the Payload builder The gift-only product id.
`discount.gift_items[*].variant_id`	`integer`	Selectable in the Payload builder The exact gift variant id for a variable product; omitted for a simple product.
`discount.gift_items[*].quantity`	`integer`	Selectable in the Payload builder Granted quantity per cart while the offer qualifies.
`discount.tier_value_kind`	`string`	Selectable in the Payload builder percentage or fixed_amount for tiered discounts.
`discount.tiers[*].min_subtotal`	`string`	Selectable in the Payload builder Ascending threshold in the store base currency. Only the highest reached tier applies.
`discount.tiers[*].value`	`string`	Selectable in the Payload builder Percentage or base-currency amount granted by this tier.
`discount.id`	`string`	Always present The stable discount id.
`discount.market_id`	`string`	Selectable in the Payload builder The market where this discount is evaluated.
`discount.name`	`string`	Selectable in the Payload builder The merchant-facing name of the discount.
`discount.type`	`string`	Selectable in the Payload builder The pricing rule: percentage, fixed amount, Buy X Get Y, bundle, free gift, or tiered.
`discount.activation`	`string`	Selectable in the Payload builder Whether the discount applies automatically or after a coupon code is entered.
`discount.code`	`string`	Selectable in the Payload builder The coupon code, or null for an automatic discount.
`discount.status`	`string`	Selectable in the Payload builder The current effective status after applying the schedule and enabled state.
`discount.priority`	`integer`	Selectable in the Payload builder The merchant-defined order used when priority decides between competing offers.
`discount.value`	`number`	Selectable in the Payload builder The percentage value for a percentage discount; null for other types.
`discount.amounts`	`object`	Selectable in the Payload builder Fixed discount amounts keyed by currency code; empty for other types.
`discount.applies_to`	`string`	Selectable in the Payload builder The merchandise scope selected by the merchant.
`discount.exclude_sale_items`	`boolean`	Selectable in the Payload builder Whether items already on sale are excluded.
`discount.min_subtotal`	`object`	Selectable in the Payload builder The qualifying merchandise subtotal keyed by currency code.
`discount.min_quantity`	`integer`	Selectable in the Payload builder The minimum qualifying item quantity, or null when unused.
`discount.max_discount`	`object`	Selectable in the Payload builder The cap on the amount saved, keyed by currency code (percentage, bundle and tiered discounts).
`discount.usage_limit`	`integer`	Selectable in the Payload builder The total number of uses allowed, or null when unlimited.
`discount.per_customer_limit`	`integer`	Selectable in the Payload builder The number of uses allowed per customer (recognised by account or email), or null when unlimited.
`discount.customer_eligibility`	`string`	Selectable in the Payload builder Whether everyone, selected customers, or selected customer groups qualify.
`discount.first_order_only`	`boolean`	Selectable in the Payload builder Whether only a customer's first paid order qualifies; guests are recognised by email.
`discount.refund_restores_usage`	`boolean`	Selectable in the Payload builder Whether a fully refunded order gives its use back to the total and per-customer limits.
`discount.show_in_cart`	`boolean`	Selectable in the Payload builder Whether an eligible coupon may be surfaced before checkout.
`discount.bxgy_buy_quantity`	`integer`	Selectable in the Payload builder The quantity required from the Buy X set.
`discount.bxgy_get_quantity`	`integer`	Selectable in the Payload builder The quantity rewarded from the Get Y set.
`discount.bxgy_get_type`	`string`	Selectable in the Payload builder Whether reward items are free, reduced by a percentage, or reduced by a fixed amount off each item.
`discount.bxgy_get_value`	`number`	Selectable in the Payload builder The percentage off, or the fixed base-currency amount off, each reward item; null when rewards are free.
`discount.bxgy_max_uses`	`integer`	Selectable in the Payload builder The maximum number of complete Buy X Get Y sets per order.
`discount.bxgy_buy_items[*].item_type`	`string`	Selectable in the Payload builder The kind of Buy X target: simple product, exact variant, collection, or category.
`discount.bxgy_buy_items[*].item_id`	`string`	Selectable in the Payload builder The id of the Buy X target.
`discount.bxgy_get_items[*].item_type`	`string`	Selectable in the Payload builder The kind of Get Y target: simple product, exact variant, collection, or category.
`discount.bxgy_get_items[*].item_id`	`string`	Selectable in the Payload builder The id of the Get Y target.
`discount.bundle_value_mode`	`string`	Selectable in the Payload builder Whether a complete bundle has a fixed set price or a percentage reduction.
`discount.bundle_percentage`	`number`	Selectable in the Payload builder The percentage reduction for each complete bundle set.
`discount.bundle_prices`	`object`	Selectable in the Payload builder The fixed price of one complete bundle keyed by currency code.
`discount.bundle_max_sets`	`integer`	Selectable in the Payload builder The maximum number of complete bundle sets discounted per order, or null when unlimited.
`discount.bundle_items[*].item_type`	`string`	Selectable in the Payload builder product (matches any variant of the product) or variant (matches only that variant).
`discount.bundle_items[*].item_id`	`string`	Selectable in the Payload builder The product or variant id for this component.
`discount.bundle_items[*].quantity`	`integer`	Selectable in the Payload builder The quantity required in each complete bundle set.
`discount.product_ids`	`array`	Selectable in the Payload builder Product ids used when the discount targets selected products.
`discount.variant_ids`	`array`	Selectable in the Payload builder Exact variant ids used when the discount targets selected products or variants.
`discount.collection_ids`	`array`	Selectable in the Payload builder Collection ids used when the discount targets selected collections.
`discount.category_ids`	`array`	Selectable in the Payload builder Category ids used when the discount targets selected categories.
`discount.customer_ids`	`array`	Selectable in the Payload builder Customer ids used when eligibility is limited to selected customers.
`discount.group_ids`	`array`	Selectable in the Payload builder Customer-group ids used when eligibility is limited to selected groups.
`discount.starts_at`	`string`	Selectable in the Payload builder The optional start of the discount window, in the store's time zone with its offset.
`discount.ends_at`	`string`	Selectable in the Payload builder The optional end of the discount window, in the store's time zone with its offset.
`discount.created_at`	`string`	Selectable in the Payload builder When the discount was created.
`discount.updated_at`	`string`	Selectable in the Payload builder When the discount last changed.

Payload shape

Sample payload

{
  "discount": {
    "activation": "automatic",
    "amounts": {},
    "applies_to": "entire_order",
    "bundle_items": [],
    "bundle_max_sets": null,
    "bundle_percentage": null,
    "bundle_prices": {},
    "bundle_value_mode": null,
    "bxgy_buy_items": [
      {
        "item_id": "42",
        "item_type": "product"
      }
    ],
    "bxgy_buy_quantity": 2,
    "bxgy_get_items": [
      {
        "item_id": "57",
        "item_type": "product"
      }
    ],
    "bxgy_get_quantity": 1,
    "bxgy_get_type": "free",
    "bxgy_get_value": null,
    "bxgy_max_uses": 3,
    "category_ids": [],
    "code": null,
    "collection_ids": [],
    "created_at": "2026-06-09T12:00:00+05:30",
    "customer_eligibility": "everyone",
    "customer_ids": [],
    "ends_at": null,
    "exclude_sale_items": false,
    "first_order_only": false,
    "gift_items": [],
    "gift_mode": null,
    "group_ids": [],
    "id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
    "market_id": "1c807b16-8a93-4f13-b998-1226c87d57ac",
    "max_discount": {},
    "min_quantity": null,
    "min_subtotal": {
      "USD": "50.00"
    },
    "name": "Buy two tees, get one free",
    "per_customer_limit": null,
    "priority": 10,
    "product_ids": [],
    "refund_restores_usage": false,
    "show_in_cart": false,
    "starts_at": null,
    "status": "active",
    "tier_value_kind": null,
    "tiers": [],
    "type": "buy_x_get_y",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "usage_limit": null,
    "value": null,
    "variant_ids": []
  }
}

Duty rule created

EVENT duty_rules/create App scope: read_markets Staff permission: markets:write

Fired when a country duty rule is created in a market.

Payload fields

Field	Type	Description
`duty_rule.id`	`string`	Always present
`duty_rule.market_id`	`string`	Selectable in the Payload builder
`duty_rule.country_code`	`string`	Selectable in the Payload builder
`duty_rule.de_minimis_value`	`string`	Selectable in the Payload builder Exact non-negative imported-merchandise threshold after discounts, expressed at the destination currency precision. Domestic goods are excluded; equality is not exempt.
`duty_rule.de_minimis_currency`	`string`	Selectable in the Payload builder Destination currency used by the threshold and specific/compound tariff coefficients.
`duty_rule.default_duty_rates`	`object`	Selectable in the Payload builder Origin-keyed rate maps. Percentages allow two decimals; per-unit/per-kg coefficients allow four, independently of currency minor units. Calculated duties settle at currency precision with reconciled line allocations.
`duty_rule.hs_rates`	`object`	Selectable in the Payload builder Origin-keyed rate maps. Percentages allow two decimals; per-unit/per-kg coefficients allow four, independently of currency minor units. Calculated duties settle at currency precision with reconciled line allocations.
`duty_rule.is_enabled`	`boolean`	Selectable in the Payload builder
`duty_rule.created_at`	`string`	Selectable in the Payload builder
`duty_rule.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "duty_rule": {
    "country_code": "IN",
    "created_at": "2026-07-01T10:15:00+05:30",
    "de_minimis_currency": "INR",
    "de_minimis_value": "1000.00",
    "default_duty_rates": {
      "*": {
        "rate": "10",
        "type": "ad_valorem"
      },
      "CN": {
        "amount": "20.00",
        "per": "unit",
        "rate": "5",
        "type": "compound"
      }
    },
    "hs_rates": {
      "CN": {
        "851713": {
          "amount": "25.00",
          "per": "unit",
          "type": "specific"
        }
      }
    },
    "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "is_enabled": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "updated_at": "2026-07-21T14:30:00+05:30"
  }
}

Duty rule deleted

EVENT duty_rules/delete App scope: read_markets Staff permission: markets:write

Fired when a country duty rule is deleted.

Payload fields

Field	Type	Description
`duty_rule.id`	`string`	Always present
`duty_rule.market_id`	`string`	Selectable in the Payload builder
`duty_rule.country_code`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "duty_rule": {
    "country_code": "IN",
    "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789"
  }
}

Duty rule updated

EVENT duty_rules/update App scope: read_markets Staff permission: markets:write

Fired when a country duty rule or its HS rates change.

Payload fields

Field	Type	Description
`duty_rule.id`	`string`	Always present
`duty_rule.market_id`	`string`	Selectable in the Payload builder
`duty_rule.country_code`	`string`	Selectable in the Payload builder
`duty_rule.de_minimis_value`	`string`	Selectable in the Payload builder Exact non-negative imported-merchandise threshold after discounts, expressed at the destination currency precision. Domestic goods are excluded; equality is not exempt.
`duty_rule.de_minimis_currency`	`string`	Selectable in the Payload builder Destination currency used by the threshold and specific/compound tariff coefficients.
`duty_rule.default_duty_rates`	`object`	Selectable in the Payload builder Origin-keyed rate maps. Percentages allow two decimals; per-unit/per-kg coefficients allow four, independently of currency minor units. Calculated duties settle at currency precision with reconciled line allocations.
`duty_rule.hs_rates`	`object`	Selectable in the Payload builder Origin-keyed rate maps. Percentages allow two decimals; per-unit/per-kg coefficients allow four, independently of currency minor units. Calculated duties settle at currency precision with reconciled line allocations.
`duty_rule.is_enabled`	`boolean`	Selectable in the Payload builder
`duty_rule.created_at`	`string`	Selectable in the Payload builder
`duty_rule.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "duty_rule": {
    "country_code": "IN",
    "created_at": "2026-07-01T10:15:00+05:30",
    "de_minimis_currency": "INR",
    "de_minimis_value": "1000.00",
    "default_duty_rates": {
      "*": {
        "rate": "10",
        "type": "ad_valorem"
      },
      "CN": {
        "amount": "20.00",
        "per": "unit",
        "rate": "5",
        "type": "compound"
      }
    },
    "hs_rates": {
      "CN": {
        "851713": {
          "amount": "25.00",
          "per": "unit",
          "type": "specific"
        }
      }
    },
    "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "is_enabled": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "updated_at": "2026-07-21T14:30:00+05:30"
  }
}

Market payment adjustment created

EVENT market_payment_adjustments/create App scope: read_markets Staff permission: markets:write

Fired when an online payment discount is created for a payment provider in a market.

Payload fields

Field	Type	Description
`payment_adjustment.id`	`string`	Always present The stable online payment discount id.
`payment_adjustment.market_id`	`string`	Always present The market the discount belongs to.
`payment_adjustment.binding_id`	`string`	Selectable in the Payload builder The payment provider the discount applies to.
`payment_adjustment.adjustment_kind`	`string`	Selectable in the Payload builder Always discount.
`payment_adjustment.value_type`	`string`	Selectable in the Payload builder percent or fixed.
`payment_adjustment.percent_value`	`string`	Selectable in the Payload builder The percentage as a decimal string, for percent discounts; absent for fixed discounts.
`payment_adjustment.fixed_amounts`	`object`	Selectable in the Payload builder Currency code to decimal-string amount, one per market currency, for fixed discounts; empty for percent discounts.
`payment_adjustment.label`	`string`	Selectable in the Payload builder Always "Online payment discount".
`payment_adjustment.is_enabled`	`boolean`	Selectable in the Payload builder Whether the discount applies at checkout.
`payment_adjustment.created_at`	`string`	Selectable in the Payload builder When the discount was created, as an RFC 3339 timestamp in the store's time zone.
`payment_adjustment.updated_at`	`string`	Selectable in the Payload builder When the discount last changed, as an RFC 3339 timestamp in the store's time zone.

Payload shape

Sample payload

{
  "payment_adjustment": {
    "adjustment_kind": "discount",
    "binding_id": "5b2e8d90-1234-4678-9abc-def012345678",
    "created_at": "2026-06-09T12:00:00+05:30",
    "fixed_amounts": {},
    "id": "6b2e8d90-1234-4678-9abc-def012345678",
    "is_enabled": true,
    "label": "Online payment discount",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "percent_value": "5",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value_type": "percent"
  }
}

Market payment adjustment deleted

EVENT market_payment_adjustments/delete App scope: read_markets Staff permission: markets:write

Fired when an online payment discount is deleted, including when its payment provider's app is uninstalled.

Payload fields

Field	Type	Description
`payment_adjustment.id`	`string`	Always present The stable online payment discount id.
`payment_adjustment.market_id`	`string`	Always present The market the discount belongs to.
`payment_adjustment.binding_id`	`string`	Selectable in the Payload builder The payment provider the discount applies to.
`payment_adjustment.adjustment_kind`	`string`	Selectable in the Payload builder Always discount.
`payment_adjustment.value_type`	`string`	Selectable in the Payload builder percent or fixed.
`payment_adjustment.percent_value`	`string`	Selectable in the Payload builder The percentage as a decimal string, for percent discounts; absent for fixed discounts.
`payment_adjustment.fixed_amounts`	`object`	Selectable in the Payload builder Currency code to decimal-string amount, one per market currency, for fixed discounts; empty for percent discounts.
`payment_adjustment.label`	`string`	Selectable in the Payload builder Always "Online payment discount".
`payment_adjustment.is_enabled`	`boolean`	Selectable in the Payload builder Whether the discount applies at checkout.
`payment_adjustment.created_at`	`string`	Selectable in the Payload builder When the discount was created, as an RFC 3339 timestamp in the store's time zone.
`payment_adjustment.updated_at`	`string`	Selectable in the Payload builder When the discount last changed, as an RFC 3339 timestamp in the store's time zone.

Payload shape

Sample payload

{
  "payment_adjustment": {
    "adjustment_kind": "discount",
    "binding_id": "5b2e8d90-1234-4678-9abc-def012345678",
    "created_at": "2026-06-09T12:00:00+05:30",
    "fixed_amounts": {},
    "id": "6b2e8d90-1234-4678-9abc-def012345678",
    "is_enabled": true,
    "label": "Online payment discount",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "percent_value": "5",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value_type": "percent"
  }
}

Market payment adjustment updated

EVENT market_payment_adjustments/update App scope: read_markets Staff permission: markets:write

Fired when an online payment discount changes. Saving unchanged values sends nothing.

Payload fields

Field	Type	Description
`payment_adjustment.id`	`string`	Always present The stable online payment discount id.
`payment_adjustment.market_id`	`string`	Always present The market the discount belongs to.
`payment_adjustment.binding_id`	`string`	Selectable in the Payload builder The payment provider the discount applies to.
`payment_adjustment.adjustment_kind`	`string`	Selectable in the Payload builder Always discount.
`payment_adjustment.value_type`	`string`	Selectable in the Payload builder percent or fixed.
`payment_adjustment.percent_value`	`string`	Selectable in the Payload builder The percentage as a decimal string, for percent discounts; absent for fixed discounts.
`payment_adjustment.fixed_amounts`	`object`	Selectable in the Payload builder Currency code to decimal-string amount, one per market currency, for fixed discounts; empty for percent discounts.
`payment_adjustment.label`	`string`	Selectable in the Payload builder Always "Online payment discount".
`payment_adjustment.is_enabled`	`boolean`	Selectable in the Payload builder Whether the discount applies at checkout.
`payment_adjustment.created_at`	`string`	Selectable in the Payload builder When the discount was created, as an RFC 3339 timestamp in the store's time zone.
`payment_adjustment.updated_at`	`string`	Selectable in the Payload builder When the discount last changed, as an RFC 3339 timestamp in the store's time zone.

Payload shape

Sample payload

{
  "payment_adjustment": {
    "adjustment_kind": "discount",
    "binding_id": "5b2e8d90-1234-4678-9abc-def012345678",
    "created_at": "2026-06-09T12:00:00+05:30",
    "fixed_amounts": {},
    "id": "6b2e8d90-1234-4678-9abc-def012345678",
    "is_enabled": true,
    "label": "Online payment discount",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "percent_value": "5",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value_type": "percent"
  }
}

Market payment provider updated

EVENT market_payment_providers/update App scope: read_markets Staff permission: markets:write

Fired when a payment provider is enabled, disabled, or reordered in a market, including when uninstalling its app switches it off. Saving unchanged values sends nothing.

Payload fields

Field	Type	Description
`payment_provider.binding_id`	`string`	Always present The connected payment provider (its service binding id).
`payment_provider.market_id`	`string`	Always present The market the assignment belongs to.
`payment_provider.app_id`	`string`	Selectable in the Payload builder The payment app that owns the binding.
`payment_provider.is_enabled`	`boolean`	Selectable in the Payload builder Whether checkout in this market offers the provider.
`payment_provider.sort_order`	`integer`	Selectable in the Payload builder Checkout display order; lower values appear first.
`payment_provider.updated_at`	`string`	Selectable in the Payload builder When the assignment changed, as an RFC 3339 timestamp in the store's time zone.

Payload shape

Sample payload

{
  "payment_provider": {
    "app_id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
    "binding_id": "5b2e8d90-1234-4678-9abc-def012345678",
    "is_enabled": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "sort_order": 1,
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Market created

EVENT markets/create App scope: read_markets Staff permission: markets:read

Subscribe to receive the complete market definition after a market is created.

Payload fields

Field	Type	Description
`market.id`	`string`	Always present The stable market id.
`market.name`	`string`	Selectable in the Payload builder The merchant-facing market name.
`market.slug`	`string`	Selectable in the Payload builder The market's URL-safe identifier.
`market.countries`	`array`	Selectable in the Payload builder ISO 3166-1 alpha-2 codes for the countries served by the market.
`market.currencies`	`array`	Selectable in the Payload builder ISO 4217 codes for currencies assigned to the market.
`market.country_currencies[*].country_code`	`string`	Selectable in the Payload builder A country served by the market.
`market.country_currencies[*].currency_code`	`string`	Selectable in the Payload builder The currency selected for that country.
`market.is_primary`	`boolean`	Selectable in the Payload builder Whether this is the store's primary market.
`market.is_active`	`boolean`	Selectable in the Payload builder Whether the market can serve customers.
`market.tax_enabled`	`boolean`	Selectable in the Payload builder Whether tax is calculated for orders in this market.
`market.tax_included`	`boolean`	Selectable in the Payload builder Whether catalog prices already include tax.
`market.tax_display_mode`	`string`	Selectable in the Payload builder Whether storefront prices are shown with tax included or excluded.
`market.tax_basis`	`string`	Selectable in the Payload builder Whether shipping or billing address determines tax.
`market.duties_enabled`	`boolean`	Selectable in the Payload builder Whether duty calculation is enabled for the market.
`market.duty_collection_mode`	`string`	Selectable in the Payload builder Whether duties are collected at checkout or paid on delivery.
`market.use_default_tax_class`	`boolean`	Selectable in the Payload builder Whether products without a tax class use the market's default class.
`market.revision`	`integer`	Selectable in the Payload builder Increases with every change to the market. Ignore an event whose revision is lower than one you have already applied.
`market.created_at`	`string`	Selectable in the Payload builder When the market was created, as an RFC 3339 timestamp in the store's time zone.
`market.updated_at`	`string`	Selectable in the Payload builder When the market last changed, as an RFC 3339 timestamp in the store's time zone.

Payload shape

Sample payload

{
  "market": {
    "countries": [
      "US"
    ],
    "country_currencies": [
      {
        "country_code": "US",
        "currency_code": "USD"
      }
    ],
    "created_at": "2026-06-09T12:00:00+05:30",
    "currencies": [
      "USD"
    ],
    "duties_enabled": false,
    "duty_collection_mode": "pay_on_delivery",
    "id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "is_active": true,
    "is_primary": true,
    "name": "United States",
    "revision": 4,
    "slug": "united-states",
    "tax_basis": "shipping",
    "tax_display_mode": "exclusive",
    "tax_enabled": true,
    "tax_included": false,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "use_default_tax_class": true
  }
}

Market deleted

EVENT markets/delete App scope: read_markets Staff permission: markets:read

Subscribe to remove a deleted market from your integration. The payload keeps its id and last known name. The market's payment provider assignments and online payment discounts are removed with it, without separate events.

Payload fields

Field	Type	Description
`id`	`string`	Always present The stable id of the deleted market.
`name`	`string`	Selectable in the Payload builder The market name at the time it was deleted.

Payload shape

Sample payload

{
  "id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
  "name": "United States"
}

Market updated

EVENT markets/update App scope: read_markets Staff permission: markets:read

Subscribe to receive the current market definition after its name, slug, countries, currencies, country-currency selections, active state, tax settings, or duty settings change. Saving unchanged values sends nothing; use revision to ignore an event older than one you have applied.

Payload fields

Field	Type	Description
`market.id`	`string`	Always present The stable market id.
`market.name`	`string`	Selectable in the Payload builder The merchant-facing market name.
`market.slug`	`string`	Selectable in the Payload builder The market's URL-safe identifier.
`market.countries`	`array`	Selectable in the Payload builder ISO 3166-1 alpha-2 codes for the countries served by the market.
`market.currencies`	`array`	Selectable in the Payload builder ISO 4217 codes for currencies assigned to the market.
`market.country_currencies[*].country_code`	`string`	Selectable in the Payload builder A country served by the market.
`market.country_currencies[*].currency_code`	`string`	Selectable in the Payload builder The currency selected for that country.
`market.is_primary`	`boolean`	Selectable in the Payload builder Whether this is the store's primary market.
`market.is_active`	`boolean`	Selectable in the Payload builder Whether the market can serve customers.
`market.tax_enabled`	`boolean`	Selectable in the Payload builder Whether tax is calculated for orders in this market.
`market.tax_included`	`boolean`	Selectable in the Payload builder Whether catalog prices already include tax.
`market.tax_display_mode`	`string`	Selectable in the Payload builder Whether storefront prices are shown with tax included or excluded.
`market.tax_basis`	`string`	Selectable in the Payload builder Whether shipping or billing address determines tax.
`market.duties_enabled`	`boolean`	Selectable in the Payload builder Whether duty calculation is enabled for the market.
`market.duty_collection_mode`	`string`	Selectable in the Payload builder Whether duties are collected at checkout or paid on delivery.
`market.use_default_tax_class`	`boolean`	Selectable in the Payload builder Whether products without a tax class use the market's default class.
`market.revision`	`integer`	Selectable in the Payload builder Increases with every change to the market. Ignore an event whose revision is lower than one you have already applied.
`market.created_at`	`string`	Selectable in the Payload builder When the market was created, as an RFC 3339 timestamp in the store's time zone.
`market.updated_at`	`string`	Selectable in the Payload builder When the market last changed, as an RFC 3339 timestamp in the store's time zone.

Payload shape

Sample payload

{
  "market": {
    "countries": [
      "US"
    ],
    "country_currencies": [
      {
        "country_code": "US",
        "currency_code": "USD"
      }
    ],
    "created_at": "2026-06-09T12:00:00+05:30",
    "currencies": [
      "USD"
    ],
    "duties_enabled": false,
    "duty_collection_mode": "pay_on_delivery",
    "id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "is_active": true,
    "is_primary": true,
    "name": "United States",
    "revision": 4,
    "slug": "united-states",
    "tax_basis": "shipping",
    "tax_display_mode": "exclusive",
    "tax_enabled": true,
    "tax_included": false,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "use_default_tax_class": true
  }
}

Shipping method created

EVENT shipping_methods/create App scope: read_markets Staff permission: markets:write

Fired when a shipping method and its rates are created.

Payload fields

Field	Type	Description
`shipping_method.id`	`string`	Always present
`shipping_method.market_id`	`string`	Selectable in the Payload builder
`shipping_method.shipping_zone_id`	`string`	Selectable in the Payload builder
`shipping_method.name`	`string`	Selectable in the Payload builder
`shipping_method.description`	`string`	Selectable in the Payload builder
`shipping_method.tax_class_id`	`string`	Selectable in the Payload builder
`shipping_method.hsn_code`	`string`	Selectable in the Payload builder
`shipping_method.rate_type`	`string`	Selectable in the Payload builder free, flat, weight, price, item (one charge for the matching quantity tier), or per_item (unit charge multiplied by shippable quantity before currency conversion and rounding).
`shipping_method.weight_unit`	`string`	Selectable in the Payload builder Saved weight-tier unit: g, kg, lb, or oz. Bounds use this unit. Other rate types ignore it.
`shipping_method.is_active`	`boolean`	Selectable in the Payload builder
`shipping_method.sort_order`	`integer`	Selectable in the Payload builder
`shipping_method.rates[*].id`	`string`	Selectable in the Payload builder
`shipping_method.rates[*].min_value`	`string`	Selectable in the Payload builder Inclusive minimum and exclusive maximum. Weight bounds use the saved weight_unit; item bounds use shippable quantity. per_item uses one row beginning at zero with no upper bound. An absent maximum means unbounded.
`shipping_method.rates[*].max_value`	`string`	Selectable in the Payload builder Inclusive minimum and exclusive maximum. Weight bounds use the saved weight_unit; item bounds use shippable quantity. per_item uses one row beginning at zero with no upper bound. An absent maximum means unbounded.
`shipping_method.rates[*].min_values`	`object`	Selectable in the Payload builder
`shipping_method.rates[*].max_values`	`object`	Selectable in the Payload builder
`shipping_method.rates[*].prices`	`object`	Selectable in the Payload builder Exact-decimal currency map. For per_item these are per-unit charges; for tier methods these are complete shipping charges. Missing currency overrides use base-currency conversion.
`shipping_method.created_at`	`string`	Selectable in the Payload builder
`shipping_method.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "shipping_method": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "...",
    "hsn_code": "...",
    "id": "d36ec624-7128-4d79-88be-90254c265ac4",
    "is_active": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "Weight-based delivery",
    "rate_type": "weight",
    "rates": [
      {
        "id": "ec15af06-a743-4a02-9923-e2e34573b376",
        "max_value": "2",
        "min_value": "0",
        "prices": {
          "EUR": "5.00"
        }
      },
      {
        "id": "f8eea159-9471-40a5-9c2b-c5829df9b663",
        "min_value": "2",
        "prices": {
          "EUR": "10.00"
        }
      }
    ],
    "shipping_zone_id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "sort_order": 0,
    "tax_class_id": null,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "weight_unit": "kg"
  }
}

Shipping method deleted

EVENT shipping_methods/delete App scope: read_markets Staff permission: markets:write

Fired when a shipping method is deleted.

Payload fields

Field	Type	Description
`shipping_method.id`	`string`	Always present
`shipping_method.market_id`	`string`	Selectable in the Payload builder
`shipping_method.name`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "shipping_method": {
    "id": "...",
    "market_id": "...",
    "name": "..."
  }
}

Shipping method updated

EVENT shipping_methods/update App scope: read_markets Staff permission: markets:write

Fired when a shipping method or its rates change.

Payload fields

Field	Type	Description
`shipping_method.id`	`string`	Always present
`shipping_method.market_id`	`string`	Selectable in the Payload builder
`shipping_method.shipping_zone_id`	`string`	Selectable in the Payload builder
`shipping_method.name`	`string`	Selectable in the Payload builder
`shipping_method.description`	`string`	Selectable in the Payload builder
`shipping_method.tax_class_id`	`string`	Selectable in the Payload builder
`shipping_method.hsn_code`	`string`	Selectable in the Payload builder
`shipping_method.rate_type`	`string`	Selectable in the Payload builder free, flat, weight, price, item (one charge for the matching quantity tier), or per_item (unit charge multiplied by shippable quantity before currency conversion and rounding).
`shipping_method.weight_unit`	`string`	Selectable in the Payload builder Saved weight-tier unit: g, kg, lb, or oz. Bounds use this unit. Other rate types ignore it.
`shipping_method.is_active`	`boolean`	Selectable in the Payload builder
`shipping_method.sort_order`	`integer`	Selectable in the Payload builder
`shipping_method.rates[*].id`	`string`	Selectable in the Payload builder
`shipping_method.rates[*].min_value`	`string`	Selectable in the Payload builder Inclusive minimum and exclusive maximum. Weight bounds use the saved weight_unit; item bounds use shippable quantity. per_item uses one row beginning at zero with no upper bound. An absent maximum means unbounded.
`shipping_method.rates[*].max_value`	`string`	Selectable in the Payload builder Inclusive minimum and exclusive maximum. Weight bounds use the saved weight_unit; item bounds use shippable quantity. per_item uses one row beginning at zero with no upper bound. An absent maximum means unbounded.
`shipping_method.rates[*].min_values`	`object`	Selectable in the Payload builder
`shipping_method.rates[*].max_values`	`object`	Selectable in the Payload builder
`shipping_method.rates[*].prices`	`object`	Selectable in the Payload builder Exact-decimal currency map. For per_item these are per-unit charges; for tier methods these are complete shipping charges. Missing currency overrides use base-currency conversion.
`shipping_method.created_at`	`string`	Selectable in the Payload builder
`shipping_method.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "shipping_method": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "...",
    "hsn_code": "...",
    "id": "d36ec624-7128-4d79-88be-90254c265ac4",
    "is_active": true,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "Weight-based delivery",
    "rate_type": "weight",
    "rates": [
      {
        "id": "ec15af06-a743-4a02-9923-e2e34573b376",
        "max_value": "2",
        "min_value": "0",
        "prices": {
          "EUR": "5.00"
        }
      },
      {
        "id": "f8eea159-9471-40a5-9c2b-c5829df9b663",
        "min_value": "2",
        "prices": {
          "EUR": "10.00"
        }
      }
    ],
    "shipping_zone_id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "sort_order": 0,
    "tax_class_id": null,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "weight_unit": "kg"
  }
}

Shipping settings updated

EVENT shipping_settings/update App scope: read_markets Staff permission: markets:write

Fired when a market's shipping mode or simple shipping settings change.

Payload fields

Field	Type	Description
`shipping_settings.id`	`string`	Always present
`shipping_settings.market_id`	`string`	Selectable in the Payload builder
`shipping_settings.mode`	`string`	Selectable in the Payload builder
`shipping_settings.shipping_type`	`string`	Selectable in the Payload builder
`shipping_settings.flat_rate`	`object`	Selectable in the Payload builder
`shipping_settings.free_threshold`	`object`	Selectable in the Payload builder
`shipping_settings.threshold_rate`	`object`	Selectable in the Payload builder
`shipping_settings.tax_class_id`	`string`	Selectable in the Payload builder
`shipping_settings.hsn_code`	`string`	Selectable in the Payload builder
`shipping_settings.created_at`	`string`	Selectable in the Payload builder
`shipping_settings.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "shipping_settings": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "flat_rate": "...",
    "free_threshold": "...",
    "hsn_code": "...",
    "id": "...",
    "market_id": "...",
    "mode": "...",
    "shipping_type": "...",
    "tax_class_id": null,
    "threshold_rate": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Shipping zone created

EVENT shipping_zones/create App scope: read_markets Staff permission: markets:write

Fired when a shipping zone is created in a market.

Payload fields

Field	Type	Description
`shipping_zone.id`	`string`	Always present
`shipping_zone.market_id`	`string`	Selectable in the Payload builder
`shipping_zone.name`	`string`	Selectable in the Payload builder
`shipping_zone.description`	`string`	Selectable in the Payload builder
`shipping_zone.countries`	`array`	Selectable in the Payload builder
`shipping_zone.subdivisions`	`array`	Selectable in the Payload builder
`shipping_zone.is_default`	`boolean`	Selectable in the Payload builder
`shipping_zone.priority`	`integer`	Selectable in the Payload builder
`shipping_zone.created_at`	`string`	Selectable in the Payload builder
`shipping_zone.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "shipping_zone": {
    "countries": [],
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "...",
    "id": "...",
    "is_default": false,
    "market_id": "...",
    "name": "...",
    "priority": 0,
    "subdivisions": [],
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Shipping zone deleted

EVENT shipping_zones/delete App scope: read_markets Staff permission: markets:write

Fired when a shipping zone is deleted.

Payload fields

Field	Type	Description
`shipping_zone.id`	`string`	Always present
`shipping_zone.market_id`	`string`	Selectable in the Payload builder
`shipping_zone.name`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "shipping_zone": {
    "id": "...",
    "market_id": "...",
    "name": "..."
  }
}

Shipping zone updated

EVENT shipping_zones/update App scope: read_markets Staff permission: markets:write

Fired when a shipping zone changes.

Payload fields

Field	Type	Description
`shipping_zone.id`	`string`	Always present
`shipping_zone.market_id`	`string`	Selectable in the Payload builder
`shipping_zone.name`	`string`	Selectable in the Payload builder
`shipping_zone.description`	`string`	Selectable in the Payload builder
`shipping_zone.countries`	`array`	Selectable in the Payload builder
`shipping_zone.subdivisions`	`array`	Selectable in the Payload builder
`shipping_zone.is_default`	`boolean`	Selectable in the Payload builder
`shipping_zone.priority`	`integer`	Selectable in the Payload builder
`shipping_zone.created_at`	`string`	Selectable in the Payload builder
`shipping_zone.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "shipping_zone": {
    "countries": [],
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "...",
    "id": "...",
    "is_default": false,
    "market_id": "...",
    "name": "...",
    "priority": 0,
    "subdivisions": [],
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Tax class created

EVENT tax_classes/create App scope: read_markets Staff permission: markets:write

Subscribe to receive the saved tax class after it is created in a market.

Payload fields

Field	Type	Description
`tax_class.id`	`string`	Always present The stable tax class id.
`tax_class.market_id`	`string`	Selectable in the Payload builder The market where the tax class is available.
`tax_class.name`	`string`	Selectable in the Payload builder The merchant-facing tax class name.
`tax_class.slug`	`string`	Selectable in the Payload builder The tax class's URL-safe identifier within the market.
`tax_class.description`	`string`	Selectable in the Payload builder The optional explanation of which products use this class.
`tax_class.is_default`	`boolean`	Selectable in the Payload builder Whether products without an explicit assignment use this class.
`tax_class.created_at`	`string`	Selectable in the Payload builder When the tax class was created.
`tax_class.updated_at`	`string`	Selectable in the Payload builder When the tax class last changed.

Payload shape

Sample payload

{
  "tax_class": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Books and qualifying essentials",
    "id": "4e2b8c1a-7f3d-4a5b-9c6d-1e0f2a3b4c5d",
    "is_default": false,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "Reduced rate",
    "slug": "reduced-rate",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Tax class deleted

EVENT tax_classes/delete App scope: read_markets Staff permission: markets:write

Subscribe to remove a deleted tax class from your integration. The payload keeps its id, market id, last known name, and slug.

Payload fields

Field	Type	Description
`tax_class.id`	`string`	Always present The stable tax class id.
`tax_class.market_id`	`string`	Selectable in the Payload builder The market where the tax class is available.
`tax_class.name`	`string`	Selectable in the Payload builder The merchant-facing tax class name.
`tax_class.slug`	`string`	Selectable in the Payload builder The tax class's URL-safe identifier within the market.

Payload shape

Sample payload

{
  "tax_class": {
    "id": "4e2b8c1a-7f3d-4a5b-9c6d-1e0f2a3b4c5d",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "Reduced rate",
    "slug": "reduced-rate"
  }
}

Tax class updated

EVENT tax_classes/update App scope: read_markets Staff permission: markets:write

Subscribe to receive the current tax class after its name, slug, description, or default status changes.

Payload fields

Field	Type	Description
`tax_class.id`	`string`	Always present The stable tax class id.
`tax_class.market_id`	`string`	Selectable in the Payload builder The market where the tax class is available.
`tax_class.name`	`string`	Selectable in the Payload builder The merchant-facing tax class name.
`tax_class.slug`	`string`	Selectable in the Payload builder The tax class's URL-safe identifier within the market.
`tax_class.description`	`string`	Selectable in the Payload builder The optional explanation of which products use this class.
`tax_class.is_default`	`boolean`	Selectable in the Payload builder Whether products without an explicit assignment use this class.
`tax_class.created_at`	`string`	Selectable in the Payload builder When the tax class was created.
`tax_class.updated_at`	`string`	Selectable in the Payload builder When the tax class last changed.

Payload shape

Sample payload

{
  "tax_class": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Books and qualifying essentials",
    "id": "4e2b8c1a-7f3d-4a5b-9c6d-1e0f2a3b4c5d",
    "is_default": false,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "Reduced rate",
    "slug": "reduced-rate",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Price-based tax rule created

EVENT tax_price_rules/create App scope: read_markets Staff permission: markets:write

Subscribe to receive a price-based tax rule after it is created for a market's tax class.

Payload fields

Field	Type	Description
`tax_price_rule.id`	`string`	Always present The stable price-based tax rule id.
`tax_price_rule.market_id`	`string`	Selectable in the Payload builder The single-country, single-currency market where the rule applies.
`tax_price_rule.tax_class_id`	`string`	Selectable in the Payload builder The tax class whose ordinary rate is replaced by this threshold rule.
`tax_price_rule.threshold_price`	`string`	Selectable in the Payload builder The final unit-price threshold as a decimal string in the market currency.
`tax_price_rule.below_rate`	`string`	Selectable in the Payload builder The percentage used below the threshold, as a decimal string.
`tax_price_rule.above_rate`	`string`	Selectable in the Payload builder The percentage used at or above the threshold, as a decimal string.
`tax_price_rule.market_name`	`string`	Selectable in the Payload builder The current market name.
`tax_price_rule.tax_class_name`	`string`	Selectable in the Payload builder The current tax class name.
`tax_price_rule.currency_code`	`string`	Selectable in the Payload builder The ISO 4217 currency used by the threshold.
`tax_price_rule.created_at`	`string`	Selectable in the Payload builder When the rule was created.
`tax_price_rule.updated_at`	`string`	Selectable in the Payload builder When the rule last changed.

Payload shape

Sample payload

{
  "tax_price_rule": {
    "above_rate": "12.00",
    "below_rate": "5.00",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "INR",
    "id": "6d1f3a4b-5c7e-4890-9a2b-3c4d5e6f7081",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "market_name": "India",
    "tax_class_id": "4e2b8c1a-7f3d-4a5b-9c6d-1e0f2a3b4c5d",
    "tax_class_name": "Footwear",
    "threshold_price": "1000.00",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Price-based tax rule deleted

EVENT tax_price_rules/delete App scope: read_markets Staff permission: markets:write

Subscribe to remove a deleted price-based tax rule from your integration. The payload keeps its rule, market, and tax class ids.

Payload fields

Field	Type	Description
`tax_price_rule.id`	`string`	Always present The stable price-based tax rule id.
`tax_price_rule.market_id`	`string`	Selectable in the Payload builder The single-country, single-currency market where the rule applies.
`tax_price_rule.tax_class_id`	`string`	Selectable in the Payload builder The tax class whose ordinary rate is replaced by this threshold rule.

Payload shape

Sample payload

{
  "tax_price_rule": {
    "id": "6d1f3a4b-5c7e-4890-9a2b-3c4d5e6f7081",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "tax_class_id": "4e2b8c1a-7f3d-4a5b-9c6d-1e0f2a3b4c5d"
  }
}

Price-based tax rule updated

EVENT tax_price_rules/update App scope: read_markets Staff permission: markets:write

Subscribe to receive the current price-based tax rule after its threshold or below-and-above rates change.

Payload fields

Field	Type	Description
`tax_price_rule.id`	`string`	Always present The stable price-based tax rule id.
`tax_price_rule.market_id`	`string`	Selectable in the Payload builder The single-country, single-currency market where the rule applies.
`tax_price_rule.tax_class_id`	`string`	Selectable in the Payload builder The tax class whose ordinary rate is replaced by this threshold rule.
`tax_price_rule.threshold_price`	`string`	Selectable in the Payload builder The final unit-price threshold as a decimal string in the market currency.
`tax_price_rule.below_rate`	`string`	Selectable in the Payload builder The percentage used below the threshold, as a decimal string.
`tax_price_rule.above_rate`	`string`	Selectable in the Payload builder The percentage used at or above the threshold, as a decimal string.
`tax_price_rule.market_name`	`string`	Selectable in the Payload builder The current market name.
`tax_price_rule.tax_class_name`	`string`	Selectable in the Payload builder The current tax class name.
`tax_price_rule.currency_code`	`string`	Selectable in the Payload builder The ISO 4217 currency used by the threshold.
`tax_price_rule.created_at`	`string`	Selectable in the Payload builder When the rule was created.
`tax_price_rule.updated_at`	`string`	Selectable in the Payload builder When the rule last changed.

Payload shape

Sample payload

{
  "tax_price_rule": {
    "above_rate": "12.00",
    "below_rate": "5.00",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "INR",
    "id": "6d1f3a4b-5c7e-4890-9a2b-3c4d5e6f7081",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "market_name": "India",
    "tax_class_id": "4e2b8c1a-7f3d-4a5b-9c6d-1e0f2a3b4c5d",
    "tax_class_name": "Footwear",
    "threshold_price": "1000.00",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Tax rate created

EVENT tax_rates/create App scope: read_markets Staff permission: markets:write

Subscribe to receive a tax rate line after it is created at a market's zone-and-class coordinate.

Payload fields

Field	Type	Description
`tax_rate.id`	`string`	Always present The stable tax rate line id.
`tax_rate.market_id`	`string`	Selectable in the Payload builder The market where the rate line is evaluated.
`tax_rate.tax_zone_id`	`string`	Selectable in the Payload builder The tax zone half of this rate coordinate.
`tax_rate.tax_class_id`	`string`	Selectable in the Payload builder The tax class half of this rate coordinate.
`tax_rate.name`	`string`	Selectable in the Payload builder The internal rate-line name, unique within its zone-and-class coordinate.
`tax_rate.display_name`	`string`	Selectable in the Payload builder The rate-line name shown to customers on orders and invoices.
`tax_rate.rate`	`string`	Selectable in the Payload builder The percentage rate as a decimal string.
`tax_rate.compound_mode`	`string`	Selectable in the Payload builder Whether the line uses the taxable amount or the taxable amount plus the added-tax total.
`tax_rate.tax_zone_name`	`string`	Selectable in the Payload builder The current name of the related tax zone.
`tax_rate.tax_class_name`	`string`	Selectable in the Payload builder The current name of the related tax class.
`tax_rate.created_at`	`string`	Selectable in the Payload builder When the rate line was created.
`tax_rate.updated_at`	`string`	Selectable in the Payload builder When the rate line last changed.

Payload shape

Sample payload

{
  "tax_rate": {
    "compound_mode": "added_to",
    "created_at": "2026-06-09T12:00:00+05:30",
    "display_name": "State tax 9%",
    "id": "3f8c2d1e-9a4b-4c5d-8e6f-0a1b2c3d4e5f",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "State tax",
    "rate": "9.00",
    "tax_class_id": "4e2b8c1a-7f3d-4a5b-9c6d-1e0f2a3b4c5d",
    "tax_class_name": "Reduced rate",
    "tax_zone_id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "tax_zone_name": "California",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Tax rate deleted

EVENT tax_rates/delete App scope: read_markets Staff permission: markets:write

Subscribe to remove a deleted tax rate line from your integration. The payload keeps the ids and last known name needed to identify it.

Payload fields

Field	Type	Description
`tax_rate.id`	`string`	Always present The stable tax rate line id.
`tax_rate.market_id`	`string`	Selectable in the Payload builder The market where the rate line is evaluated.
`tax_rate.tax_zone_id`	`string`	Selectable in the Payload builder The tax zone half of this rate coordinate.
`tax_rate.tax_class_id`	`string`	Selectable in the Payload builder The tax class half of this rate coordinate.
`tax_rate.name`	`string`	Selectable in the Payload builder The internal rate-line name, unique within its zone-and-class coordinate.

Payload shape

Sample payload

{
  "tax_rate": {
    "id": "3f8c2d1e-9a4b-4c5d-8e6f-0a1b2c3d4e5f",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "State tax",
    "tax_class_id": "4e2b8c1a-7f3d-4a5b-9c6d-1e0f2a3b4c5d",
    "tax_zone_id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c"
  }
}

Tax rate updated

EVENT tax_rates/update App scope: read_markets Staff permission: markets:write

Subscribe to receive the current tax rate line after its name, display name, rate, compound mode, or tax class changes.

Payload fields

Field	Type	Description
`tax_rate.id`	`string`	Always present The stable tax rate line id.
`tax_rate.market_id`	`string`	Selectable in the Payload builder The market where the rate line is evaluated.
`tax_rate.tax_zone_id`	`string`	Selectable in the Payload builder The tax zone half of this rate coordinate.
`tax_rate.tax_class_id`	`string`	Selectable in the Payload builder The tax class half of this rate coordinate.
`tax_rate.name`	`string`	Selectable in the Payload builder The internal rate-line name, unique within its zone-and-class coordinate.
`tax_rate.display_name`	`string`	Selectable in the Payload builder The rate-line name shown to customers on orders and invoices.
`tax_rate.rate`	`string`	Selectable in the Payload builder The percentage rate as a decimal string.
`tax_rate.compound_mode`	`string`	Selectable in the Payload builder Whether the line uses the taxable amount or the taxable amount plus the added-tax total.
`tax_rate.tax_zone_name`	`string`	Selectable in the Payload builder The current name of the related tax zone.
`tax_rate.tax_class_name`	`string`	Selectable in the Payload builder The current name of the related tax class.
`tax_rate.created_at`	`string`	Selectable in the Payload builder When the rate line was created.
`tax_rate.updated_at`	`string`	Selectable in the Payload builder When the rate line last changed.

Payload shape

Sample payload

{
  "tax_rate": {
    "compound_mode": "added_to",
    "created_at": "2026-06-09T12:00:00+05:30",
    "display_name": "State tax 9%",
    "id": "3f8c2d1e-9a4b-4c5d-8e6f-0a1b2c3d4e5f",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "State tax",
    "rate": "9.00",
    "tax_class_id": "4e2b8c1a-7f3d-4a5b-9c6d-1e0f2a3b4c5d",
    "tax_class_name": "Reduced rate",
    "tax_zone_id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "tax_zone_name": "California",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Tax zone created

EVENT tax_zones/create App scope: read_markets Staff permission: markets:write

Subscribe to receive the saved tax zone after it is created in a market.

Payload fields

Field	Type	Description
`tax_zone.id`	`string`	Always present The stable tax zone id.
`tax_zone.market_id`	`string`	Selectable in the Payload builder The market where this zone is matched.
`tax_zone.name`	`string`	Selectable in the Payload builder The merchant-facing tax zone name.
`tax_zone.description`	`string`	Selectable in the Payload builder The optional explanation of the jurisdiction this zone covers.
`tax_zone.countries`	`array`	Selectable in the Payload builder ISO 3166-1 alpha-2 country codes claimed by the zone.
`tax_zone.subdivisions`	`array`	Selectable in the Payload builder Canonical country-subdivision codes claimed by the zone.
`tax_zone.is_default`	`boolean`	Selectable in the Payload builder Whether this zone catches addresses not matched by a more specific zone.
`tax_zone.priority`	`integer`	Selectable in the Payload builder The order in which the zone was created, assigned by Tringify (newer zones are higher). Zones never overlap, so it does not change which zone an address matches.
`tax_zone.tax_exemption.enabled`	`boolean`	Selectable in the Payload builder Whether this zone's business tax treatment is on.
`tax_zone.tax_exemption.type`	`string`	Selectable in the Payload builder The exemption configuration type used by this zone.
`tax_zone.tax_exemption.effect`	`string`	Selectable in the Payload builder The business tax treatment: exempt removes tax for a buyer verified as tax exempt; invoice_only keeps tax and marks the order for a business invoice for such a buyer or any buyer who enters a tax ID.
`tax_zone.tax_exemption.checkout_text`	`string`	Selectable in the Payload builder The customer-facing guidance shown when exemption details are requested.
`tax_zone.tax_exemption.custom_label`	`string`	Selectable in the Payload builder The custom customer-facing label for the exemption field.
`tax_zone.tax_exemption.custom_placeholder`	`string`	Selectable in the Payload builder The custom placeholder shown in the exemption field.
`tax_zone.created_at`	`string`	Selectable in the Payload builder When the tax zone was created.
`tax_zone.updated_at`	`string`	Selectable in the Payload builder When the tax zone last changed.

Payload shape

Sample payload

{
  "tax_zone": {
    "countries": [
      "US"
    ],
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "California shipping addresses",
    "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "is_default": false,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "California",
    "priority": 10,
    "subdivisions": [
      "US-CA"
    ],
    "tax_exemption": {
      "checkout_text": "Enter the tax exemption details shown on your certificate.",
      "custom_label": "Exemption certificate number",
      "custom_placeholder": "CA-EXEMPT-1042",
      "effect": "exempt",
      "enabled": true,
      "type": "custom"
    },
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Tax zone deleted

EVENT tax_zones/delete App scope: read_markets Staff permission: markets:write

Subscribe to remove a deleted tax zone from your integration. Its rate lines are removed with it without separate tax_rates/delete events, so use the zone id to refresh affected rates.

Payload fields

Field	Type	Description
`tax_zone.id`	`string`	Always present The stable tax zone id.
`tax_zone.market_id`	`string`	Selectable in the Payload builder The market where this zone is matched.
`tax_zone.name`	`string`	Selectable in the Payload builder The merchant-facing tax zone name.

Payload shape

Sample payload

{
  "tax_zone": {
    "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "California"
  }
}

Tax zone updated

EVENT tax_zones/update App scope: read_markets Staff permission: markets:write

Subscribe to receive the current tax zone after its geography, priority, default status, or exemption settings change.

Payload fields

Field	Type	Description
`tax_zone.id`	`string`	Always present The stable tax zone id.
`tax_zone.market_id`	`string`	Selectable in the Payload builder The market where this zone is matched.
`tax_zone.name`	`string`	Selectable in the Payload builder The merchant-facing tax zone name.
`tax_zone.description`	`string`	Selectable in the Payload builder The optional explanation of the jurisdiction this zone covers.
`tax_zone.countries`	`array`	Selectable in the Payload builder ISO 3166-1 alpha-2 country codes claimed by the zone.
`tax_zone.subdivisions`	`array`	Selectable in the Payload builder Canonical country-subdivision codes claimed by the zone.
`tax_zone.is_default`	`boolean`	Selectable in the Payload builder Whether this zone catches addresses not matched by a more specific zone.
`tax_zone.priority`	`integer`	Selectable in the Payload builder The order in which the zone was created, assigned by Tringify (newer zones are higher). Zones never overlap, so it does not change which zone an address matches.
`tax_zone.tax_exemption.enabled`	`boolean`	Selectable in the Payload builder Whether this zone's business tax treatment is on.
`tax_zone.tax_exemption.type`	`string`	Selectable in the Payload builder The exemption configuration type used by this zone.
`tax_zone.tax_exemption.effect`	`string`	Selectable in the Payload builder The business tax treatment: exempt removes tax for a buyer verified as tax exempt; invoice_only keeps tax and marks the order for a business invoice for such a buyer or any buyer who enters a tax ID.
`tax_zone.tax_exemption.checkout_text`	`string`	Selectable in the Payload builder The customer-facing guidance shown when exemption details are requested.
`tax_zone.tax_exemption.custom_label`	`string`	Selectable in the Payload builder The custom customer-facing label for the exemption field.
`tax_zone.tax_exemption.custom_placeholder`	`string`	Selectable in the Payload builder The custom placeholder shown in the exemption field.
`tax_zone.created_at`	`string`	Selectable in the Payload builder When the tax zone was created.
`tax_zone.updated_at`	`string`	Selectable in the Payload builder When the tax zone last changed.

Payload shape

Sample payload

{
  "tax_zone": {
    "countries": [
      "US"
    ],
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "California shipping addresses",
    "id": "7c9e4f2b-1a3d-4e5f-8b6c-2d0e1f3a4b5c",
    "is_default": false,
    "market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "name": "California",
    "priority": 10,
    "subdivisions": [
      "US-CA"
    ],
    "tax_exemption": {
      "checkout_text": "Enter the tax exemption details shown on your certificate.",
      "custom_label": "Exemption certificate number",
      "custom_placeholder": "CA-EXEMPT-1042",
      "effect": "exempt",
      "enabled": true,
      "type": "custom"
    },
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Menu item translations deleted

EVENT menu_items/translations/delete App scope: read_menus Staff permission: menus:write

Fired when a menu item's title translation is cleared for a locale.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Selectable in the Payload builder
`menu.handle`	`string`	Selectable in the Payload builder
`menu_item.id`	`string`	Always present
`menu_item.menu_id`	`string`	Selectable in the Payload builder
`menu_item.parent_id`	`string`	Selectable in the Payload builder
`menu_item.title`	`string`	Selectable in the Payload builder
`menu_item.link_type`	`string`	Selectable in the Payload builder
`menu_item.link_value`	`string`	Selectable in the Payload builder
`menu_item.link_label`	`string`	Selectable in the Payload builder
`menu_item.open_in_new_tab`	`boolean`	Selectable in the Payload builder
`menu_item.sort_order`	`integer`	Selectable in the Payload builder
`menu_item.created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "menu": {
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "name": "Main menu"
  },
  "menu_item": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
    "link_label": "Apparel",
    "link_type": "category",
    "link_value": "7",
    "menu_id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "open_in_new_tab": false,
    "parent_id": null,
    "sort_order": 0,
    "title": "Shop"
  },
  "translation": {
    "title": "Shop"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Menu item translations updated

EVENT menu_items/translations/update App scope: read_menus Staff permission: menus:write

Fired when a menu item's title translation is added or updated for a locale.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Selectable in the Payload builder
`menu.handle`	`string`	Selectable in the Payload builder
`menu_item.id`	`string`	Always present
`menu_item.menu_id`	`string`	Selectable in the Payload builder
`menu_item.parent_id`	`string`	Selectable in the Payload builder
`menu_item.title`	`string`	Selectable in the Payload builder
`menu_item.link_type`	`string`	Selectable in the Payload builder
`menu_item.link_value`	`string`	Selectable in the Payload builder
`menu_item.link_label`	`string`	Selectable in the Payload builder
`menu_item.open_in_new_tab`	`boolean`	Selectable in the Payload builder
`menu_item.sort_order`	`integer`	Selectable in the Payload builder
`menu_item.created_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "menu": {
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "name": "Main menu"
  },
  "menu_item": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "1d2b7c44-93cf-4f2f-9f6a-5f4a1e2ce8d0",
    "link_label": "Apparel",
    "link_type": "category",
    "link_value": "7",
    "menu_id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "open_in_new_tab": false,
    "parent_id": null,
    "sort_order": 0,
    "title": "Shop"
  },
  "translation": {
    "title": "Shop"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Menu created

EVENT menus/create App scope: read_menus Staff permission: menus:write

Fired when a navigation menu is created.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Selectable in the Payload builder
`menu.handle`	`string`	Selectable in the Payload builder
`menu.item_count`	`integer`	Selectable in the Payload builder
`menu.created_at`	`string`	Selectable in the Payload builder
`menu.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "menu": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "item_count": 5,
    "name": "Main menu",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Menu deleted

EVENT menus/delete App scope: read_menus Staff permission: menus:write

Fired when a navigation menu is deleted.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Selectable in the Payload builder
`menu.handle`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "menu": {
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "name": "Main menu"
  }
}

Menu updated

EVENT menus/update App scope: read_menus Staff permission: menus:write

Fired when a navigation menu or one of its items is updated.

Payload fields

Field	Type	Description
`menu.id`	`string`	Always present
`menu.name`	`string`	Selectable in the Payload builder
`menu.handle`	`string`	Selectable in the Payload builder
`menu.item_count`	`integer`	Selectable in the Payload builder
`menu.created_at`	`string`	Selectable in the Payload builder
`menu.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "menu": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "handle": "main-menu",
    "id": "9a7f04c2-6f3e-4b58-a2ce-b9d3f43f6f10",
    "item_count": 5,
    "name": "Main menu",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Fulfillment event recorded

EVENT fulfillment_events/create App scope: read_orders Staff permission: orders:read

Fired when an immutable event is recorded on a fulfillment timeline.

Payload fields

Field	Type	Description
`event.id`	`string`	Selectable in the Payload builder
`event.fulfillment_id`	`string`	Selectable in the Payload builder
`event.order_id`	`string`	Selectable in the Payload builder
`event.event_type`	`string`	Selectable in the Payload builder
`event.description`	`string`	Selectable in the Payload builder
`event.location`	`string`	Selectable in the Payload builder
`event.city`	`string`	Selectable in the Payload builder
`event.country`	`string`	Selectable in the Payload builder
`event.source`	`string`	Selectable in the Payload builder
`event.source_event_id`	`string`	Selectable in the Payload builder
`event.source_data`	`array`	Selectable in the Payload builder
`event.happened_at`	`string`	Selectable in the Payload builder
`event.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "event": {
    "city": "...",
    "country": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "...",
    "event_type": "...",
    "fulfillment_id": "...",
    "happened_at": "...",
    "id": "...",
    "location": "...",
    "order_id": "...",
    "source": "...",
    "source_data": [],
    "source_event_id": "..."
  }
}

Fulfillment order created

EVENT fulfillment_orders/create App scope: read_orders Staff permission: orders:read

Fired when an order is routed into a planned shipment.

Payload fields

Field	Type	Description
`fulfillment_order.id`	`string`	Selectable in the Payload builder
`fulfillment_order.sequence`	`integer`	Selectable in the Payload builder
`fulfillment_order.display_id`	`string`	Selectable in the Payload builder
`fulfillment_order.order_id`	`string`	Selectable in the Payload builder
`fulfillment_order.is_test`	`boolean`	Selectable in the Payload builder
`fulfillment_order.location_id`	`string`	Selectable in the Payload builder
`fulfillment_order.status`	`string`	Selectable in the Payload builder
`fulfillment_order.package_profile_id`	`string`	Selectable in the Payload builder
`fulfillment_order.package_snapshot`	`array`	Selectable in the Payload builder
`fulfillment_order.parcel_snapshot`	`array`	Selectable in the Payload builder
`fulfillment_order.shipping_method_id`	`string`	Selectable in the Payload builder
`fulfillment_order.items[*].order_item_id`	`string`	Selectable in the Payload builder
`fulfillment_order.items[*].quantity`	`integer`	Selectable in the Payload builder
`fulfillment_order.created_at`	`string`	Selectable in the Payload builder
`fulfillment_order.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "fulfillment_order": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "display_id": "...",
    "id": "...",
    "is_test": false,
    "items": [
      {
        "order_item_id": "...",
        "quantity": 0
      }
    ],
    "location_id": "...",
    "order_id": "...",
    "package_profile_id": null,
    "package_snapshot": [],
    "parcel_snapshot": [],
    "sequence": 0,
    "shipping_method_id": null,
    "status": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Fulfillment cancelled

EVENT fulfillments/cancelled App scope: read_orders Staff permission: orders:read

Fired when a pending fulfillment is cancelled.

Payload fields

Field	Type	Description
`fulfillment.id`	`string`	Selectable in the Payload builder
`fulfillment.order_id`	`string`	Selectable in the Payload builder
`fulfillment.fulfillment_order_id`	`string`	Selectable in the Payload builder
`fulfillment.fulfillment_order_display_id`	`string`	Selectable in the Payload builder
`fulfillment.location_id`	`string`	Selectable in the Payload builder
`fulfillment.status`	`string`	Selectable in the Payload builder
`fulfillment.tracking_number`	`string`	Selectable in the Payload builder
`fulfillment.tracking_url`	`string`	Selectable in the Payload builder
`fulfillment.carrier`	`string`	Selectable in the Payload builder
`fulfillment.items[*].order_item_id`	`string`	Selectable in the Payload builder
`fulfillment.items[*].quantity`	`integer`	Selectable in the Payload builder
`fulfillment.created_at`	`string`	Selectable in the Payload builder
`fulfillment.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "fulfillment": {
    "carrier": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "fulfillment_order_display_id": "...",
    "fulfillment_order_id": "...",
    "id": "...",
    "items": [
      {
        "order_item_id": "...",
        "quantity": 0
      }
    ],
    "location_id": "...",
    "order_id": "...",
    "status": "...",
    "tracking_number": "...",
    "tracking_url": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Fulfillment created

EVENT fulfillments/create App scope: read_orders Staff permission: orders:read

Fired when a fulfillment is created beneath a planned shipment.

Payload fields

Field	Type	Description
`fulfillment.id`	`string`	Selectable in the Payload builder
`fulfillment.order_id`	`string`	Selectable in the Payload builder
`fulfillment.fulfillment_order_id`	`string`	Selectable in the Payload builder
`fulfillment.fulfillment_order_display_id`	`string`	Selectable in the Payload builder
`fulfillment.location_id`	`string`	Selectable in the Payload builder
`fulfillment.status`	`string`	Selectable in the Payload builder
`fulfillment.tracking_number`	`string`	Selectable in the Payload builder
`fulfillment.tracking_url`	`string`	Selectable in the Payload builder
`fulfillment.carrier`	`string`	Selectable in the Payload builder
`fulfillment.items[*].order_item_id`	`string`	Selectable in the Payload builder
`fulfillment.items[*].quantity`	`integer`	Selectable in the Payload builder
`fulfillment.created_at`	`string`	Selectable in the Payload builder
`fulfillment.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "fulfillment": {
    "carrier": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "fulfillment_order_display_id": "...",
    "fulfillment_order_id": "...",
    "id": "...",
    "items": [
      {
        "order_item_id": "...",
        "quantity": 0
      }
    ],
    "location_id": "...",
    "order_id": "...",
    "status": "...",
    "tracking_number": "...",
    "tracking_url": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Fulfillment updated

EVENT fulfillments/update App scope: read_orders Staff permission: orders:read

Fired when fulfillment status or tracking changes.

Payload fields

Field	Type	Description
`fulfillment.id`	`string`	Selectable in the Payload builder
`fulfillment.order_id`	`string`	Selectable in the Payload builder
`fulfillment.fulfillment_order_id`	`string`	Selectable in the Payload builder
`fulfillment.fulfillment_order_display_id`	`string`	Selectable in the Payload builder
`fulfillment.location_id`	`string`	Selectable in the Payload builder
`fulfillment.status`	`string`	Selectable in the Payload builder
`fulfillment.tracking_number`	`string`	Selectable in the Payload builder
`fulfillment.tracking_url`	`string`	Selectable in the Payload builder
`fulfillment.carrier`	`string`	Selectable in the Payload builder
`fulfillment.items[*].order_item_id`	`string`	Selectable in the Payload builder
`fulfillment.items[*].quantity`	`integer`	Selectable in the Payload builder
`fulfillment.created_at`	`string`	Selectable in the Payload builder
`fulfillment.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "fulfillment": {
    "carrier": "...",
    "created_at": "2026-06-09T12:00:00+05:30",
    "fulfillment_order_display_id": "...",
    "fulfillment_order_id": "...",
    "id": "...",
    "items": [
      {
        "order_item_id": "...",
        "quantity": 0
      }
    ],
    "location_id": "...",
    "order_id": "...",
    "status": "...",
    "tracking_number": "...",
    "tracking_url": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Order item metafield value created

EVENT order_item_metafields/create App scope: read_orders Staff permission: orders:read

Fired when an order item metafield value is created. Delivery respects the definition’s merchant and app access.

Payload fields

Field	Type	Description
`order_item.order_id`	`string`	Always present
`order_item.order_item_id`	`string`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "order_item": {
    "order_id": "...",
    "order_item_id": "..."
  }
}

Order item metafield value deleted

EVENT order_item_metafields/delete App scope: read_orders Staff permission: orders:read

Fired when an order item metafield value is deleted. Delivery respects the definition’s merchant and app access.

Payload fields

Field	Type	Description
`order_item.order_id`	`string`	Always present
`order_item.order_item_id`	`string`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "order_item": {
    "order_id": "...",
    "order_item_id": "..."
  }
}

Order item metafield value updated

EVENT order_item_metafields/update App scope: read_orders Staff permission: orders:read

Fired when an order item metafield value is updated. Delivery respects the definition’s merchant and app access.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`order_item.order_id`	`string`	Always present
`order_item.order_item_id`	`string`	Always present
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "order_item": {
    "order_id": "...",
    "order_item_id": "..."
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  }
}

Order metafield value created

EVENT order_metafields/create App scope: read_orders Staff permission: orders:read

Fired when an order metafield value is created. Delivery respects the definition’s merchant and app access.

Payload fields

Field	Type	Description
`order.order_id`	`string`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "order": {
    "order_id": "..."
  }
}

Order metafield value deleted

EVENT order_metafields/delete App scope: read_orders Staff permission: orders:read

Fired when an order metafield value is deleted. Delivery respects the definition’s merchant and app access.

Payload fields

Field	Type	Description
`order.order_id`	`string`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "order": {
    "order_id": "..."
  }
}

Order metafield value updated

EVENT order_metafields/update App scope: read_orders Staff permission: orders:read

Fired when an order metafield value is updated. Delivery respects the definition’s merchant and app access.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`order.order_id`	`string`	Always present
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "order": {
    "order_id": "..."
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  }
}

Order archive state changed

EVENT orders/archive_changed App scope: read_orders Staff permission: orders:read

Fired when an order is archived or restored to Active, including automatic archiving. Unchanged requests emit no event. This compact payload identifies the order and its archive state; retrieve the order for its full details.

Payload fields

Field	Type	Description
`order.id`	`string`	Selectable in the Payload builder
`order.order_number`	`string`	Selectable in the Payload builder
`order.is_archived`	`boolean`	Selectable in the Payload builder
`previous_is_archived`	`boolean`	Selectable in the Payload builder
`changed_at`	`string`	Selectable in the Payload builder
`source`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_at": "2026-09-10T10:00:00+05:30",
  "order": {
    "id": "da9b07a6-803f-4e41-8a18-97ff831bd588",
    "is_archived": true,
    "order_number": "#1042"
  },
  "previous_is_archived": false,
  "source": "automatic"
}

Order cancelled

EVENT orders/cancelled App scope: read_orders Staff permission: orders:read

Fired when an order is cancelled.

Payload fields

Field	Type	Description
`order.is_archived`	`boolean`	Selectable in the Payload builder
`order.id`	`string`	Selectable in the Payload builder
`order.version`	`integer`	Selectable in the Payload builder
`order.order_number`	`string`	Selectable in the Payload builder
`order.status_slug`	`string`	Selectable in the Payload builder
`order.channel_id`	`string`	Selectable in the Payload builder
`order.channel_type`	`string`	Selectable in the Payload builder
`order.origin`	`string`	Selectable in the Payload builder
`order.market_id`	`string`	Selectable in the Payload builder
`order.location_id`	`string`	Selectable in the Payload builder
`order.created_by_app_id`	`string`	Selectable in the Payload builder
`order.locale`	`string`	Selectable in the Payload builder
`order.external_order_id`	`string`	Selectable in the Payload builder
`order.external_source`	`string`	Selectable in the Payload builder
`order.customer_id`	`string`	Selectable in the Payload builder
`order.customer_email`	`string`	Selectable in the Payload builder
`order.customer_first_name`	`string`	Selectable in the Payload builder
`order.customer_last_name`	`string`	Selectable in the Payload builder
`order.customer_phone`	`string`	Selectable in the Payload builder
`order.customer_tax_id`	`string`	Selectable in the Payload builder
`order.customer_tax_id_type`	`string`	Selectable in the Payload builder
`order.currency_code`	`string`	Selectable in the Payload builder
`order.subtotal`	`string`	Selectable in the Payload builder
`order.discount_total`	`string`	Selectable in the Payload builder
`order.tax_total`	`string`	Selectable in the Payload builder
`order.shipping_total`	`string`	Selectable in the Payload builder
`order.cod_fee_total`	`string`	Selectable in the Payload builder
`order.cod_fee_hsn_code`	`string`	Selectable in the Payload builder
`order.checkout_fee_total`	`string`	Selectable in the Payload builder
`order.duty_total`	`string`	Selectable in the Payload builder
`order.duty_collection_mode`	`string`	Selectable in the Payload builder
`order.duty_eligible`	`boolean`	Selectable in the Payload builder
`order.de_minimis_applied`	`boolean`	Selectable in the Payload builder
`order.duty_overridden`	`boolean`	Selectable in the Payload builder
`order.duty_rule_id`	`string`	Selectable in the Payload builder
`order.duty_rule_currency`	`string`	Selectable in the Payload builder
`order.grand_total`	`string`	Selectable in the Payload builder
`order.refunded_total`	`string`	Selectable in the Payload builder
`order.amount_due_on_delivery`	`string`	Selectable in the Payload builder
`order.base_currency_code`	`string`	Selectable in the Payload builder
`order.base_currency_rate`	`string`	Selectable in the Payload builder
`order.base_subtotal`	`string`	Selectable in the Payload builder
`order.base_discount_total`	`string`	Selectable in the Payload builder
`order.base_tax_total`	`string`	Selectable in the Payload builder
`order.base_shipping_total`	`string`	Selectable in the Payload builder
`order.base_cod_fee_total`	`string`	Selectable in the Payload builder
`order.base_checkout_fee_total`	`string`	Selectable in the Payload builder
`order.base_duty_total`	`string`	Selectable in the Payload builder
`order.base_grand_total`	`string`	Selectable in the Payload builder
`order.base_refunded_total`	`string`	Selectable in the Payload builder
`order.exchange_fee_rate`	`string`	Selectable in the Payload builder
`order.exchange_fee_amount`	`string`	Selectable in the Payload builder
`order.rate_source`	`string`	Selectable in the Payload builder
`order.financial_status`	`string`	Selectable in the Payload builder
`order.fulfillment_status`	`string`	Selectable in the Payload builder
`order.payment_status`	`string`	Selectable in the Payload builder
`order.requires_shipping`	`boolean`	Selectable in the Payload builder
`order.is_tax_included`	`boolean`	Selectable in the Payload builder
`order.tax_address_missing`	`boolean`	Selectable in the Payload builder
`order.tax_zone_unmatched`	`boolean`	Selectable in the Payload builder
`order.tax_exempt`	`boolean`	Selectable in the Payload builder
`order.invoice_only`	`boolean`	Selectable in the Payload builder
`order.is_test`	`boolean`	Selectable in the Payload builder
`order.note`	`string`	Selectable in the Payload builder
`order.total_items`	`integer`	Selectable in the Payload builder
`order.checkout_fee_lines[*].id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].name`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].amount`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].tax_class_id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].is_optional`	`boolean`	Selectable in the Payload builder
`order.checkout_fee_lines[*].overridden`	`boolean`	Selectable in the Payload builder
`order.items[*].id`	`string`	Selectable in the Payload builder
`order.items[*].product_id`	`integer`	Selectable in the Payload builder
`order.items[*].variant_id`	`integer`	Selectable in the Payload builder
`order.items[*].sku`	`string`	Selectable in the Payload builder
`order.items[*].title`	`string`	Selectable in the Payload builder
`order.items[*].variant_title`	`string`	Selectable in the Payload builder
`order.items[*].image_url`	`string`	Selectable in the Payload builder
`order.items[*].quantity`	`integer`	Selectable in the Payload builder
`order.items[*].fulfilled_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].refunded_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].unit_price`	`string`	Selectable in the Payload builder
`order.items[*].unit_compare_price`	`string`	Selectable in the Payload builder
`order.items[*].discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].total`	`string`	Selectable in the Payload builder
`order.items[*].price_converted`	`boolean`	Selectable in the Payload builder
`order.items[*].base_unit_price`	`string`	Selectable in the Payload builder
`order.items[*].base_discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_total`	`string`	Selectable in the Payload builder
`order.items[*].tax_rate`	`string`	Selectable in the Payload builder
`order.items[*].tax_name`	`string`	Selectable in the Payload builder
`order.items[*].taxable`	`boolean`	Selectable in the Payload builder
`order.items[*].weight`	`string`	Selectable in the Payload builder
`order.items[*].weight_unit`	`string`	Selectable in the Payload builder
`order.items[*].country_of_origin`	`string`	Selectable in the Payload builder
`order.items[*].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[*].matched_hs_code`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_desc`	`string`	Selectable in the Payload builder
`order.items[*].duty_dutiable`	`boolean`	Selectable in the Payload builder
`order.items[*].duty_exclusion_reason`	`string`	Selectable in the Payload builder
`order.items[*].duty_customs_value`	`string`	Selectable in the Payload builder
`order.items[*].duty_weight_kg`	`string`	Selectable in the Payload builder
`order.items[*].duty_matched_origin`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_type`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_per`	`string`	Selectable in the Payload builder
`order.items[*].vendor`	`string`	Selectable in the Payload builder
`order.items[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`order.items[*].fulfillment_status`	`string`	Selectable in the Payload builder
`order.items[*].external_id`	`string`	Selectable in the Payload builder
`order.items[*].properties`	`object`	Selectable in the Payload builder
`order.items[].tax_lines[].name`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].rate`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].amount`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction_type`	`string`	Selectable in the Payload builder
`order.items[].duties[].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].country_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].amount`	`string`	Selectable in the Payload builder
`order.items[].duties[].currency_code`	`string`	Selectable in the Payload builder
`order.shipping_address.first_name`	`string`	Selectable in the Payload builder
`order.shipping_address.last_name`	`string`	Selectable in the Payload builder
`order.shipping_address.company`	`string`	Selectable in the Payload builder
`order.shipping_address.address1`	`string`	Selectable in the Payload builder
`order.shipping_address.address2`	`string`	Selectable in the Payload builder
`order.shipping_address.city`	`string`	Selectable in the Payload builder
`order.shipping_address.state`	`string`	Selectable in the Payload builder
`order.shipping_address.postal_code`	`string`	Selectable in the Payload builder
`order.shipping_address.country`	`string`	Selectable in the Payload builder
`order.shipping_address.phone`	`string`	Selectable in the Payload builder
`order.billing_address.first_name`	`string`	Selectable in the Payload builder
`order.billing_address.last_name`	`string`	Selectable in the Payload builder
`order.billing_address.company`	`string`	Selectable in the Payload builder
`order.billing_address.address1`	`string`	Selectable in the Payload builder
`order.billing_address.address2`	`string`	Selectable in the Payload builder
`order.billing_address.city`	`string`	Selectable in the Payload builder
`order.billing_address.state`	`string`	Selectable in the Payload builder
`order.billing_address.postal_code`	`string`	Selectable in the Payload builder
`order.billing_address.country`	`string`	Selectable in the Payload builder
`order.billing_address.phone`	`string`	Selectable in the Payload builder
`order.discounts[*].id`	`string`	Selectable in the Payload builder
`order.discounts[*].name`	`string`	Selectable in the Payload builder
`order.discounts[*].code`	`string`	Selectable in the Payload builder
`order.discounts[*].type`	`string`	Selectable in the Payload builder
`order.discounts[*].value`	`string`	Selectable in the Payload builder
`order.discounts[*].amount`	`string`	Selectable in the Payload builder
`order.discounts[*].scope`	`string`	Selectable in the Payload builder
`order.discounts[*].line_item_id`	`string`	Selectable in the Payload builder
`order.discounts[*].source`	`string`	Selectable in the Payload builder
`order.discounts[*].source_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].order_item_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].product_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].variant_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].quantity`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].per_unit_amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].is_free`	`boolean`	Selectable in the Payload builder
`order.tags[*].id`	`string`	Selectable in the Payload builder
`order.tags[*].name`	`string`	Selectable in the Payload builder
`order.tags[*].slug`	`string`	Selectable in the Payload builder
`order.payments[*].id`	`string`	Selectable in the Payload builder
`order.payments[*].method`	`string`	Selectable in the Payload builder
`order.payments[*].provider`	`string`	Selectable in the Payload builder
`order.payments[*].status`	`string`	Selectable in the Payload builder
`order.payments[*].amount`	`string`	Selectable in the Payload builder
`order.payments[*].currency_code`	`string`	Selectable in the Payload builder
`order.payments[*].created_at`	`string`	Selectable in the Payload builder
`order.tenders[*].id`	`string`	Selectable in the Payload builder
`order.tenders[*].kind`	`string`	Selectable in the Payload builder
`order.tenders[*].amount`	`string`	Selectable in the Payload builder
`order.tenders[*].currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].base_amount`	`string`	Selectable in the Payload builder
`order.tenders[*].base_currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].created_at`	`string`	Selectable in the Payload builder
`order.metafields_count`	`integer`	Selectable in the Payload builder
`order.created_at`	`string`	Selectable in the Payload builder
`order.updated_at`	`string`	Selectable in the Payload builder
`order.cancelled_at`	`string`	Selectable in the Payload builder
`order.completed_at`	`string`	Selectable in the Payload builder
`reason`	`string`	Selectable in the Payload builder
`cancelled_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "cancelled_at": "...",
  "order": {
    "amount_due_on_delivery": "...",
    "base_checkout_fee_total": "...",
    "base_cod_fee_total": "...",
    "base_currency_code": "...",
    "base_currency_rate": "...",
    "base_discount_total": "...",
    "base_duty_total": "...",
    "base_grand_total": "...",
    "base_refunded_total": "...",
    "base_shipping_total": "...",
    "base_subtotal": "...",
    "base_tax_total": "...",
    "billing_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "cancelled_at": null,
    "channel_id": null,
    "channel_type": null,
    "checkout_fee_lines": [
      {
        "amount": "40.00",
        "id": "ord_8e3f1a20",
        "is_optional": false,
        "name": "Buy two tees, get one free",
        "overridden": false,
        "tax_class_id": "..."
      }
    ],
    "checkout_fee_total": "...",
    "cod_fee_hsn_code": "...",
    "cod_fee_total": "...",
    "completed_at": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "created_by_app_id": null,
    "currency_code": "USD",
    "customer_email": "...",
    "customer_first_name": "...",
    "customer_id": null,
    "customer_last_name": "...",
    "customer_phone": "...",
    "customer_tax_id": null,
    "customer_tax_id_type": null,
    "de_minimis_applied": false,
    "discount_total": "40.00",
    "discounts": [
      {
        "allocations": [
          {
            "amount": "40.00",
            "is_free": true,
            "order_item_id": "oi_1b6d4c92",
            "per_unit_amount": "40.00",
            "product_id": 42,
            "quantity": 1,
            "variant_id": 1007
          }
        ],
        "amount": "40.00",
        "code": null,
        "id": "ord_8e3f1a20",
        "line_item_id": null,
        "name": "Buy two tees, get one free",
        "scope": "order",
        "source": "automatic",
        "source_id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
        "type": "buy_x_get_y",
        "value": "..."
      }
    ],
    "duty_collection_mode": "...",
    "duty_eligible": false,
    "duty_overridden": false,
    "duty_rule_currency": null,
    "duty_rule_id": null,
    "duty_total": "...",
    "exchange_fee_amount": "...",
    "exchange_fee_rate": "...",
    "external_order_id": null,
    "external_source": null,
    "financial_status": "paid",
    "fulfillment_status": "unfulfilled",
    "grand_total": "216.00",
    "id": "ord_8e3f1a20",
    "invoice_only": false,
    "is_archived": false,
    "is_tax_included": false,
    "is_test": false,
    "items": [
      {
        "base_discount_amount": "...",
        "base_duty_amount": "...",
        "base_tax_amount": "...",
        "base_total": "...",
        "base_unit_price": "...",
        "country_of_origin": null,
        "discount_amount": "...",
        "duties": [
          {
            "amount": "40.00",
            "country_code": "...",
            "currency_code": "USD",
            "harmonized_code": "..."
          }
        ],
        "duty_amount": "...",
        "duty_customs_value": "...",
        "duty_dutiable": false,
        "duty_exclusion_reason": "...",
        "duty_matched_origin": "...",
        "duty_rate": null,
        "duty_rate_desc": "...",
        "duty_rate_type": "...",
        "duty_specific_amount": null,
        "duty_specific_per": "...",
        "duty_weight_kg": "...",
        "external_id": null,
        "fulfilled_quantity": 0,
        "fulfillment_status": "unfulfilled",
        "harmonized_code": "...",
        "id": "ord_8e3f1a20",
        "image_url": "...",
        "matched_hs_code": "...",
        "price_converted": null,
        "product_id": 42,
        "properties": "...",
        "quantity": 1,
        "refunded_quantity": 0,
        "requires_shipping": false,
        "sku": "...",
        "tax_amount": "...",
        "tax_lines": [
          {
            "amount": "40.00",
            "jurisdiction": "...",
            "jurisdiction_type": "...",
            "name": "Buy two tees, get one free",
            "rate": "..."
          }
        ],
        "tax_name": "...",
        "tax_rate": null,
        "taxable": false,
        "title": "...",
        "total": "...",
        "unit_compare_price": null,
        "unit_price": "...",
        "variant_id": 1007,
        "variant_title": "...",
        "vendor": "...",
        "weight": null,
        "weight_unit": "..."
      }
    ],
    "locale": "en-US",
    "location_id": null,
    "market_id": null,
    "metafields_count": 0,
    "note": "...",
    "order_number": "#1042",
    "origin": "...",
    "payment_status": "captured",
    "payments": [
      {
        "amount": "40.00",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "method": "...",
        "provider": "...",
        "status": "..."
      }
    ],
    "rate_source": "...",
    "refunded_total": "...",
    "requires_shipping": false,
    "shipping_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "shipping_total": "0.00",
    "status_slug": "confirmed",
    "subtotal": "...",
    "tags": [
      {
        "id": "ord_8e3f1a20",
        "name": "Buy two tees, get one free",
        "slug": "..."
      }
    ],
    "tax_address_missing": false,
    "tax_exempt": false,
    "tax_total": "16.00",
    "tax_zone_unmatched": false,
    "tenders": [
      {
        "amount": "40.00",
        "base_amount": "...",
        "base_currency_code": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "kind": "..."
      }
    ],
    "total_items": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "version": 0
  },
  "reason": "..."
}

Order created

EVENT orders/create App scope: read_orders Staff permission: orders:read

Fired when an operational order is created through Store Admin, checkout, or the Store API. Historical CSV imports do not fire this event.

Payload fields

Field	Type	Description
`order.is_archived`	`boolean`	Selectable in the Payload builder
`order.id`	`string`	Selectable in the Payload builder
`order.version`	`integer`	Selectable in the Payload builder
`order.order_number`	`string`	Selectable in the Payload builder
`order.status_slug`	`string`	Selectable in the Payload builder
`order.channel_id`	`string`	Selectable in the Payload builder
`order.channel_type`	`string`	Selectable in the Payload builder
`order.origin`	`string`	Selectable in the Payload builder
`order.market_id`	`string`	Selectable in the Payload builder
`order.location_id`	`string`	Selectable in the Payload builder
`order.created_by_app_id`	`string`	Selectable in the Payload builder
`order.locale`	`string`	Selectable in the Payload builder
`order.external_order_id`	`string`	Selectable in the Payload builder
`order.external_source`	`string`	Selectable in the Payload builder
`order.customer_id`	`string`	Selectable in the Payload builder
`order.customer_email`	`string`	Selectable in the Payload builder
`order.customer_first_name`	`string`	Selectable in the Payload builder
`order.customer_last_name`	`string`	Selectable in the Payload builder
`order.customer_phone`	`string`	Selectable in the Payload builder
`order.customer_tax_id`	`string`	Selectable in the Payload builder
`order.customer_tax_id_type`	`string`	Selectable in the Payload builder
`order.currency_code`	`string`	Selectable in the Payload builder
`order.subtotal`	`string`	Selectable in the Payload builder
`order.discount_total`	`string`	Selectable in the Payload builder
`order.tax_total`	`string`	Selectable in the Payload builder
`order.shipping_total`	`string`	Selectable in the Payload builder
`order.cod_fee_total`	`string`	Selectable in the Payload builder
`order.cod_fee_hsn_code`	`string`	Selectable in the Payload builder
`order.checkout_fee_total`	`string`	Selectable in the Payload builder
`order.duty_total`	`string`	Selectable in the Payload builder
`order.duty_collection_mode`	`string`	Selectable in the Payload builder
`order.duty_eligible`	`boolean`	Selectable in the Payload builder
`order.de_minimis_applied`	`boolean`	Selectable in the Payload builder
`order.duty_overridden`	`boolean`	Selectable in the Payload builder
`order.duty_rule_id`	`string`	Selectable in the Payload builder
`order.duty_rule_currency`	`string`	Selectable in the Payload builder
`order.grand_total`	`string`	Selectable in the Payload builder
`order.refunded_total`	`string`	Selectable in the Payload builder
`order.amount_due_on_delivery`	`string`	Selectable in the Payload builder
`order.base_currency_code`	`string`	Selectable in the Payload builder
`order.base_currency_rate`	`string`	Selectable in the Payload builder
`order.base_subtotal`	`string`	Selectable in the Payload builder
`order.base_discount_total`	`string`	Selectable in the Payload builder
`order.base_tax_total`	`string`	Selectable in the Payload builder
`order.base_shipping_total`	`string`	Selectable in the Payload builder
`order.base_cod_fee_total`	`string`	Selectable in the Payload builder
`order.base_checkout_fee_total`	`string`	Selectable in the Payload builder
`order.base_duty_total`	`string`	Selectable in the Payload builder
`order.base_grand_total`	`string`	Selectable in the Payload builder
`order.base_refunded_total`	`string`	Selectable in the Payload builder
`order.exchange_fee_rate`	`string`	Selectable in the Payload builder
`order.exchange_fee_amount`	`string`	Selectable in the Payload builder
`order.rate_source`	`string`	Selectable in the Payload builder
`order.financial_status`	`string`	Selectable in the Payload builder
`order.fulfillment_status`	`string`	Selectable in the Payload builder
`order.payment_status`	`string`	Selectable in the Payload builder
`order.requires_shipping`	`boolean`	Selectable in the Payload builder
`order.is_tax_included`	`boolean`	Selectable in the Payload builder
`order.tax_address_missing`	`boolean`	Selectable in the Payload builder
`order.tax_zone_unmatched`	`boolean`	Selectable in the Payload builder
`order.tax_exempt`	`boolean`	Selectable in the Payload builder
`order.invoice_only`	`boolean`	Selectable in the Payload builder
`order.is_test`	`boolean`	Selectable in the Payload builder
`order.note`	`string`	Selectable in the Payload builder
`order.total_items`	`integer`	Selectable in the Payload builder
`order.checkout_fee_lines[*].id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].name`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].amount`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].tax_class_id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].is_optional`	`boolean`	Selectable in the Payload builder
`order.checkout_fee_lines[*].overridden`	`boolean`	Selectable in the Payload builder
`order.items[*].id`	`string`	Selectable in the Payload builder
`order.items[*].product_id`	`integer`	Selectable in the Payload builder
`order.items[*].variant_id`	`integer`	Selectable in the Payload builder
`order.items[*].sku`	`string`	Selectable in the Payload builder
`order.items[*].title`	`string`	Selectable in the Payload builder
`order.items[*].variant_title`	`string`	Selectable in the Payload builder
`order.items[*].image_url`	`string`	Selectable in the Payload builder
`order.items[*].quantity`	`integer`	Selectable in the Payload builder
`order.items[*].fulfilled_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].refunded_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].unit_price`	`string`	Selectable in the Payload builder
`order.items[*].unit_compare_price`	`string`	Selectable in the Payload builder
`order.items[*].discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].total`	`string`	Selectable in the Payload builder
`order.items[*].price_converted`	`boolean`	Selectable in the Payload builder
`order.items[*].base_unit_price`	`string`	Selectable in the Payload builder
`order.items[*].base_discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_total`	`string`	Selectable in the Payload builder
`order.items[*].tax_rate`	`string`	Selectable in the Payload builder
`order.items[*].tax_name`	`string`	Selectable in the Payload builder
`order.items[*].taxable`	`boolean`	Selectable in the Payload builder
`order.items[*].weight`	`string`	Selectable in the Payload builder
`order.items[*].weight_unit`	`string`	Selectable in the Payload builder
`order.items[*].country_of_origin`	`string`	Selectable in the Payload builder
`order.items[*].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[*].matched_hs_code`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_desc`	`string`	Selectable in the Payload builder
`order.items[*].duty_dutiable`	`boolean`	Selectable in the Payload builder
`order.items[*].duty_exclusion_reason`	`string`	Selectable in the Payload builder
`order.items[*].duty_customs_value`	`string`	Selectable in the Payload builder
`order.items[*].duty_weight_kg`	`string`	Selectable in the Payload builder
`order.items[*].duty_matched_origin`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_type`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_per`	`string`	Selectable in the Payload builder
`order.items[*].vendor`	`string`	Selectable in the Payload builder
`order.items[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`order.items[*].fulfillment_status`	`string`	Selectable in the Payload builder
`order.items[*].external_id`	`string`	Selectable in the Payload builder
`order.items[*].properties`	`object`	Selectable in the Payload builder
`order.items[].tax_lines[].name`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].rate`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].amount`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction_type`	`string`	Selectable in the Payload builder
`order.items[].duties[].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].country_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].amount`	`string`	Selectable in the Payload builder
`order.items[].duties[].currency_code`	`string`	Selectable in the Payload builder
`order.shipping_address.first_name`	`string`	Selectable in the Payload builder
`order.shipping_address.last_name`	`string`	Selectable in the Payload builder
`order.shipping_address.company`	`string`	Selectable in the Payload builder
`order.shipping_address.address1`	`string`	Selectable in the Payload builder
`order.shipping_address.address2`	`string`	Selectable in the Payload builder
`order.shipping_address.city`	`string`	Selectable in the Payload builder
`order.shipping_address.state`	`string`	Selectable in the Payload builder
`order.shipping_address.postal_code`	`string`	Selectable in the Payload builder
`order.shipping_address.country`	`string`	Selectable in the Payload builder
`order.shipping_address.phone`	`string`	Selectable in the Payload builder
`order.billing_address.first_name`	`string`	Selectable in the Payload builder
`order.billing_address.last_name`	`string`	Selectable in the Payload builder
`order.billing_address.company`	`string`	Selectable in the Payload builder
`order.billing_address.address1`	`string`	Selectable in the Payload builder
`order.billing_address.address2`	`string`	Selectable in the Payload builder
`order.billing_address.city`	`string`	Selectable in the Payload builder
`order.billing_address.state`	`string`	Selectable in the Payload builder
`order.billing_address.postal_code`	`string`	Selectable in the Payload builder
`order.billing_address.country`	`string`	Selectable in the Payload builder
`order.billing_address.phone`	`string`	Selectable in the Payload builder
`order.discounts[*].id`	`string`	Selectable in the Payload builder
`order.discounts[*].name`	`string`	Selectable in the Payload builder
`order.discounts[*].code`	`string`	Selectable in the Payload builder
`order.discounts[*].type`	`string`	Selectable in the Payload builder
`order.discounts[*].value`	`string`	Selectable in the Payload builder
`order.discounts[*].amount`	`string`	Selectable in the Payload builder
`order.discounts[*].scope`	`string`	Selectable in the Payload builder
`order.discounts[*].line_item_id`	`string`	Selectable in the Payload builder
`order.discounts[*].source`	`string`	Selectable in the Payload builder
`order.discounts[*].source_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].order_item_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].product_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].variant_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].quantity`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].per_unit_amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].is_free`	`boolean`	Selectable in the Payload builder
`order.tags[*].id`	`string`	Selectable in the Payload builder
`order.tags[*].name`	`string`	Selectable in the Payload builder
`order.tags[*].slug`	`string`	Selectable in the Payload builder
`order.payments[*].id`	`string`	Selectable in the Payload builder
`order.payments[*].method`	`string`	Selectable in the Payload builder
`order.payments[*].provider`	`string`	Selectable in the Payload builder
`order.payments[*].status`	`string`	Selectable in the Payload builder
`order.payments[*].amount`	`string`	Selectable in the Payload builder
`order.payments[*].currency_code`	`string`	Selectable in the Payload builder
`order.payments[*].created_at`	`string`	Selectable in the Payload builder
`order.tenders[*].id`	`string`	Selectable in the Payload builder
`order.tenders[*].kind`	`string`	Selectable in the Payload builder
`order.tenders[*].amount`	`string`	Selectable in the Payload builder
`order.tenders[*].currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].base_amount`	`string`	Selectable in the Payload builder
`order.tenders[*].base_currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].created_at`	`string`	Selectable in the Payload builder
`order.metafields_count`	`integer`	Selectable in the Payload builder
`order.created_at`	`string`	Selectable in the Payload builder
`order.updated_at`	`string`	Selectable in the Payload builder
`order.cancelled_at`	`string`	Selectable in the Payload builder
`order.completed_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "order": {
    "amount_due_on_delivery": "...",
    "base_checkout_fee_total": "...",
    "base_cod_fee_total": "...",
    "base_currency_code": "...",
    "base_currency_rate": "...",
    "base_discount_total": "...",
    "base_duty_total": "...",
    "base_grand_total": "...",
    "base_refunded_total": "...",
    "base_shipping_total": "...",
    "base_subtotal": "...",
    "base_tax_total": "...",
    "billing_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "cancelled_at": null,
    "channel_id": null,
    "channel_type": null,
    "checkout_fee_lines": [
      {
        "amount": "40.00",
        "id": "ord_8e3f1a20",
        "is_optional": false,
        "name": "Buy two tees, get one free",
        "overridden": false,
        "tax_class_id": "..."
      }
    ],
    "checkout_fee_total": "...",
    "cod_fee_hsn_code": "...",
    "cod_fee_total": "...",
    "completed_at": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "created_by_app_id": null,
    "currency_code": "USD",
    "customer_email": "...",
    "customer_first_name": "...",
    "customer_id": null,
    "customer_last_name": "...",
    "customer_phone": "...",
    "customer_tax_id": null,
    "customer_tax_id_type": null,
    "de_minimis_applied": false,
    "discount_total": "40.00",
    "discounts": [
      {
        "allocations": [
          {
            "amount": "40.00",
            "is_free": true,
            "order_item_id": "oi_1b6d4c92",
            "per_unit_amount": "40.00",
            "product_id": 42,
            "quantity": 1,
            "variant_id": 1007
          }
        ],
        "amount": "40.00",
        "code": null,
        "id": "ord_8e3f1a20",
        "line_item_id": null,
        "name": "Buy two tees, get one free",
        "scope": "order",
        "source": "automatic",
        "source_id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
        "type": "buy_x_get_y",
        "value": "..."
      }
    ],
    "duty_collection_mode": "...",
    "duty_eligible": false,
    "duty_overridden": false,
    "duty_rule_currency": null,
    "duty_rule_id": null,
    "duty_total": "...",
    "exchange_fee_amount": "...",
    "exchange_fee_rate": "...",
    "external_order_id": null,
    "external_source": null,
    "financial_status": "paid",
    "fulfillment_status": "unfulfilled",
    "grand_total": "216.00",
    "id": "ord_8e3f1a20",
    "invoice_only": false,
    "is_archived": false,
    "is_tax_included": false,
    "is_test": false,
    "items": [
      {
        "base_discount_amount": "...",
        "base_duty_amount": "...",
        "base_tax_amount": "...",
        "base_total": "...",
        "base_unit_price": "...",
        "country_of_origin": null,
        "discount_amount": "...",
        "duties": [
          {
            "amount": "40.00",
            "country_code": "...",
            "currency_code": "USD",
            "harmonized_code": "..."
          }
        ],
        "duty_amount": "...",
        "duty_customs_value": "...",
        "duty_dutiable": false,
        "duty_exclusion_reason": "...",
        "duty_matched_origin": "...",
        "duty_rate": null,
        "duty_rate_desc": "...",
        "duty_rate_type": "...",
        "duty_specific_amount": null,
        "duty_specific_per": "...",
        "duty_weight_kg": "...",
        "external_id": null,
        "fulfilled_quantity": 0,
        "fulfillment_status": "unfulfilled",
        "harmonized_code": "...",
        "id": "ord_8e3f1a20",
        "image_url": "...",
        "matched_hs_code": "...",
        "price_converted": null,
        "product_id": 42,
        "properties": "...",
        "quantity": 1,
        "refunded_quantity": 0,
        "requires_shipping": false,
        "sku": "...",
        "tax_amount": "...",
        "tax_lines": [
          {
            "amount": "40.00",
            "jurisdiction": "...",
            "jurisdiction_type": "...",
            "name": "Buy two tees, get one free",
            "rate": "..."
          }
        ],
        "tax_name": "...",
        "tax_rate": null,
        "taxable": false,
        "title": "...",
        "total": "...",
        "unit_compare_price": null,
        "unit_price": "...",
        "variant_id": 1007,
        "variant_title": "...",
        "vendor": "...",
        "weight": null,
        "weight_unit": "..."
      }
    ],
    "locale": "en-US",
    "location_id": null,
    "market_id": null,
    "metafields_count": 0,
    "note": "...",
    "order_number": "#1042",
    "origin": "...",
    "payment_status": "captured",
    "payments": [
      {
        "amount": "40.00",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "method": "...",
        "provider": "...",
        "status": "..."
      }
    ],
    "rate_source": "...",
    "refunded_total": "...",
    "requires_shipping": false,
    "shipping_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "shipping_total": "0.00",
    "status_slug": "confirmed",
    "subtotal": "...",
    "tags": [
      {
        "id": "ord_8e3f1a20",
        "name": "Buy two tees, get one free",
        "slug": "..."
      }
    ],
    "tax_address_missing": false,
    "tax_exempt": false,
    "tax_total": "16.00",
    "tax_zone_unmatched": false,
    "tenders": [
      {
        "amount": "40.00",
        "base_amount": "...",
        "base_currency_code": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "kind": "..."
      }
    ],
    "total_items": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "version": 0
  }
}

Order deleted

EVENT orders/delete App scope: read_orders Staff permission: orders:read

Fired when an order is deleted permanently, one at a time, in bulk, by undoing an import, or by the app that created it. The order no longer exists, so the payload carries only its ID, order number and deletion time.

Payload fields

Field	Type	Description
`order.id`	`string`	Always present
`order.order_number`	`string`	Always present
`order.deleted_at`	`string`	Always present

Payload shape

Sample payload

{
  "order": {
    "deleted_at": "2026-09-28T10:00:00+05:30",
    "id": "da9b07a6-803f-4e41-8a18-97ff831bd588",
    "order_number": "#1042"
  }
}

Order edited

EVENT orders/edited App scope: read_orders Staff permission: orders:read

Fired when an order's items are edited after it was placed. Carries the order after the edit, its new version, what changed on each line, the money effect and any fulfillment orders whose contents changed.

Payload fields

Field	Type	Description
`order.is_archived`	`boolean`	Selectable in the Payload builder
`order.id`	`string`	Selectable in the Payload builder
`order.version`	`integer`	Selectable in the Payload builder
`order.order_number`	`string`	Selectable in the Payload builder
`order.status_slug`	`string`	Selectable in the Payload builder
`order.channel_id`	`string`	Selectable in the Payload builder
`order.channel_type`	`string`	Selectable in the Payload builder
`order.origin`	`string`	Selectable in the Payload builder
`order.market_id`	`string`	Selectable in the Payload builder
`order.location_id`	`string`	Selectable in the Payload builder
`order.created_by_app_id`	`string`	Selectable in the Payload builder
`order.locale`	`string`	Selectable in the Payload builder
`order.external_order_id`	`string`	Selectable in the Payload builder
`order.external_source`	`string`	Selectable in the Payload builder
`order.customer_id`	`string`	Selectable in the Payload builder
`order.customer_email`	`string`	Selectable in the Payload builder
`order.customer_first_name`	`string`	Selectable in the Payload builder
`order.customer_last_name`	`string`	Selectable in the Payload builder
`order.customer_phone`	`string`	Selectable in the Payload builder
`order.customer_tax_id`	`string`	Selectable in the Payload builder
`order.customer_tax_id_type`	`string`	Selectable in the Payload builder
`order.currency_code`	`string`	Selectable in the Payload builder
`order.subtotal`	`string`	Selectable in the Payload builder
`order.discount_total`	`string`	Selectable in the Payload builder
`order.tax_total`	`string`	Selectable in the Payload builder
`order.shipping_total`	`string`	Selectable in the Payload builder
`order.cod_fee_total`	`string`	Selectable in the Payload builder
`order.cod_fee_hsn_code`	`string`	Selectable in the Payload builder
`order.checkout_fee_total`	`string`	Selectable in the Payload builder
`order.duty_total`	`string`	Selectable in the Payload builder
`order.duty_collection_mode`	`string`	Selectable in the Payload builder
`order.duty_eligible`	`boolean`	Selectable in the Payload builder
`order.de_minimis_applied`	`boolean`	Selectable in the Payload builder
`order.duty_overridden`	`boolean`	Selectable in the Payload builder
`order.duty_rule_id`	`string`	Selectable in the Payload builder
`order.duty_rule_currency`	`string`	Selectable in the Payload builder
`order.grand_total`	`string`	Selectable in the Payload builder
`order.refunded_total`	`string`	Selectable in the Payload builder
`order.amount_due_on_delivery`	`string`	Selectable in the Payload builder
`order.base_currency_code`	`string`	Selectable in the Payload builder
`order.base_currency_rate`	`string`	Selectable in the Payload builder
`order.base_subtotal`	`string`	Selectable in the Payload builder
`order.base_discount_total`	`string`	Selectable in the Payload builder
`order.base_tax_total`	`string`	Selectable in the Payload builder
`order.base_shipping_total`	`string`	Selectable in the Payload builder
`order.base_cod_fee_total`	`string`	Selectable in the Payload builder
`order.base_checkout_fee_total`	`string`	Selectable in the Payload builder
`order.base_duty_total`	`string`	Selectable in the Payload builder
`order.base_grand_total`	`string`	Selectable in the Payload builder
`order.base_refunded_total`	`string`	Selectable in the Payload builder
`order.exchange_fee_rate`	`string`	Selectable in the Payload builder
`order.exchange_fee_amount`	`string`	Selectable in the Payload builder
`order.rate_source`	`string`	Selectable in the Payload builder
`order.financial_status`	`string`	Selectable in the Payload builder
`order.fulfillment_status`	`string`	Selectable in the Payload builder
`order.payment_status`	`string`	Selectable in the Payload builder
`order.requires_shipping`	`boolean`	Selectable in the Payload builder
`order.is_tax_included`	`boolean`	Selectable in the Payload builder
`order.tax_address_missing`	`boolean`	Selectable in the Payload builder
`order.tax_zone_unmatched`	`boolean`	Selectable in the Payload builder
`order.tax_exempt`	`boolean`	Selectable in the Payload builder
`order.invoice_only`	`boolean`	Selectable in the Payload builder
`order.is_test`	`boolean`	Selectable in the Payload builder
`order.note`	`string`	Selectable in the Payload builder
`order.total_items`	`integer`	Selectable in the Payload builder
`order.checkout_fee_lines[*].id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].name`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].amount`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].tax_class_id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].is_optional`	`boolean`	Selectable in the Payload builder
`order.checkout_fee_lines[*].overridden`	`boolean`	Selectable in the Payload builder
`order.items[*].id`	`string`	Selectable in the Payload builder
`order.items[*].product_id`	`integer`	Selectable in the Payload builder
`order.items[*].variant_id`	`integer`	Selectable in the Payload builder
`order.items[*].sku`	`string`	Selectable in the Payload builder
`order.items[*].title`	`string`	Selectable in the Payload builder
`order.items[*].variant_title`	`string`	Selectable in the Payload builder
`order.items[*].image_url`	`string`	Selectable in the Payload builder
`order.items[*].quantity`	`integer`	Selectable in the Payload builder
`order.items[*].fulfilled_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].refunded_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].unit_price`	`string`	Selectable in the Payload builder
`order.items[*].unit_compare_price`	`string`	Selectable in the Payload builder
`order.items[*].discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].total`	`string`	Selectable in the Payload builder
`order.items[*].price_converted`	`boolean`	Selectable in the Payload builder
`order.items[*].base_unit_price`	`string`	Selectable in the Payload builder
`order.items[*].base_discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_total`	`string`	Selectable in the Payload builder
`order.items[*].tax_rate`	`string`	Selectable in the Payload builder
`order.items[*].tax_name`	`string`	Selectable in the Payload builder
`order.items[*].taxable`	`boolean`	Selectable in the Payload builder
`order.items[*].weight`	`string`	Selectable in the Payload builder
`order.items[*].weight_unit`	`string`	Selectable in the Payload builder
`order.items[*].country_of_origin`	`string`	Selectable in the Payload builder
`order.items[*].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[*].matched_hs_code`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_desc`	`string`	Selectable in the Payload builder
`order.items[*].duty_dutiable`	`boolean`	Selectable in the Payload builder
`order.items[*].duty_exclusion_reason`	`string`	Selectable in the Payload builder
`order.items[*].duty_customs_value`	`string`	Selectable in the Payload builder
`order.items[*].duty_weight_kg`	`string`	Selectable in the Payload builder
`order.items[*].duty_matched_origin`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_type`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_per`	`string`	Selectable in the Payload builder
`order.items[*].vendor`	`string`	Selectable in the Payload builder
`order.items[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`order.items[*].fulfillment_status`	`string`	Selectable in the Payload builder
`order.items[*].external_id`	`string`	Selectable in the Payload builder
`order.items[*].properties`	`object`	Selectable in the Payload builder
`order.items[].tax_lines[].name`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].rate`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].amount`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction_type`	`string`	Selectable in the Payload builder
`order.items[].duties[].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].country_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].amount`	`string`	Selectable in the Payload builder
`order.items[].duties[].currency_code`	`string`	Selectable in the Payload builder
`order.shipping_address.first_name`	`string`	Selectable in the Payload builder
`order.shipping_address.last_name`	`string`	Selectable in the Payload builder
`order.shipping_address.company`	`string`	Selectable in the Payload builder
`order.shipping_address.address1`	`string`	Selectable in the Payload builder
`order.shipping_address.address2`	`string`	Selectable in the Payload builder
`order.shipping_address.city`	`string`	Selectable in the Payload builder
`order.shipping_address.state`	`string`	Selectable in the Payload builder
`order.shipping_address.postal_code`	`string`	Selectable in the Payload builder
`order.shipping_address.country`	`string`	Selectable in the Payload builder
`order.shipping_address.phone`	`string`	Selectable in the Payload builder
`order.billing_address.first_name`	`string`	Selectable in the Payload builder
`order.billing_address.last_name`	`string`	Selectable in the Payload builder
`order.billing_address.company`	`string`	Selectable in the Payload builder
`order.billing_address.address1`	`string`	Selectable in the Payload builder
`order.billing_address.address2`	`string`	Selectable in the Payload builder
`order.billing_address.city`	`string`	Selectable in the Payload builder
`order.billing_address.state`	`string`	Selectable in the Payload builder
`order.billing_address.postal_code`	`string`	Selectable in the Payload builder
`order.billing_address.country`	`string`	Selectable in the Payload builder
`order.billing_address.phone`	`string`	Selectable in the Payload builder
`order.discounts[*].id`	`string`	Selectable in the Payload builder
`order.discounts[*].name`	`string`	Selectable in the Payload builder
`order.discounts[*].code`	`string`	Selectable in the Payload builder
`order.discounts[*].type`	`string`	Selectable in the Payload builder
`order.discounts[*].value`	`string`	Selectable in the Payload builder
`order.discounts[*].amount`	`string`	Selectable in the Payload builder
`order.discounts[*].scope`	`string`	Selectable in the Payload builder
`order.discounts[*].line_item_id`	`string`	Selectable in the Payload builder
`order.discounts[*].source`	`string`	Selectable in the Payload builder
`order.discounts[*].source_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].order_item_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].product_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].variant_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].quantity`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].per_unit_amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].is_free`	`boolean`	Selectable in the Payload builder
`order.tags[*].id`	`string`	Selectable in the Payload builder
`order.tags[*].name`	`string`	Selectable in the Payload builder
`order.tags[*].slug`	`string`	Selectable in the Payload builder
`order.payments[*].id`	`string`	Selectable in the Payload builder
`order.payments[*].method`	`string`	Selectable in the Payload builder
`order.payments[*].provider`	`string`	Selectable in the Payload builder
`order.payments[*].status`	`string`	Selectable in the Payload builder
`order.payments[*].amount`	`string`	Selectable in the Payload builder
`order.payments[*].currency_code`	`string`	Selectable in the Payload builder
`order.payments[*].created_at`	`string`	Selectable in the Payload builder
`order.tenders[*].id`	`string`	Selectable in the Payload builder
`order.tenders[*].kind`	`string`	Selectable in the Payload builder
`order.tenders[*].amount`	`string`	Selectable in the Payload builder
`order.tenders[*].currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].base_amount`	`string`	Selectable in the Payload builder
`order.tenders[*].base_currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].created_at`	`string`	Selectable in the Payload builder
`order.metafields_count`	`integer`	Selectable in the Payload builder
`order.created_at`	`string`	Selectable in the Payload builder
`order.updated_at`	`string`	Selectable in the Payload builder
`order.cancelled_at`	`string`	Selectable in the Payload builder
`order.completed_at`	`string`	Selectable in the Payload builder
`edit.field_changes[*].field`	`string`	Selectable in the Payload builder
`edit.field_changes[*].before`	`object`	Selectable in the Payload builder
`edit.field_changes[*].after`	`object`	Selectable in the Payload builder
`edit.id`	`string`	Always present
`edit.version`	`integer`	Always present
`edit.previous_grand_total`	`string`	Always present
`edit.grand_total`	`string`	Always present
`edit.currency_code`	`string`	Always present
`edit.balance_due`	`string`	Always present
`edit.refund_amount`	`string`	Always present
`edit.price_basis`	`string`	Always present
`edit.reason`	`string`	Selectable in the Payload builder
`edit.lines[*].order_item_id`	`string`	Always present
`edit.lines[*].change`	`string`	Always present
`edit.lines[*].product_id`	`integer`	Selectable in the Payload builder
`edit.lines[*].variant_id`	`integer`	Selectable in the Payload builder
`edit.lines[*].sku`	`string`	Selectable in the Payload builder
`edit.lines[*].title`	`string`	Always present
`edit.lines[*].variant_title`	`string`	Selectable in the Payload builder
`edit.lines[*].quantity_before`	`integer`	Selectable in the Payload builder
`edit.lines[*].quantity_after`	`integer`	Selectable in the Payload builder
`edit.lines[*].unit_price`	`string`	Always present
`edit.lines[*].amount_change`	`string`	Always present
`edit.fulfillment_orders[*].fulfillment_order_id`	`string`	Always present
`edit.fulfillment_orders[*].change`	`string`	Always present
`edit.fulfillment_orders[*].provider_app_id`	`string`	Selectable in the Payload builder
`edit.edited_by_app_id`	`string`	Selectable in the Payload builder
`edit.created_at`	`string`	Always present

Payload shape

Sample payload

{
  "edit": {
    "balance_due": "590.00",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "USD",
    "edited_by_app_id": "...",
    "field_changes": [
      {
        "after": "...",
        "before": "...",
        "field": "..."
      }
    ],
    "fulfillment_orders": [
      {
        "change": "added",
        "fulfillment_order_id": "...",
        "provider_app_id": "..."
      }
    ],
    "grand_total": "1770.00",
    "id": "ord_8e3f1a20",
    "lines": [
      {
        "amount_change": "590.00",
        "change": "added",
        "order_item_id": "oi_1b6d4c92",
        "product_id": 42,
        "quantity_after": 1,
        "quantity_before": 0,
        "sku": "...",
        "title": "...",
        "unit_price": "...",
        "variant_id": 1007,
        "variant_title": "..."
      }
    ],
    "previous_grand_total": "1180.00",
    "price_basis": "current",
    "reason": "...",
    "refund_amount": "0.00",
    "version": 2
  },
  "order": {
    "amount_due_on_delivery": "...",
    "base_checkout_fee_total": "...",
    "base_cod_fee_total": "...",
    "base_currency_code": "...",
    "base_currency_rate": "...",
    "base_discount_total": "...",
    "base_duty_total": "...",
    "base_grand_total": "...",
    "base_refunded_total": "...",
    "base_shipping_total": "...",
    "base_subtotal": "...",
    "base_tax_total": "...",
    "billing_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "cancelled_at": null,
    "channel_id": null,
    "channel_type": null,
    "checkout_fee_lines": [
      {
        "amount": "40.00",
        "id": "ord_8e3f1a20",
        "is_optional": false,
        "name": "Buy two tees, get one free",
        "overridden": false,
        "tax_class_id": "..."
      }
    ],
    "checkout_fee_total": "...",
    "cod_fee_hsn_code": "...",
    "cod_fee_total": "...",
    "completed_at": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "created_by_app_id": null,
    "currency_code": "USD",
    "customer_email": "...",
    "customer_first_name": "...",
    "customer_id": null,
    "customer_last_name": "...",
    "customer_phone": "...",
    "customer_tax_id": null,
    "customer_tax_id_type": null,
    "de_minimis_applied": false,
    "discount_total": "40.00",
    "discounts": [
      {
        "allocations": [
          {
            "amount": "40.00",
            "is_free": true,
            "order_item_id": "oi_1b6d4c92",
            "per_unit_amount": "40.00",
            "product_id": 42,
            "quantity": 1,
            "variant_id": 1007
          }
        ],
        "amount": "40.00",
        "code": null,
        "id": "ord_8e3f1a20",
        "line_item_id": null,
        "name": "Buy two tees, get one free",
        "scope": "order",
        "source": "automatic",
        "source_id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
        "type": "buy_x_get_y",
        "value": "..."
      }
    ],
    "duty_collection_mode": "...",
    "duty_eligible": false,
    "duty_overridden": false,
    "duty_rule_currency": null,
    "duty_rule_id": null,
    "duty_total": "...",
    "exchange_fee_amount": "...",
    "exchange_fee_rate": "...",
    "external_order_id": null,
    "external_source": null,
    "financial_status": "paid",
    "fulfillment_status": "unfulfilled",
    "grand_total": "1770.00",
    "id": "ord_8e3f1a20",
    "invoice_only": false,
    "is_archived": false,
    "is_tax_included": false,
    "is_test": false,
    "items": [
      {
        "base_discount_amount": "...",
        "base_duty_amount": "...",
        "base_tax_amount": "...",
        "base_total": "...",
        "base_unit_price": "...",
        "country_of_origin": null,
        "discount_amount": "...",
        "duties": [
          {
            "amount": "40.00",
            "country_code": "...",
            "currency_code": "USD",
            "harmonized_code": "..."
          }
        ],
        "duty_amount": "...",
        "duty_customs_value": "...",
        "duty_dutiable": false,
        "duty_exclusion_reason": "...",
        "duty_matched_origin": "...",
        "duty_rate": null,
        "duty_rate_desc": "...",
        "duty_rate_type": "...",
        "duty_specific_amount": null,
        "duty_specific_per": "...",
        "duty_weight_kg": "...",
        "external_id": null,
        "fulfilled_quantity": 0,
        "fulfillment_status": "unfulfilled",
        "harmonized_code": "...",
        "id": "ord_8e3f1a20",
        "image_url": "...",
        "matched_hs_code": "...",
        "price_converted": null,
        "product_id": 42,
        "properties": "...",
        "quantity": 1,
        "refunded_quantity": 0,
        "requires_shipping": false,
        "sku": "...",
        "tax_amount": "...",
        "tax_lines": [
          {
            "amount": "40.00",
            "jurisdiction": "...",
            "jurisdiction_type": "...",
            "name": "Buy two tees, get one free",
            "rate": "..."
          }
        ],
        "tax_name": "...",
        "tax_rate": null,
        "taxable": false,
        "title": "...",
        "total": "...",
        "unit_compare_price": null,
        "unit_price": "...",
        "variant_id": 1007,
        "variant_title": "...",
        "vendor": "...",
        "weight": null,
        "weight_unit": "..."
      }
    ],
    "locale": "en-US",
    "location_id": null,
    "market_id": null,
    "metafields_count": 0,
    "note": "...",
    "order_number": "#1042",
    "origin": "...",
    "payment_status": "captured",
    "payments": [
      {
        "amount": "40.00",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "method": "...",
        "provider": "...",
        "status": "..."
      }
    ],
    "rate_source": "...",
    "refunded_total": "...",
    "requires_shipping": false,
    "shipping_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "shipping_total": "0.00",
    "status_slug": "confirmed",
    "subtotal": "...",
    "tags": [
      {
        "id": "ord_8e3f1a20",
        "name": "Buy two tees, get one free",
        "slug": "..."
      }
    ],
    "tax_address_missing": false,
    "tax_exempt": false,
    "tax_total": "16.00",
    "tax_zone_unmatched": false,
    "tenders": [
      {
        "amount": "40.00",
        "base_amount": "...",
        "base_currency_code": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "kind": "..."
      }
    ],
    "total_items": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "version": 2
  }
}

Order fulfilled

EVENT orders/fulfilled App scope: read_orders Staff permission: orders:read

Fired when an order becomes fully fulfilled.

Payload fields

Field	Type	Description
`order.is_archived`	`boolean`	Selectable in the Payload builder
`order.id`	`string`	Selectable in the Payload builder
`order.version`	`integer`	Selectable in the Payload builder
`order.order_number`	`string`	Selectable in the Payload builder
`order.status_slug`	`string`	Selectable in the Payload builder
`order.channel_id`	`string`	Selectable in the Payload builder
`order.channel_type`	`string`	Selectable in the Payload builder
`order.origin`	`string`	Selectable in the Payload builder
`order.market_id`	`string`	Selectable in the Payload builder
`order.location_id`	`string`	Selectable in the Payload builder
`order.created_by_app_id`	`string`	Selectable in the Payload builder
`order.locale`	`string`	Selectable in the Payload builder
`order.external_order_id`	`string`	Selectable in the Payload builder
`order.external_source`	`string`	Selectable in the Payload builder
`order.customer_id`	`string`	Selectable in the Payload builder
`order.customer_email`	`string`	Selectable in the Payload builder
`order.customer_first_name`	`string`	Selectable in the Payload builder
`order.customer_last_name`	`string`	Selectable in the Payload builder
`order.customer_phone`	`string`	Selectable in the Payload builder
`order.customer_tax_id`	`string`	Selectable in the Payload builder
`order.customer_tax_id_type`	`string`	Selectable in the Payload builder
`order.currency_code`	`string`	Selectable in the Payload builder
`order.subtotal`	`string`	Selectable in the Payload builder
`order.discount_total`	`string`	Selectable in the Payload builder
`order.tax_total`	`string`	Selectable in the Payload builder
`order.shipping_total`	`string`	Selectable in the Payload builder
`order.cod_fee_total`	`string`	Selectable in the Payload builder
`order.cod_fee_hsn_code`	`string`	Selectable in the Payload builder
`order.checkout_fee_total`	`string`	Selectable in the Payload builder
`order.duty_total`	`string`	Selectable in the Payload builder
`order.duty_collection_mode`	`string`	Selectable in the Payload builder
`order.duty_eligible`	`boolean`	Selectable in the Payload builder
`order.de_minimis_applied`	`boolean`	Selectable in the Payload builder
`order.duty_overridden`	`boolean`	Selectable in the Payload builder
`order.duty_rule_id`	`string`	Selectable in the Payload builder
`order.duty_rule_currency`	`string`	Selectable in the Payload builder
`order.grand_total`	`string`	Selectable in the Payload builder
`order.refunded_total`	`string`	Selectable in the Payload builder
`order.amount_due_on_delivery`	`string`	Selectable in the Payload builder
`order.base_currency_code`	`string`	Selectable in the Payload builder
`order.base_currency_rate`	`string`	Selectable in the Payload builder
`order.base_subtotal`	`string`	Selectable in the Payload builder
`order.base_discount_total`	`string`	Selectable in the Payload builder
`order.base_tax_total`	`string`	Selectable in the Payload builder
`order.base_shipping_total`	`string`	Selectable in the Payload builder
`order.base_cod_fee_total`	`string`	Selectable in the Payload builder
`order.base_checkout_fee_total`	`string`	Selectable in the Payload builder
`order.base_duty_total`	`string`	Selectable in the Payload builder
`order.base_grand_total`	`string`	Selectable in the Payload builder
`order.base_refunded_total`	`string`	Selectable in the Payload builder
`order.exchange_fee_rate`	`string`	Selectable in the Payload builder
`order.exchange_fee_amount`	`string`	Selectable in the Payload builder
`order.rate_source`	`string`	Selectable in the Payload builder
`order.financial_status`	`string`	Selectable in the Payload builder
`order.fulfillment_status`	`string`	Selectable in the Payload builder
`order.payment_status`	`string`	Selectable in the Payload builder
`order.requires_shipping`	`boolean`	Selectable in the Payload builder
`order.is_tax_included`	`boolean`	Selectable in the Payload builder
`order.tax_address_missing`	`boolean`	Selectable in the Payload builder
`order.tax_zone_unmatched`	`boolean`	Selectable in the Payload builder
`order.tax_exempt`	`boolean`	Selectable in the Payload builder
`order.invoice_only`	`boolean`	Selectable in the Payload builder
`order.is_test`	`boolean`	Selectable in the Payload builder
`order.note`	`string`	Selectable in the Payload builder
`order.total_items`	`integer`	Selectable in the Payload builder
`order.checkout_fee_lines[*].id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].name`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].amount`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].tax_class_id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].is_optional`	`boolean`	Selectable in the Payload builder
`order.checkout_fee_lines[*].overridden`	`boolean`	Selectable in the Payload builder
`order.items[*].id`	`string`	Selectable in the Payload builder
`order.items[*].product_id`	`integer`	Selectable in the Payload builder
`order.items[*].variant_id`	`integer`	Selectable in the Payload builder
`order.items[*].sku`	`string`	Selectable in the Payload builder
`order.items[*].title`	`string`	Selectable in the Payload builder
`order.items[*].variant_title`	`string`	Selectable in the Payload builder
`order.items[*].image_url`	`string`	Selectable in the Payload builder
`order.items[*].quantity`	`integer`	Selectable in the Payload builder
`order.items[*].fulfilled_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].refunded_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].unit_price`	`string`	Selectable in the Payload builder
`order.items[*].unit_compare_price`	`string`	Selectable in the Payload builder
`order.items[*].discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].total`	`string`	Selectable in the Payload builder
`order.items[*].price_converted`	`boolean`	Selectable in the Payload builder
`order.items[*].base_unit_price`	`string`	Selectable in the Payload builder
`order.items[*].base_discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_total`	`string`	Selectable in the Payload builder
`order.items[*].tax_rate`	`string`	Selectable in the Payload builder
`order.items[*].tax_name`	`string`	Selectable in the Payload builder
`order.items[*].taxable`	`boolean`	Selectable in the Payload builder
`order.items[*].weight`	`string`	Selectable in the Payload builder
`order.items[*].weight_unit`	`string`	Selectable in the Payload builder
`order.items[*].country_of_origin`	`string`	Selectable in the Payload builder
`order.items[*].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[*].matched_hs_code`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_desc`	`string`	Selectable in the Payload builder
`order.items[*].duty_dutiable`	`boolean`	Selectable in the Payload builder
`order.items[*].duty_exclusion_reason`	`string`	Selectable in the Payload builder
`order.items[*].duty_customs_value`	`string`	Selectable in the Payload builder
`order.items[*].duty_weight_kg`	`string`	Selectable in the Payload builder
`order.items[*].duty_matched_origin`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_type`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_per`	`string`	Selectable in the Payload builder
`order.items[*].vendor`	`string`	Selectable in the Payload builder
`order.items[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`order.items[*].fulfillment_status`	`string`	Selectable in the Payload builder
`order.items[*].external_id`	`string`	Selectable in the Payload builder
`order.items[*].properties`	`object`	Selectable in the Payload builder
`order.items[].tax_lines[].name`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].rate`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].amount`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction_type`	`string`	Selectable in the Payload builder
`order.items[].duties[].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].country_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].amount`	`string`	Selectable in the Payload builder
`order.items[].duties[].currency_code`	`string`	Selectable in the Payload builder
`order.shipping_address.first_name`	`string`	Selectable in the Payload builder
`order.shipping_address.last_name`	`string`	Selectable in the Payload builder
`order.shipping_address.company`	`string`	Selectable in the Payload builder
`order.shipping_address.address1`	`string`	Selectable in the Payload builder
`order.shipping_address.address2`	`string`	Selectable in the Payload builder
`order.shipping_address.city`	`string`	Selectable in the Payload builder
`order.shipping_address.state`	`string`	Selectable in the Payload builder
`order.shipping_address.postal_code`	`string`	Selectable in the Payload builder
`order.shipping_address.country`	`string`	Selectable in the Payload builder
`order.shipping_address.phone`	`string`	Selectable in the Payload builder
`order.billing_address.first_name`	`string`	Selectable in the Payload builder
`order.billing_address.last_name`	`string`	Selectable in the Payload builder
`order.billing_address.company`	`string`	Selectable in the Payload builder
`order.billing_address.address1`	`string`	Selectable in the Payload builder
`order.billing_address.address2`	`string`	Selectable in the Payload builder
`order.billing_address.city`	`string`	Selectable in the Payload builder
`order.billing_address.state`	`string`	Selectable in the Payload builder
`order.billing_address.postal_code`	`string`	Selectable in the Payload builder
`order.billing_address.country`	`string`	Selectable in the Payload builder
`order.billing_address.phone`	`string`	Selectable in the Payload builder
`order.discounts[*].id`	`string`	Selectable in the Payload builder
`order.discounts[*].name`	`string`	Selectable in the Payload builder
`order.discounts[*].code`	`string`	Selectable in the Payload builder
`order.discounts[*].type`	`string`	Selectable in the Payload builder
`order.discounts[*].value`	`string`	Selectable in the Payload builder
`order.discounts[*].amount`	`string`	Selectable in the Payload builder
`order.discounts[*].scope`	`string`	Selectable in the Payload builder
`order.discounts[*].line_item_id`	`string`	Selectable in the Payload builder
`order.discounts[*].source`	`string`	Selectable in the Payload builder
`order.discounts[*].source_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].order_item_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].product_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].variant_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].quantity`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].per_unit_amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].is_free`	`boolean`	Selectable in the Payload builder
`order.tags[*].id`	`string`	Selectable in the Payload builder
`order.tags[*].name`	`string`	Selectable in the Payload builder
`order.tags[*].slug`	`string`	Selectable in the Payload builder
`order.payments[*].id`	`string`	Selectable in the Payload builder
`order.payments[*].method`	`string`	Selectable in the Payload builder
`order.payments[*].provider`	`string`	Selectable in the Payload builder
`order.payments[*].status`	`string`	Selectable in the Payload builder
`order.payments[*].amount`	`string`	Selectable in the Payload builder
`order.payments[*].currency_code`	`string`	Selectable in the Payload builder
`order.payments[*].created_at`	`string`	Selectable in the Payload builder
`order.tenders[*].id`	`string`	Selectable in the Payload builder
`order.tenders[*].kind`	`string`	Selectable in the Payload builder
`order.tenders[*].amount`	`string`	Selectable in the Payload builder
`order.tenders[*].currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].base_amount`	`string`	Selectable in the Payload builder
`order.tenders[*].base_currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].created_at`	`string`	Selectable in the Payload builder
`order.metafields_count`	`integer`	Selectable in the Payload builder
`order.created_at`	`string`	Selectable in the Payload builder
`order.updated_at`	`string`	Selectable in the Payload builder
`order.cancelled_at`	`string`	Selectable in the Payload builder
`order.completed_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "order": {
    "amount_due_on_delivery": "...",
    "base_checkout_fee_total": "...",
    "base_cod_fee_total": "...",
    "base_currency_code": "...",
    "base_currency_rate": "...",
    "base_discount_total": "...",
    "base_duty_total": "...",
    "base_grand_total": "...",
    "base_refunded_total": "...",
    "base_shipping_total": "...",
    "base_subtotal": "...",
    "base_tax_total": "...",
    "billing_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "cancelled_at": null,
    "channel_id": null,
    "channel_type": null,
    "checkout_fee_lines": [
      {
        "amount": "40.00",
        "id": "ord_8e3f1a20",
        "is_optional": false,
        "name": "Buy two tees, get one free",
        "overridden": false,
        "tax_class_id": "..."
      }
    ],
    "checkout_fee_total": "...",
    "cod_fee_hsn_code": "...",
    "cod_fee_total": "...",
    "completed_at": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "created_by_app_id": null,
    "currency_code": "USD",
    "customer_email": "...",
    "customer_first_name": "...",
    "customer_id": null,
    "customer_last_name": "...",
    "customer_phone": "...",
    "customer_tax_id": null,
    "customer_tax_id_type": null,
    "de_minimis_applied": false,
    "discount_total": "40.00",
    "discounts": [
      {
        "allocations": [
          {
            "amount": "40.00",
            "is_free": true,
            "order_item_id": "oi_1b6d4c92",
            "per_unit_amount": "40.00",
            "product_id": 42,
            "quantity": 1,
            "variant_id": 1007
          }
        ],
        "amount": "40.00",
        "code": null,
        "id": "ord_8e3f1a20",
        "line_item_id": null,
        "name": "Buy two tees, get one free",
        "scope": "order",
        "source": "automatic",
        "source_id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
        "type": "buy_x_get_y",
        "value": "..."
      }
    ],
    "duty_collection_mode": "...",
    "duty_eligible": false,
    "duty_overridden": false,
    "duty_rule_currency": null,
    "duty_rule_id": null,
    "duty_total": "...",
    "exchange_fee_amount": "...",
    "exchange_fee_rate": "...",
    "external_order_id": null,
    "external_source": null,
    "financial_status": "paid",
    "fulfillment_status": "unfulfilled",
    "grand_total": "216.00",
    "id": "ord_8e3f1a20",
    "invoice_only": false,
    "is_archived": false,
    "is_tax_included": false,
    "is_test": false,
    "items": [
      {
        "base_discount_amount": "...",
        "base_duty_amount": "...",
        "base_tax_amount": "...",
        "base_total": "...",
        "base_unit_price": "...",
        "country_of_origin": null,
        "discount_amount": "...",
        "duties": [
          {
            "amount": "40.00",
            "country_code": "...",
            "currency_code": "USD",
            "harmonized_code": "..."
          }
        ],
        "duty_amount": "...",
        "duty_customs_value": "...",
        "duty_dutiable": false,
        "duty_exclusion_reason": "...",
        "duty_matched_origin": "...",
        "duty_rate": null,
        "duty_rate_desc": "...",
        "duty_rate_type": "...",
        "duty_specific_amount": null,
        "duty_specific_per": "...",
        "duty_weight_kg": "...",
        "external_id": null,
        "fulfilled_quantity": 0,
        "fulfillment_status": "unfulfilled",
        "harmonized_code": "...",
        "id": "ord_8e3f1a20",
        "image_url": "...",
        "matched_hs_code": "...",
        "price_converted": null,
        "product_id": 42,
        "properties": "...",
        "quantity": 1,
        "refunded_quantity": 0,
        "requires_shipping": false,
        "sku": "...",
        "tax_amount": "...",
        "tax_lines": [
          {
            "amount": "40.00",
            "jurisdiction": "...",
            "jurisdiction_type": "...",
            "name": "Buy two tees, get one free",
            "rate": "..."
          }
        ],
        "tax_name": "...",
        "tax_rate": null,
        "taxable": false,
        "title": "...",
        "total": "...",
        "unit_compare_price": null,
        "unit_price": "...",
        "variant_id": 1007,
        "variant_title": "...",
        "vendor": "...",
        "weight": null,
        "weight_unit": "..."
      }
    ],
    "locale": "en-US",
    "location_id": null,
    "market_id": null,
    "metafields_count": 0,
    "note": "...",
    "order_number": "#1042",
    "origin": "...",
    "payment_status": "captured",
    "payments": [
      {
        "amount": "40.00",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "method": "...",
        "provider": "...",
        "status": "..."
      }
    ],
    "rate_source": "...",
    "refunded_total": "...",
    "requires_shipping": false,
    "shipping_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "shipping_total": "0.00",
    "status_slug": "confirmed",
    "subtotal": "...",
    "tags": [
      {
        "id": "ord_8e3f1a20",
        "name": "Buy two tees, get one free",
        "slug": "..."
      }
    ],
    "tax_address_missing": false,
    "tax_exempt": false,
    "tax_total": "16.00",
    "tax_zone_unmatched": false,
    "tenders": [
      {
        "amount": "40.00",
        "base_amount": "...",
        "base_currency_code": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "kind": "..."
      }
    ],
    "total_items": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "version": 0
  }
}

Order paid

EVENT orders/paid App scope: read_orders Staff permission: orders:read

Fired when an order becomes fully paid.

Payload fields

Field	Type	Description
`order.is_archived`	`boolean`	Selectable in the Payload builder
`order.id`	`string`	Selectable in the Payload builder
`order.version`	`integer`	Selectable in the Payload builder
`order.order_number`	`string`	Selectable in the Payload builder
`order.status_slug`	`string`	Selectable in the Payload builder
`order.channel_id`	`string`	Selectable in the Payload builder
`order.channel_type`	`string`	Selectable in the Payload builder
`order.origin`	`string`	Selectable in the Payload builder
`order.market_id`	`string`	Selectable in the Payload builder
`order.location_id`	`string`	Selectable in the Payload builder
`order.created_by_app_id`	`string`	Selectable in the Payload builder
`order.locale`	`string`	Selectable in the Payload builder
`order.external_order_id`	`string`	Selectable in the Payload builder
`order.external_source`	`string`	Selectable in the Payload builder
`order.customer_id`	`string`	Selectable in the Payload builder
`order.customer_email`	`string`	Selectable in the Payload builder
`order.customer_first_name`	`string`	Selectable in the Payload builder
`order.customer_last_name`	`string`	Selectable in the Payload builder
`order.customer_phone`	`string`	Selectable in the Payload builder
`order.customer_tax_id`	`string`	Selectable in the Payload builder
`order.customer_tax_id_type`	`string`	Selectable in the Payload builder
`order.currency_code`	`string`	Selectable in the Payload builder
`order.subtotal`	`string`	Selectable in the Payload builder
`order.discount_total`	`string`	Selectable in the Payload builder
`order.tax_total`	`string`	Selectable in the Payload builder
`order.shipping_total`	`string`	Selectable in the Payload builder
`order.cod_fee_total`	`string`	Selectable in the Payload builder
`order.cod_fee_hsn_code`	`string`	Selectable in the Payload builder
`order.checkout_fee_total`	`string`	Selectable in the Payload builder
`order.duty_total`	`string`	Selectable in the Payload builder
`order.duty_collection_mode`	`string`	Selectable in the Payload builder
`order.duty_eligible`	`boolean`	Selectable in the Payload builder
`order.de_minimis_applied`	`boolean`	Selectable in the Payload builder
`order.duty_overridden`	`boolean`	Selectable in the Payload builder
`order.duty_rule_id`	`string`	Selectable in the Payload builder
`order.duty_rule_currency`	`string`	Selectable in the Payload builder
`order.grand_total`	`string`	Selectable in the Payload builder
`order.refunded_total`	`string`	Selectable in the Payload builder
`order.amount_due_on_delivery`	`string`	Selectable in the Payload builder
`order.base_currency_code`	`string`	Selectable in the Payload builder
`order.base_currency_rate`	`string`	Selectable in the Payload builder
`order.base_subtotal`	`string`	Selectable in the Payload builder
`order.base_discount_total`	`string`	Selectable in the Payload builder
`order.base_tax_total`	`string`	Selectable in the Payload builder
`order.base_shipping_total`	`string`	Selectable in the Payload builder
`order.base_cod_fee_total`	`string`	Selectable in the Payload builder
`order.base_checkout_fee_total`	`string`	Selectable in the Payload builder
`order.base_duty_total`	`string`	Selectable in the Payload builder
`order.base_grand_total`	`string`	Selectable in the Payload builder
`order.base_refunded_total`	`string`	Selectable in the Payload builder
`order.exchange_fee_rate`	`string`	Selectable in the Payload builder
`order.exchange_fee_amount`	`string`	Selectable in the Payload builder
`order.rate_source`	`string`	Selectable in the Payload builder
`order.financial_status`	`string`	Selectable in the Payload builder
`order.fulfillment_status`	`string`	Selectable in the Payload builder
`order.payment_status`	`string`	Selectable in the Payload builder
`order.requires_shipping`	`boolean`	Selectable in the Payload builder
`order.is_tax_included`	`boolean`	Selectable in the Payload builder
`order.tax_address_missing`	`boolean`	Selectable in the Payload builder
`order.tax_zone_unmatched`	`boolean`	Selectable in the Payload builder
`order.tax_exempt`	`boolean`	Selectable in the Payload builder
`order.invoice_only`	`boolean`	Selectable in the Payload builder
`order.is_test`	`boolean`	Selectable in the Payload builder
`order.note`	`string`	Selectable in the Payload builder
`order.total_items`	`integer`	Selectable in the Payload builder
`order.checkout_fee_lines[*].id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].name`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].amount`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].tax_class_id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].is_optional`	`boolean`	Selectable in the Payload builder
`order.checkout_fee_lines[*].overridden`	`boolean`	Selectable in the Payload builder
`order.items[*].id`	`string`	Selectable in the Payload builder
`order.items[*].product_id`	`integer`	Selectable in the Payload builder
`order.items[*].variant_id`	`integer`	Selectable in the Payload builder
`order.items[*].sku`	`string`	Selectable in the Payload builder
`order.items[*].title`	`string`	Selectable in the Payload builder
`order.items[*].variant_title`	`string`	Selectable in the Payload builder
`order.items[*].image_url`	`string`	Selectable in the Payload builder
`order.items[*].quantity`	`integer`	Selectable in the Payload builder
`order.items[*].fulfilled_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].refunded_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].unit_price`	`string`	Selectable in the Payload builder
`order.items[*].unit_compare_price`	`string`	Selectable in the Payload builder
`order.items[*].discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].total`	`string`	Selectable in the Payload builder
`order.items[*].price_converted`	`boolean`	Selectable in the Payload builder
`order.items[*].base_unit_price`	`string`	Selectable in the Payload builder
`order.items[*].base_discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_total`	`string`	Selectable in the Payload builder
`order.items[*].tax_rate`	`string`	Selectable in the Payload builder
`order.items[*].tax_name`	`string`	Selectable in the Payload builder
`order.items[*].taxable`	`boolean`	Selectable in the Payload builder
`order.items[*].weight`	`string`	Selectable in the Payload builder
`order.items[*].weight_unit`	`string`	Selectable in the Payload builder
`order.items[*].country_of_origin`	`string`	Selectable in the Payload builder
`order.items[*].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[*].matched_hs_code`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_desc`	`string`	Selectable in the Payload builder
`order.items[*].duty_dutiable`	`boolean`	Selectable in the Payload builder
`order.items[*].duty_exclusion_reason`	`string`	Selectable in the Payload builder
`order.items[*].duty_customs_value`	`string`	Selectable in the Payload builder
`order.items[*].duty_weight_kg`	`string`	Selectable in the Payload builder
`order.items[*].duty_matched_origin`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_type`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_per`	`string`	Selectable in the Payload builder
`order.items[*].vendor`	`string`	Selectable in the Payload builder
`order.items[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`order.items[*].fulfillment_status`	`string`	Selectable in the Payload builder
`order.items[*].external_id`	`string`	Selectable in the Payload builder
`order.items[*].properties`	`object`	Selectable in the Payload builder
`order.items[].tax_lines[].name`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].rate`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].amount`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction_type`	`string`	Selectable in the Payload builder
`order.items[].duties[].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].country_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].amount`	`string`	Selectable in the Payload builder
`order.items[].duties[].currency_code`	`string`	Selectable in the Payload builder
`order.shipping_address.first_name`	`string`	Selectable in the Payload builder
`order.shipping_address.last_name`	`string`	Selectable in the Payload builder
`order.shipping_address.company`	`string`	Selectable in the Payload builder
`order.shipping_address.address1`	`string`	Selectable in the Payload builder
`order.shipping_address.address2`	`string`	Selectable in the Payload builder
`order.shipping_address.city`	`string`	Selectable in the Payload builder
`order.shipping_address.state`	`string`	Selectable in the Payload builder
`order.shipping_address.postal_code`	`string`	Selectable in the Payload builder
`order.shipping_address.country`	`string`	Selectable in the Payload builder
`order.shipping_address.phone`	`string`	Selectable in the Payload builder
`order.billing_address.first_name`	`string`	Selectable in the Payload builder
`order.billing_address.last_name`	`string`	Selectable in the Payload builder
`order.billing_address.company`	`string`	Selectable in the Payload builder
`order.billing_address.address1`	`string`	Selectable in the Payload builder
`order.billing_address.address2`	`string`	Selectable in the Payload builder
`order.billing_address.city`	`string`	Selectable in the Payload builder
`order.billing_address.state`	`string`	Selectable in the Payload builder
`order.billing_address.postal_code`	`string`	Selectable in the Payload builder
`order.billing_address.country`	`string`	Selectable in the Payload builder
`order.billing_address.phone`	`string`	Selectable in the Payload builder
`order.discounts[*].id`	`string`	Selectable in the Payload builder
`order.discounts[*].name`	`string`	Selectable in the Payload builder
`order.discounts[*].code`	`string`	Selectable in the Payload builder
`order.discounts[*].type`	`string`	Selectable in the Payload builder
`order.discounts[*].value`	`string`	Selectable in the Payload builder
`order.discounts[*].amount`	`string`	Selectable in the Payload builder
`order.discounts[*].scope`	`string`	Selectable in the Payload builder
`order.discounts[*].line_item_id`	`string`	Selectable in the Payload builder
`order.discounts[*].source`	`string`	Selectable in the Payload builder
`order.discounts[*].source_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].order_item_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].product_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].variant_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].quantity`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].per_unit_amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].is_free`	`boolean`	Selectable in the Payload builder
`order.tags[*].id`	`string`	Selectable in the Payload builder
`order.tags[*].name`	`string`	Selectable in the Payload builder
`order.tags[*].slug`	`string`	Selectable in the Payload builder
`order.payments[*].id`	`string`	Selectable in the Payload builder
`order.payments[*].method`	`string`	Selectable in the Payload builder
`order.payments[*].provider`	`string`	Selectable in the Payload builder
`order.payments[*].status`	`string`	Selectable in the Payload builder
`order.payments[*].amount`	`string`	Selectable in the Payload builder
`order.payments[*].currency_code`	`string`	Selectable in the Payload builder
`order.payments[*].created_at`	`string`	Selectable in the Payload builder
`order.tenders[*].id`	`string`	Selectable in the Payload builder
`order.tenders[*].kind`	`string`	Selectable in the Payload builder
`order.tenders[*].amount`	`string`	Selectable in the Payload builder
`order.tenders[*].currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].base_amount`	`string`	Selectable in the Payload builder
`order.tenders[*].base_currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].created_at`	`string`	Selectable in the Payload builder
`order.metafields_count`	`integer`	Selectable in the Payload builder
`order.created_at`	`string`	Selectable in the Payload builder
`order.updated_at`	`string`	Selectable in the Payload builder
`order.cancelled_at`	`string`	Selectable in the Payload builder
`order.completed_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "order": {
    "amount_due_on_delivery": "...",
    "base_checkout_fee_total": "...",
    "base_cod_fee_total": "...",
    "base_currency_code": "...",
    "base_currency_rate": "...",
    "base_discount_total": "...",
    "base_duty_total": "...",
    "base_grand_total": "...",
    "base_refunded_total": "...",
    "base_shipping_total": "...",
    "base_subtotal": "...",
    "base_tax_total": "...",
    "billing_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "cancelled_at": null,
    "channel_id": null,
    "channel_type": null,
    "checkout_fee_lines": [
      {
        "amount": "40.00",
        "id": "ord_8e3f1a20",
        "is_optional": false,
        "name": "Buy two tees, get one free",
        "overridden": false,
        "tax_class_id": "..."
      }
    ],
    "checkout_fee_total": "...",
    "cod_fee_hsn_code": "...",
    "cod_fee_total": "...",
    "completed_at": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "created_by_app_id": null,
    "currency_code": "USD",
    "customer_email": "...",
    "customer_first_name": "...",
    "customer_id": null,
    "customer_last_name": "...",
    "customer_phone": "...",
    "customer_tax_id": null,
    "customer_tax_id_type": null,
    "de_minimis_applied": false,
    "discount_total": "40.00",
    "discounts": [
      {
        "allocations": [
          {
            "amount": "40.00",
            "is_free": true,
            "order_item_id": "oi_1b6d4c92",
            "per_unit_amount": "40.00",
            "product_id": 42,
            "quantity": 1,
            "variant_id": 1007
          }
        ],
        "amount": "40.00",
        "code": null,
        "id": "ord_8e3f1a20",
        "line_item_id": null,
        "name": "Buy two tees, get one free",
        "scope": "order",
        "source": "automatic",
        "source_id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
        "type": "buy_x_get_y",
        "value": "..."
      }
    ],
    "duty_collection_mode": "...",
    "duty_eligible": false,
    "duty_overridden": false,
    "duty_rule_currency": null,
    "duty_rule_id": null,
    "duty_total": "...",
    "exchange_fee_amount": "...",
    "exchange_fee_rate": "...",
    "external_order_id": null,
    "external_source": null,
    "financial_status": "paid",
    "fulfillment_status": "unfulfilled",
    "grand_total": "216.00",
    "id": "ord_8e3f1a20",
    "invoice_only": false,
    "is_archived": false,
    "is_tax_included": false,
    "is_test": false,
    "items": [
      {
        "base_discount_amount": "...",
        "base_duty_amount": "...",
        "base_tax_amount": "...",
        "base_total": "...",
        "base_unit_price": "...",
        "country_of_origin": null,
        "discount_amount": "...",
        "duties": [
          {
            "amount": "40.00",
            "country_code": "...",
            "currency_code": "USD",
            "harmonized_code": "..."
          }
        ],
        "duty_amount": "...",
        "duty_customs_value": "...",
        "duty_dutiable": false,
        "duty_exclusion_reason": "...",
        "duty_matched_origin": "...",
        "duty_rate": null,
        "duty_rate_desc": "...",
        "duty_rate_type": "...",
        "duty_specific_amount": null,
        "duty_specific_per": "...",
        "duty_weight_kg": "...",
        "external_id": null,
        "fulfilled_quantity": 0,
        "fulfillment_status": "unfulfilled",
        "harmonized_code": "...",
        "id": "ord_8e3f1a20",
        "image_url": "...",
        "matched_hs_code": "...",
        "price_converted": null,
        "product_id": 42,
        "properties": "...",
        "quantity": 1,
        "refunded_quantity": 0,
        "requires_shipping": false,
        "sku": "...",
        "tax_amount": "...",
        "tax_lines": [
          {
            "amount": "40.00",
            "jurisdiction": "...",
            "jurisdiction_type": "...",
            "name": "Buy two tees, get one free",
            "rate": "..."
          }
        ],
        "tax_name": "...",
        "tax_rate": null,
        "taxable": false,
        "title": "...",
        "total": "...",
        "unit_compare_price": null,
        "unit_price": "...",
        "variant_id": 1007,
        "variant_title": "...",
        "vendor": "...",
        "weight": null,
        "weight_unit": "..."
      }
    ],
    "locale": "en-US",
    "location_id": null,
    "market_id": null,
    "metafields_count": 0,
    "note": "...",
    "order_number": "#1042",
    "origin": "...",
    "payment_status": "captured",
    "payments": [
      {
        "amount": "40.00",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "method": "...",
        "provider": "...",
        "status": "..."
      }
    ],
    "rate_source": "...",
    "refunded_total": "...",
    "requires_shipping": false,
    "shipping_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "shipping_total": "0.00",
    "status_slug": "confirmed",
    "subtotal": "...",
    "tags": [
      {
        "id": "ord_8e3f1a20",
        "name": "Buy two tees, get one free",
        "slug": "..."
      }
    ],
    "tax_address_missing": false,
    "tax_exempt": false,
    "tax_total": "16.00",
    "tax_zone_unmatched": false,
    "tenders": [
      {
        "amount": "40.00",
        "base_amount": "...",
        "base_currency_code": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "kind": "..."
      }
    ],
    "total_items": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "version": 0
  }
}

Order payment failed

EVENT orders/payment_failed App scope: read_orders Staff permission: orders:read

Fired when a payment attempt for an order fails.

Payload fields

Field	Type	Description
`order.is_archived`	`boolean`	Selectable in the Payload builder
`order.id`	`string`	Selectable in the Payload builder
`order.version`	`integer`	Selectable in the Payload builder
`order.order_number`	`string`	Selectable in the Payload builder
`order.status_slug`	`string`	Selectable in the Payload builder
`order.channel_id`	`string`	Selectable in the Payload builder
`order.channel_type`	`string`	Selectable in the Payload builder
`order.origin`	`string`	Selectable in the Payload builder
`order.market_id`	`string`	Selectable in the Payload builder
`order.location_id`	`string`	Selectable in the Payload builder
`order.created_by_app_id`	`string`	Selectable in the Payload builder
`order.locale`	`string`	Selectable in the Payload builder
`order.external_order_id`	`string`	Selectable in the Payload builder
`order.external_source`	`string`	Selectable in the Payload builder
`order.customer_id`	`string`	Selectable in the Payload builder
`order.customer_email`	`string`	Selectable in the Payload builder
`order.customer_first_name`	`string`	Selectable in the Payload builder
`order.customer_last_name`	`string`	Selectable in the Payload builder
`order.customer_phone`	`string`	Selectable in the Payload builder
`order.customer_tax_id`	`string`	Selectable in the Payload builder
`order.customer_tax_id_type`	`string`	Selectable in the Payload builder
`order.currency_code`	`string`	Selectable in the Payload builder
`order.subtotal`	`string`	Selectable in the Payload builder
`order.discount_total`	`string`	Selectable in the Payload builder
`order.tax_total`	`string`	Selectable in the Payload builder
`order.shipping_total`	`string`	Selectable in the Payload builder
`order.cod_fee_total`	`string`	Selectable in the Payload builder
`order.cod_fee_hsn_code`	`string`	Selectable in the Payload builder
`order.checkout_fee_total`	`string`	Selectable in the Payload builder
`order.duty_total`	`string`	Selectable in the Payload builder
`order.duty_collection_mode`	`string`	Selectable in the Payload builder
`order.duty_eligible`	`boolean`	Selectable in the Payload builder
`order.de_minimis_applied`	`boolean`	Selectable in the Payload builder
`order.duty_overridden`	`boolean`	Selectable in the Payload builder
`order.duty_rule_id`	`string`	Selectable in the Payload builder
`order.duty_rule_currency`	`string`	Selectable in the Payload builder
`order.grand_total`	`string`	Selectable in the Payload builder
`order.refunded_total`	`string`	Selectable in the Payload builder
`order.amount_due_on_delivery`	`string`	Selectable in the Payload builder
`order.base_currency_code`	`string`	Selectable in the Payload builder
`order.base_currency_rate`	`string`	Selectable in the Payload builder
`order.base_subtotal`	`string`	Selectable in the Payload builder
`order.base_discount_total`	`string`	Selectable in the Payload builder
`order.base_tax_total`	`string`	Selectable in the Payload builder
`order.base_shipping_total`	`string`	Selectable in the Payload builder
`order.base_cod_fee_total`	`string`	Selectable in the Payload builder
`order.base_checkout_fee_total`	`string`	Selectable in the Payload builder
`order.base_duty_total`	`string`	Selectable in the Payload builder
`order.base_grand_total`	`string`	Selectable in the Payload builder
`order.base_refunded_total`	`string`	Selectable in the Payload builder
`order.exchange_fee_rate`	`string`	Selectable in the Payload builder
`order.exchange_fee_amount`	`string`	Selectable in the Payload builder
`order.rate_source`	`string`	Selectable in the Payload builder
`order.financial_status`	`string`	Selectable in the Payload builder
`order.fulfillment_status`	`string`	Selectable in the Payload builder
`order.payment_status`	`string`	Selectable in the Payload builder
`order.requires_shipping`	`boolean`	Selectable in the Payload builder
`order.is_tax_included`	`boolean`	Selectable in the Payload builder
`order.tax_address_missing`	`boolean`	Selectable in the Payload builder
`order.tax_zone_unmatched`	`boolean`	Selectable in the Payload builder
`order.tax_exempt`	`boolean`	Selectable in the Payload builder
`order.invoice_only`	`boolean`	Selectable in the Payload builder
`order.is_test`	`boolean`	Selectable in the Payload builder
`order.note`	`string`	Selectable in the Payload builder
`order.total_items`	`integer`	Selectable in the Payload builder
`order.checkout_fee_lines[*].id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].name`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].amount`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].tax_class_id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].is_optional`	`boolean`	Selectable in the Payload builder
`order.checkout_fee_lines[*].overridden`	`boolean`	Selectable in the Payload builder
`order.items[*].id`	`string`	Selectable in the Payload builder
`order.items[*].product_id`	`integer`	Selectable in the Payload builder
`order.items[*].variant_id`	`integer`	Selectable in the Payload builder
`order.items[*].sku`	`string`	Selectable in the Payload builder
`order.items[*].title`	`string`	Selectable in the Payload builder
`order.items[*].variant_title`	`string`	Selectable in the Payload builder
`order.items[*].image_url`	`string`	Selectable in the Payload builder
`order.items[*].quantity`	`integer`	Selectable in the Payload builder
`order.items[*].fulfilled_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].refunded_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].unit_price`	`string`	Selectable in the Payload builder
`order.items[*].unit_compare_price`	`string`	Selectable in the Payload builder
`order.items[*].discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].total`	`string`	Selectable in the Payload builder
`order.items[*].price_converted`	`boolean`	Selectable in the Payload builder
`order.items[*].base_unit_price`	`string`	Selectable in the Payload builder
`order.items[*].base_discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_total`	`string`	Selectable in the Payload builder
`order.items[*].tax_rate`	`string`	Selectable in the Payload builder
`order.items[*].tax_name`	`string`	Selectable in the Payload builder
`order.items[*].taxable`	`boolean`	Selectable in the Payload builder
`order.items[*].weight`	`string`	Selectable in the Payload builder
`order.items[*].weight_unit`	`string`	Selectable in the Payload builder
`order.items[*].country_of_origin`	`string`	Selectable in the Payload builder
`order.items[*].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[*].matched_hs_code`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_desc`	`string`	Selectable in the Payload builder
`order.items[*].duty_dutiable`	`boolean`	Selectable in the Payload builder
`order.items[*].duty_exclusion_reason`	`string`	Selectable in the Payload builder
`order.items[*].duty_customs_value`	`string`	Selectable in the Payload builder
`order.items[*].duty_weight_kg`	`string`	Selectable in the Payload builder
`order.items[*].duty_matched_origin`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_type`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_per`	`string`	Selectable in the Payload builder
`order.items[*].vendor`	`string`	Selectable in the Payload builder
`order.items[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`order.items[*].fulfillment_status`	`string`	Selectable in the Payload builder
`order.items[*].external_id`	`string`	Selectable in the Payload builder
`order.items[*].properties`	`object`	Selectable in the Payload builder
`order.items[].tax_lines[].name`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].rate`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].amount`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction_type`	`string`	Selectable in the Payload builder
`order.items[].duties[].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].country_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].amount`	`string`	Selectable in the Payload builder
`order.items[].duties[].currency_code`	`string`	Selectable in the Payload builder
`order.shipping_address.first_name`	`string`	Selectable in the Payload builder
`order.shipping_address.last_name`	`string`	Selectable in the Payload builder
`order.shipping_address.company`	`string`	Selectable in the Payload builder
`order.shipping_address.address1`	`string`	Selectable in the Payload builder
`order.shipping_address.address2`	`string`	Selectable in the Payload builder
`order.shipping_address.city`	`string`	Selectable in the Payload builder
`order.shipping_address.state`	`string`	Selectable in the Payload builder
`order.shipping_address.postal_code`	`string`	Selectable in the Payload builder
`order.shipping_address.country`	`string`	Selectable in the Payload builder
`order.shipping_address.phone`	`string`	Selectable in the Payload builder
`order.billing_address.first_name`	`string`	Selectable in the Payload builder
`order.billing_address.last_name`	`string`	Selectable in the Payload builder
`order.billing_address.company`	`string`	Selectable in the Payload builder
`order.billing_address.address1`	`string`	Selectable in the Payload builder
`order.billing_address.address2`	`string`	Selectable in the Payload builder
`order.billing_address.city`	`string`	Selectable in the Payload builder
`order.billing_address.state`	`string`	Selectable in the Payload builder
`order.billing_address.postal_code`	`string`	Selectable in the Payload builder
`order.billing_address.country`	`string`	Selectable in the Payload builder
`order.billing_address.phone`	`string`	Selectable in the Payload builder
`order.discounts[*].id`	`string`	Selectable in the Payload builder
`order.discounts[*].name`	`string`	Selectable in the Payload builder
`order.discounts[*].code`	`string`	Selectable in the Payload builder
`order.discounts[*].type`	`string`	Selectable in the Payload builder
`order.discounts[*].value`	`string`	Selectable in the Payload builder
`order.discounts[*].amount`	`string`	Selectable in the Payload builder
`order.discounts[*].scope`	`string`	Selectable in the Payload builder
`order.discounts[*].line_item_id`	`string`	Selectable in the Payload builder
`order.discounts[*].source`	`string`	Selectable in the Payload builder
`order.discounts[*].source_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].order_item_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].product_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].variant_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].quantity`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].per_unit_amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].is_free`	`boolean`	Selectable in the Payload builder
`order.tags[*].id`	`string`	Selectable in the Payload builder
`order.tags[*].name`	`string`	Selectable in the Payload builder
`order.tags[*].slug`	`string`	Selectable in the Payload builder
`order.payments[*].id`	`string`	Selectable in the Payload builder
`order.payments[*].method`	`string`	Selectable in the Payload builder
`order.payments[*].provider`	`string`	Selectable in the Payload builder
`order.payments[*].status`	`string`	Selectable in the Payload builder
`order.payments[*].amount`	`string`	Selectable in the Payload builder
`order.payments[*].currency_code`	`string`	Selectable in the Payload builder
`order.payments[*].created_at`	`string`	Selectable in the Payload builder
`order.tenders[*].id`	`string`	Selectable in the Payload builder
`order.tenders[*].kind`	`string`	Selectable in the Payload builder
`order.tenders[*].amount`	`string`	Selectable in the Payload builder
`order.tenders[*].currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].base_amount`	`string`	Selectable in the Payload builder
`order.tenders[*].base_currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].created_at`	`string`	Selectable in the Payload builder
`order.metafields_count`	`integer`	Selectable in the Payload builder
`order.created_at`	`string`	Selectable in the Payload builder
`order.updated_at`	`string`	Selectable in the Payload builder
`order.cancelled_at`	`string`	Selectable in the Payload builder
`order.completed_at`	`string`	Selectable in the Payload builder
`payment_session_id`	`string`	Selectable in the Payload builder
`provider_transaction_id`	`string`	Selectable in the Payload builder
`failure_code`	`string`	Selectable in the Payload builder
`failed_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "failed_at": "...",
  "failure_code": "...",
  "order": {
    "amount_due_on_delivery": "...",
    "base_checkout_fee_total": "...",
    "base_cod_fee_total": "...",
    "base_currency_code": "...",
    "base_currency_rate": "...",
    "base_discount_total": "...",
    "base_duty_total": "...",
    "base_grand_total": "...",
    "base_refunded_total": "...",
    "base_shipping_total": "...",
    "base_subtotal": "...",
    "base_tax_total": "...",
    "billing_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "cancelled_at": null,
    "channel_id": null,
    "channel_type": null,
    "checkout_fee_lines": [
      {
        "amount": "40.00",
        "id": "ord_8e3f1a20",
        "is_optional": false,
        "name": "Buy two tees, get one free",
        "overridden": false,
        "tax_class_id": "..."
      }
    ],
    "checkout_fee_total": "...",
    "cod_fee_hsn_code": "...",
    "cod_fee_total": "...",
    "completed_at": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "created_by_app_id": null,
    "currency_code": "USD",
    "customer_email": "...",
    "customer_first_name": "...",
    "customer_id": null,
    "customer_last_name": "...",
    "customer_phone": "...",
    "customer_tax_id": null,
    "customer_tax_id_type": null,
    "de_minimis_applied": false,
    "discount_total": "40.00",
    "discounts": [
      {
        "allocations": [
          {
            "amount": "40.00",
            "is_free": true,
            "order_item_id": "oi_1b6d4c92",
            "per_unit_amount": "40.00",
            "product_id": 42,
            "quantity": 1,
            "variant_id": 1007
          }
        ],
        "amount": "40.00",
        "code": null,
        "id": "ord_8e3f1a20",
        "line_item_id": null,
        "name": "Buy two tees, get one free",
        "scope": "order",
        "source": "automatic",
        "source_id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
        "type": "buy_x_get_y",
        "value": "..."
      }
    ],
    "duty_collection_mode": "...",
    "duty_eligible": false,
    "duty_overridden": false,
    "duty_rule_currency": null,
    "duty_rule_id": null,
    "duty_total": "...",
    "exchange_fee_amount": "...",
    "exchange_fee_rate": "...",
    "external_order_id": null,
    "external_source": null,
    "financial_status": "paid",
    "fulfillment_status": "unfulfilled",
    "grand_total": "216.00",
    "id": "ord_8e3f1a20",
    "invoice_only": false,
    "is_archived": false,
    "is_tax_included": false,
    "is_test": false,
    "items": [
      {
        "base_discount_amount": "...",
        "base_duty_amount": "...",
        "base_tax_amount": "...",
        "base_total": "...",
        "base_unit_price": "...",
        "country_of_origin": null,
        "discount_amount": "...",
        "duties": [
          {
            "amount": "40.00",
            "country_code": "...",
            "currency_code": "USD",
            "harmonized_code": "..."
          }
        ],
        "duty_amount": "...",
        "duty_customs_value": "...",
        "duty_dutiable": false,
        "duty_exclusion_reason": "...",
        "duty_matched_origin": "...",
        "duty_rate": null,
        "duty_rate_desc": "...",
        "duty_rate_type": "...",
        "duty_specific_amount": null,
        "duty_specific_per": "...",
        "duty_weight_kg": "...",
        "external_id": null,
        "fulfilled_quantity": 0,
        "fulfillment_status": "unfulfilled",
        "harmonized_code": "...",
        "id": "ord_8e3f1a20",
        "image_url": "...",
        "matched_hs_code": "...",
        "price_converted": null,
        "product_id": 42,
        "properties": "...",
        "quantity": 1,
        "refunded_quantity": 0,
        "requires_shipping": false,
        "sku": "...",
        "tax_amount": "...",
        "tax_lines": [
          {
            "amount": "40.00",
            "jurisdiction": "...",
            "jurisdiction_type": "...",
            "name": "Buy two tees, get one free",
            "rate": "..."
          }
        ],
        "tax_name": "...",
        "tax_rate": null,
        "taxable": false,
        "title": "...",
        "total": "...",
        "unit_compare_price": null,
        "unit_price": "...",
        "variant_id": 1007,
        "variant_title": "...",
        "vendor": "...",
        "weight": null,
        "weight_unit": "..."
      }
    ],
    "locale": "en-US",
    "location_id": null,
    "market_id": null,
    "metafields_count": 0,
    "note": "...",
    "order_number": "#1042",
    "origin": "...",
    "payment_status": "captured",
    "payments": [
      {
        "amount": "40.00",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "method": "...",
        "provider": "...",
        "status": "..."
      }
    ],
    "rate_source": "...",
    "refunded_total": "...",
    "requires_shipping": false,
    "shipping_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "shipping_total": "0.00",
    "status_slug": "confirmed",
    "subtotal": "...",
    "tags": [
      {
        "id": "ord_8e3f1a20",
        "name": "Buy two tees, get one free",
        "slug": "..."
      }
    ],
    "tax_address_missing": false,
    "tax_exempt": false,
    "tax_total": "16.00",
    "tax_zone_unmatched": false,
    "tenders": [
      {
        "amount": "40.00",
        "base_amount": "...",
        "base_currency_code": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "kind": "..."
      }
    ],
    "total_items": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "version": 0
  },
  "payment_session_id": "...",
  "provider_transaction_id": "..."
}

Order refunded

EVENT orders/refunded App scope: read_orders Staff permission: orders:read

Fired when a refund is recorded on an order.

Payload fields

Field	Type	Description
`order.is_archived`	`boolean`	Selectable in the Payload builder
`order.id`	`string`	Selectable in the Payload builder
`order.version`	`integer`	Selectable in the Payload builder
`order.order_number`	`string`	Selectable in the Payload builder
`order.status_slug`	`string`	Selectable in the Payload builder
`order.channel_id`	`string`	Selectable in the Payload builder
`order.channel_type`	`string`	Selectable in the Payload builder
`order.origin`	`string`	Selectable in the Payload builder
`order.market_id`	`string`	Selectable in the Payload builder
`order.location_id`	`string`	Selectable in the Payload builder
`order.created_by_app_id`	`string`	Selectable in the Payload builder
`order.locale`	`string`	Selectable in the Payload builder
`order.external_order_id`	`string`	Selectable in the Payload builder
`order.external_source`	`string`	Selectable in the Payload builder
`order.customer_id`	`string`	Selectable in the Payload builder
`order.customer_email`	`string`	Selectable in the Payload builder
`order.customer_first_name`	`string`	Selectable in the Payload builder
`order.customer_last_name`	`string`	Selectable in the Payload builder
`order.customer_phone`	`string`	Selectable in the Payload builder
`order.customer_tax_id`	`string`	Selectable in the Payload builder
`order.customer_tax_id_type`	`string`	Selectable in the Payload builder
`order.currency_code`	`string`	Selectable in the Payload builder
`order.subtotal`	`string`	Selectable in the Payload builder
`order.discount_total`	`string`	Selectable in the Payload builder
`order.tax_total`	`string`	Selectable in the Payload builder
`order.shipping_total`	`string`	Selectable in the Payload builder
`order.cod_fee_total`	`string`	Selectable in the Payload builder
`order.cod_fee_hsn_code`	`string`	Selectable in the Payload builder
`order.checkout_fee_total`	`string`	Selectable in the Payload builder
`order.duty_total`	`string`	Selectable in the Payload builder
`order.duty_collection_mode`	`string`	Selectable in the Payload builder
`order.duty_eligible`	`boolean`	Selectable in the Payload builder
`order.de_minimis_applied`	`boolean`	Selectable in the Payload builder
`order.duty_overridden`	`boolean`	Selectable in the Payload builder
`order.duty_rule_id`	`string`	Selectable in the Payload builder
`order.duty_rule_currency`	`string`	Selectable in the Payload builder
`order.grand_total`	`string`	Selectable in the Payload builder
`order.refunded_total`	`string`	Selectable in the Payload builder
`order.amount_due_on_delivery`	`string`	Selectable in the Payload builder
`order.base_currency_code`	`string`	Selectable in the Payload builder
`order.base_currency_rate`	`string`	Selectable in the Payload builder
`order.base_subtotal`	`string`	Selectable in the Payload builder
`order.base_discount_total`	`string`	Selectable in the Payload builder
`order.base_tax_total`	`string`	Selectable in the Payload builder
`order.base_shipping_total`	`string`	Selectable in the Payload builder
`order.base_cod_fee_total`	`string`	Selectable in the Payload builder
`order.base_checkout_fee_total`	`string`	Selectable in the Payload builder
`order.base_duty_total`	`string`	Selectable in the Payload builder
`order.base_grand_total`	`string`	Selectable in the Payload builder
`order.base_refunded_total`	`string`	Selectable in the Payload builder
`order.exchange_fee_rate`	`string`	Selectable in the Payload builder
`order.exchange_fee_amount`	`string`	Selectable in the Payload builder
`order.rate_source`	`string`	Selectable in the Payload builder
`order.financial_status`	`string`	Selectable in the Payload builder
`order.fulfillment_status`	`string`	Selectable in the Payload builder
`order.payment_status`	`string`	Selectable in the Payload builder
`order.requires_shipping`	`boolean`	Selectable in the Payload builder
`order.is_tax_included`	`boolean`	Selectable in the Payload builder
`order.tax_address_missing`	`boolean`	Selectable in the Payload builder
`order.tax_zone_unmatched`	`boolean`	Selectable in the Payload builder
`order.tax_exempt`	`boolean`	Selectable in the Payload builder
`order.invoice_only`	`boolean`	Selectable in the Payload builder
`order.is_test`	`boolean`	Selectable in the Payload builder
`order.note`	`string`	Selectable in the Payload builder
`order.total_items`	`integer`	Selectable in the Payload builder
`order.checkout_fee_lines[*].id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].name`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].amount`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].tax_class_id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].is_optional`	`boolean`	Selectable in the Payload builder
`order.checkout_fee_lines[*].overridden`	`boolean`	Selectable in the Payload builder
`order.items[*].id`	`string`	Selectable in the Payload builder
`order.items[*].product_id`	`integer`	Selectable in the Payload builder
`order.items[*].variant_id`	`integer`	Selectable in the Payload builder
`order.items[*].sku`	`string`	Selectable in the Payload builder
`order.items[*].title`	`string`	Selectable in the Payload builder
`order.items[*].variant_title`	`string`	Selectable in the Payload builder
`order.items[*].image_url`	`string`	Selectable in the Payload builder
`order.items[*].quantity`	`integer`	Selectable in the Payload builder
`order.items[*].fulfilled_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].refunded_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].unit_price`	`string`	Selectable in the Payload builder
`order.items[*].unit_compare_price`	`string`	Selectable in the Payload builder
`order.items[*].discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].total`	`string`	Selectable in the Payload builder
`order.items[*].price_converted`	`boolean`	Selectable in the Payload builder
`order.items[*].base_unit_price`	`string`	Selectable in the Payload builder
`order.items[*].base_discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_total`	`string`	Selectable in the Payload builder
`order.items[*].tax_rate`	`string`	Selectable in the Payload builder
`order.items[*].tax_name`	`string`	Selectable in the Payload builder
`order.items[*].taxable`	`boolean`	Selectable in the Payload builder
`order.items[*].weight`	`string`	Selectable in the Payload builder
`order.items[*].weight_unit`	`string`	Selectable in the Payload builder
`order.items[*].country_of_origin`	`string`	Selectable in the Payload builder
`order.items[*].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[*].matched_hs_code`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_desc`	`string`	Selectable in the Payload builder
`order.items[*].duty_dutiable`	`boolean`	Selectable in the Payload builder
`order.items[*].duty_exclusion_reason`	`string`	Selectable in the Payload builder
`order.items[*].duty_customs_value`	`string`	Selectable in the Payload builder
`order.items[*].duty_weight_kg`	`string`	Selectable in the Payload builder
`order.items[*].duty_matched_origin`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_type`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_per`	`string`	Selectable in the Payload builder
`order.items[*].vendor`	`string`	Selectable in the Payload builder
`order.items[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`order.items[*].fulfillment_status`	`string`	Selectable in the Payload builder
`order.items[*].external_id`	`string`	Selectable in the Payload builder
`order.items[*].properties`	`object`	Selectable in the Payload builder
`order.items[].tax_lines[].name`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].rate`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].amount`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction_type`	`string`	Selectable in the Payload builder
`order.items[].duties[].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].country_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].amount`	`string`	Selectable in the Payload builder
`order.items[].duties[].currency_code`	`string`	Selectable in the Payload builder
`order.shipping_address.first_name`	`string`	Selectable in the Payload builder
`order.shipping_address.last_name`	`string`	Selectable in the Payload builder
`order.shipping_address.company`	`string`	Selectable in the Payload builder
`order.shipping_address.address1`	`string`	Selectable in the Payload builder
`order.shipping_address.address2`	`string`	Selectable in the Payload builder
`order.shipping_address.city`	`string`	Selectable in the Payload builder
`order.shipping_address.state`	`string`	Selectable in the Payload builder
`order.shipping_address.postal_code`	`string`	Selectable in the Payload builder
`order.shipping_address.country`	`string`	Selectable in the Payload builder
`order.shipping_address.phone`	`string`	Selectable in the Payload builder
`order.billing_address.first_name`	`string`	Selectable in the Payload builder
`order.billing_address.last_name`	`string`	Selectable in the Payload builder
`order.billing_address.company`	`string`	Selectable in the Payload builder
`order.billing_address.address1`	`string`	Selectable in the Payload builder
`order.billing_address.address2`	`string`	Selectable in the Payload builder
`order.billing_address.city`	`string`	Selectable in the Payload builder
`order.billing_address.state`	`string`	Selectable in the Payload builder
`order.billing_address.postal_code`	`string`	Selectable in the Payload builder
`order.billing_address.country`	`string`	Selectable in the Payload builder
`order.billing_address.phone`	`string`	Selectable in the Payload builder
`order.discounts[*].id`	`string`	Selectable in the Payload builder
`order.discounts[*].name`	`string`	Selectable in the Payload builder
`order.discounts[*].code`	`string`	Selectable in the Payload builder
`order.discounts[*].type`	`string`	Selectable in the Payload builder
`order.discounts[*].value`	`string`	Selectable in the Payload builder
`order.discounts[*].amount`	`string`	Selectable in the Payload builder
`order.discounts[*].scope`	`string`	Selectable in the Payload builder
`order.discounts[*].line_item_id`	`string`	Selectable in the Payload builder
`order.discounts[*].source`	`string`	Selectable in the Payload builder
`order.discounts[*].source_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].order_item_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].product_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].variant_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].quantity`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].per_unit_amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].is_free`	`boolean`	Selectable in the Payload builder
`order.tags[*].id`	`string`	Selectable in the Payload builder
`order.tags[*].name`	`string`	Selectable in the Payload builder
`order.tags[*].slug`	`string`	Selectable in the Payload builder
`order.payments[*].id`	`string`	Selectable in the Payload builder
`order.payments[*].method`	`string`	Selectable in the Payload builder
`order.payments[*].provider`	`string`	Selectable in the Payload builder
`order.payments[*].status`	`string`	Selectable in the Payload builder
`order.payments[*].amount`	`string`	Selectable in the Payload builder
`order.payments[*].currency_code`	`string`	Selectable in the Payload builder
`order.payments[*].created_at`	`string`	Selectable in the Payload builder
`order.tenders[*].id`	`string`	Selectable in the Payload builder
`order.tenders[*].kind`	`string`	Selectable in the Payload builder
`order.tenders[*].amount`	`string`	Selectable in the Payload builder
`order.tenders[*].currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].base_amount`	`string`	Selectable in the Payload builder
`order.tenders[*].base_currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].created_at`	`string`	Selectable in the Payload builder
`order.metafields_count`	`integer`	Selectable in the Payload builder
`order.created_at`	`string`	Selectable in the Payload builder
`order.updated_at`	`string`	Selectable in the Payload builder
`order.cancelled_at`	`string`	Selectable in the Payload builder
`order.completed_at`	`string`	Selectable in the Payload builder
`refund.id`	`string`	Selectable in the Payload builder
`refund.amount`	`string`	Selectable in the Payload builder
`refund.currency_code`	`string`	Selectable in the Payload builder
`refund.reason`	`string`	Selectable in the Payload builder
`refund.created_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "order": {
    "amount_due_on_delivery": "...",
    "base_checkout_fee_total": "...",
    "base_cod_fee_total": "...",
    "base_currency_code": "...",
    "base_currency_rate": "...",
    "base_discount_total": "...",
    "base_duty_total": "...",
    "base_grand_total": "...",
    "base_refunded_total": "...",
    "base_shipping_total": "...",
    "base_subtotal": "...",
    "base_tax_total": "...",
    "billing_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "cancelled_at": null,
    "channel_id": null,
    "channel_type": null,
    "checkout_fee_lines": [
      {
        "amount": "40.00",
        "id": "ord_8e3f1a20",
        "is_optional": false,
        "name": "Buy two tees, get one free",
        "overridden": false,
        "tax_class_id": "..."
      }
    ],
    "checkout_fee_total": "...",
    "cod_fee_hsn_code": "...",
    "cod_fee_total": "...",
    "completed_at": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "created_by_app_id": null,
    "currency_code": "USD",
    "customer_email": "...",
    "customer_first_name": "...",
    "customer_id": null,
    "customer_last_name": "...",
    "customer_phone": "...",
    "customer_tax_id": null,
    "customer_tax_id_type": null,
    "de_minimis_applied": false,
    "discount_total": "40.00",
    "discounts": [
      {
        "allocations": [
          {
            "amount": "40.00",
            "is_free": true,
            "order_item_id": "oi_1b6d4c92",
            "per_unit_amount": "40.00",
            "product_id": 42,
            "quantity": 1,
            "variant_id": 1007
          }
        ],
        "amount": "40.00",
        "code": null,
        "id": "ord_8e3f1a20",
        "line_item_id": null,
        "name": "Buy two tees, get one free",
        "scope": "order",
        "source": "automatic",
        "source_id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
        "type": "buy_x_get_y",
        "value": "..."
      }
    ],
    "duty_collection_mode": "...",
    "duty_eligible": false,
    "duty_overridden": false,
    "duty_rule_currency": null,
    "duty_rule_id": null,
    "duty_total": "...",
    "exchange_fee_amount": "...",
    "exchange_fee_rate": "...",
    "external_order_id": null,
    "external_source": null,
    "financial_status": "paid",
    "fulfillment_status": "unfulfilled",
    "grand_total": "216.00",
    "id": "ord_8e3f1a20",
    "invoice_only": false,
    "is_archived": false,
    "is_tax_included": false,
    "is_test": false,
    "items": [
      {
        "base_discount_amount": "...",
        "base_duty_amount": "...",
        "base_tax_amount": "...",
        "base_total": "...",
        "base_unit_price": "...",
        "country_of_origin": null,
        "discount_amount": "...",
        "duties": [
          {
            "amount": "40.00",
            "country_code": "...",
            "currency_code": "USD",
            "harmonized_code": "..."
          }
        ],
        "duty_amount": "...",
        "duty_customs_value": "...",
        "duty_dutiable": false,
        "duty_exclusion_reason": "...",
        "duty_matched_origin": "...",
        "duty_rate": null,
        "duty_rate_desc": "...",
        "duty_rate_type": "...",
        "duty_specific_amount": null,
        "duty_specific_per": "...",
        "duty_weight_kg": "...",
        "external_id": null,
        "fulfilled_quantity": 0,
        "fulfillment_status": "unfulfilled",
        "harmonized_code": "...",
        "id": "ord_8e3f1a20",
        "image_url": "...",
        "matched_hs_code": "...",
        "price_converted": null,
        "product_id": 42,
        "properties": "...",
        "quantity": 1,
        "refunded_quantity": 0,
        "requires_shipping": false,
        "sku": "...",
        "tax_amount": "...",
        "tax_lines": [
          {
            "amount": "40.00",
            "jurisdiction": "...",
            "jurisdiction_type": "...",
            "name": "Buy two tees, get one free",
            "rate": "..."
          }
        ],
        "tax_name": "...",
        "tax_rate": null,
        "taxable": false,
        "title": "...",
        "total": "...",
        "unit_compare_price": null,
        "unit_price": "...",
        "variant_id": 1007,
        "variant_title": "...",
        "vendor": "...",
        "weight": null,
        "weight_unit": "..."
      }
    ],
    "locale": "en-US",
    "location_id": null,
    "market_id": null,
    "metafields_count": 0,
    "note": "...",
    "order_number": "#1042",
    "origin": "...",
    "payment_status": "captured",
    "payments": [
      {
        "amount": "40.00",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "method": "...",
        "provider": "...",
        "status": "..."
      }
    ],
    "rate_source": "...",
    "refunded_total": "...",
    "requires_shipping": false,
    "shipping_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "shipping_total": "0.00",
    "status_slug": "confirmed",
    "subtotal": "...",
    "tags": [
      {
        "id": "ord_8e3f1a20",
        "name": "Buy two tees, get one free",
        "slug": "..."
      }
    ],
    "tax_address_missing": false,
    "tax_exempt": false,
    "tax_total": "16.00",
    "tax_zone_unmatched": false,
    "tenders": [
      {
        "amount": "40.00",
        "base_amount": "...",
        "base_currency_code": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "kind": "..."
      }
    ],
    "total_items": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "version": 0
  },
  "refund": {
    "amount": "40.00",
    "created_at": "2026-06-09T12:00:00+05:30",
    "currency_code": "USD",
    "id": "ord_8e3f1a20",
    "reason": "..."
  }
}

Order updated

EVENT orders/update App scope: read_orders Staff permission: orders:read

Fired when an order is edited or its tags change. Carries the current order and changed_fields. Payment, fulfillment and archive transitions retain their dedicated topics.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

billing_address contact discount items shipping shipping_address tags

Payload fields

Field	Type	Description
`order.is_archived`	`boolean`	Selectable in the Payload builder
`order.id`	`string`	Selectable in the Payload builder
`order.version`	`integer`	Selectable in the Payload builder
`order.order_number`	`string`	Selectable in the Payload builder
`order.status_slug`	`string`	Selectable in the Payload builder
`order.channel_id`	`string`	Selectable in the Payload builder
`order.channel_type`	`string`	Selectable in the Payload builder
`order.origin`	`string`	Selectable in the Payload builder
`order.market_id`	`string`	Selectable in the Payload builder
`order.location_id`	`string`	Selectable in the Payload builder
`order.created_by_app_id`	`string`	Selectable in the Payload builder
`order.locale`	`string`	Selectable in the Payload builder
`order.external_order_id`	`string`	Selectable in the Payload builder
`order.external_source`	`string`	Selectable in the Payload builder
`order.customer_id`	`string`	Selectable in the Payload builder
`order.customer_email`	`string`	Selectable in the Payload builder
`order.customer_first_name`	`string`	Selectable in the Payload builder
`order.customer_last_name`	`string`	Selectable in the Payload builder
`order.customer_phone`	`string`	Selectable in the Payload builder
`order.customer_tax_id`	`string`	Selectable in the Payload builder
`order.customer_tax_id_type`	`string`	Selectable in the Payload builder
`order.currency_code`	`string`	Selectable in the Payload builder
`order.subtotal`	`string`	Selectable in the Payload builder
`order.discount_total`	`string`	Selectable in the Payload builder
`order.tax_total`	`string`	Selectable in the Payload builder
`order.shipping_total`	`string`	Selectable in the Payload builder
`order.cod_fee_total`	`string`	Selectable in the Payload builder
`order.cod_fee_hsn_code`	`string`	Selectable in the Payload builder
`order.checkout_fee_total`	`string`	Selectable in the Payload builder
`order.duty_total`	`string`	Selectable in the Payload builder
`order.duty_collection_mode`	`string`	Selectable in the Payload builder
`order.duty_eligible`	`boolean`	Selectable in the Payload builder
`order.de_minimis_applied`	`boolean`	Selectable in the Payload builder
`order.duty_overridden`	`boolean`	Selectable in the Payload builder
`order.duty_rule_id`	`string`	Selectable in the Payload builder
`order.duty_rule_currency`	`string`	Selectable in the Payload builder
`order.grand_total`	`string`	Selectable in the Payload builder
`order.refunded_total`	`string`	Selectable in the Payload builder
`order.amount_due_on_delivery`	`string`	Selectable in the Payload builder
`order.base_currency_code`	`string`	Selectable in the Payload builder
`order.base_currency_rate`	`string`	Selectable in the Payload builder
`order.base_subtotal`	`string`	Selectable in the Payload builder
`order.base_discount_total`	`string`	Selectable in the Payload builder
`order.base_tax_total`	`string`	Selectable in the Payload builder
`order.base_shipping_total`	`string`	Selectable in the Payload builder
`order.base_cod_fee_total`	`string`	Selectable in the Payload builder
`order.base_checkout_fee_total`	`string`	Selectable in the Payload builder
`order.base_duty_total`	`string`	Selectable in the Payload builder
`order.base_grand_total`	`string`	Selectable in the Payload builder
`order.base_refunded_total`	`string`	Selectable in the Payload builder
`order.exchange_fee_rate`	`string`	Selectable in the Payload builder
`order.exchange_fee_amount`	`string`	Selectable in the Payload builder
`order.rate_source`	`string`	Selectable in the Payload builder
`order.financial_status`	`string`	Selectable in the Payload builder
`order.fulfillment_status`	`string`	Selectable in the Payload builder
`order.payment_status`	`string`	Selectable in the Payload builder
`order.requires_shipping`	`boolean`	Selectable in the Payload builder
`order.is_tax_included`	`boolean`	Selectable in the Payload builder
`order.tax_address_missing`	`boolean`	Selectable in the Payload builder
`order.tax_zone_unmatched`	`boolean`	Selectable in the Payload builder
`order.tax_exempt`	`boolean`	Selectable in the Payload builder
`order.invoice_only`	`boolean`	Selectable in the Payload builder
`order.is_test`	`boolean`	Selectable in the Payload builder
`order.note`	`string`	Selectable in the Payload builder
`order.total_items`	`integer`	Selectable in the Payload builder
`order.checkout_fee_lines[*].id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].name`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].amount`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].tax_class_id`	`string`	Selectable in the Payload builder
`order.checkout_fee_lines[*].is_optional`	`boolean`	Selectable in the Payload builder
`order.checkout_fee_lines[*].overridden`	`boolean`	Selectable in the Payload builder
`order.items[*].id`	`string`	Selectable in the Payload builder
`order.items[*].product_id`	`integer`	Selectable in the Payload builder
`order.items[*].variant_id`	`integer`	Selectable in the Payload builder
`order.items[*].sku`	`string`	Selectable in the Payload builder
`order.items[*].title`	`string`	Selectable in the Payload builder
`order.items[*].variant_title`	`string`	Selectable in the Payload builder
`order.items[*].image_url`	`string`	Selectable in the Payload builder
`order.items[*].quantity`	`integer`	Selectable in the Payload builder
`order.items[*].fulfilled_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].refunded_quantity`	`integer`	Selectable in the Payload builder
`order.items[*].unit_price`	`string`	Selectable in the Payload builder
`order.items[*].unit_compare_price`	`string`	Selectable in the Payload builder
`order.items[*].discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].total`	`string`	Selectable in the Payload builder
`order.items[*].price_converted`	`boolean`	Selectable in the Payload builder
`order.items[*].base_unit_price`	`string`	Selectable in the Payload builder
`order.items[*].base_discount_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_tax_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_duty_amount`	`string`	Selectable in the Payload builder
`order.items[*].base_total`	`string`	Selectable in the Payload builder
`order.items[*].tax_rate`	`string`	Selectable in the Payload builder
`order.items[*].tax_name`	`string`	Selectable in the Payload builder
`order.items[*].taxable`	`boolean`	Selectable in the Payload builder
`order.items[*].weight`	`string`	Selectable in the Payload builder
`order.items[*].weight_unit`	`string`	Selectable in the Payload builder
`order.items[*].country_of_origin`	`string`	Selectable in the Payload builder
`order.items[*].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[*].matched_hs_code`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_desc`	`string`	Selectable in the Payload builder
`order.items[*].duty_dutiable`	`boolean`	Selectable in the Payload builder
`order.items[*].duty_exclusion_reason`	`string`	Selectable in the Payload builder
`order.items[*].duty_customs_value`	`string`	Selectable in the Payload builder
`order.items[*].duty_weight_kg`	`string`	Selectable in the Payload builder
`order.items[*].duty_matched_origin`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate_type`	`string`	Selectable in the Payload builder
`order.items[*].duty_rate`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_amount`	`string`	Selectable in the Payload builder
`order.items[*].duty_specific_per`	`string`	Selectable in the Payload builder
`order.items[*].vendor`	`string`	Selectable in the Payload builder
`order.items[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`order.items[*].fulfillment_status`	`string`	Selectable in the Payload builder
`order.items[*].external_id`	`string`	Selectable in the Payload builder
`order.items[*].properties`	`object`	Selectable in the Payload builder
`order.items[].tax_lines[].name`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].rate`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].amount`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction`	`string`	Selectable in the Payload builder
`order.items[].tax_lines[].jurisdiction_type`	`string`	Selectable in the Payload builder
`order.items[].duties[].harmonized_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].country_code`	`string`	Selectable in the Payload builder
`order.items[].duties[].amount`	`string`	Selectable in the Payload builder
`order.items[].duties[].currency_code`	`string`	Selectable in the Payload builder
`order.shipping_address.first_name`	`string`	Selectable in the Payload builder
`order.shipping_address.last_name`	`string`	Selectable in the Payload builder
`order.shipping_address.company`	`string`	Selectable in the Payload builder
`order.shipping_address.address1`	`string`	Selectable in the Payload builder
`order.shipping_address.address2`	`string`	Selectable in the Payload builder
`order.shipping_address.city`	`string`	Selectable in the Payload builder
`order.shipping_address.state`	`string`	Selectable in the Payload builder
`order.shipping_address.postal_code`	`string`	Selectable in the Payload builder
`order.shipping_address.country`	`string`	Selectable in the Payload builder
`order.shipping_address.phone`	`string`	Selectable in the Payload builder
`order.billing_address.first_name`	`string`	Selectable in the Payload builder
`order.billing_address.last_name`	`string`	Selectable in the Payload builder
`order.billing_address.company`	`string`	Selectable in the Payload builder
`order.billing_address.address1`	`string`	Selectable in the Payload builder
`order.billing_address.address2`	`string`	Selectable in the Payload builder
`order.billing_address.city`	`string`	Selectable in the Payload builder
`order.billing_address.state`	`string`	Selectable in the Payload builder
`order.billing_address.postal_code`	`string`	Selectable in the Payload builder
`order.billing_address.country`	`string`	Selectable in the Payload builder
`order.billing_address.phone`	`string`	Selectable in the Payload builder
`order.discounts[*].id`	`string`	Selectable in the Payload builder
`order.discounts[*].name`	`string`	Selectable in the Payload builder
`order.discounts[*].code`	`string`	Selectable in the Payload builder
`order.discounts[*].type`	`string`	Selectable in the Payload builder
`order.discounts[*].value`	`string`	Selectable in the Payload builder
`order.discounts[*].amount`	`string`	Selectable in the Payload builder
`order.discounts[*].scope`	`string`	Selectable in the Payload builder
`order.discounts[*].line_item_id`	`string`	Selectable in the Payload builder
`order.discounts[*].source`	`string`	Selectable in the Payload builder
`order.discounts[*].source_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].order_item_id`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].product_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].variant_id`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].quantity`	`integer`	Selectable in the Payload builder
`order.discounts[].allocations[].amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].per_unit_amount`	`string`	Selectable in the Payload builder
`order.discounts[].allocations[].is_free`	`boolean`	Selectable in the Payload builder
`order.tags[*].id`	`string`	Selectable in the Payload builder
`order.tags[*].name`	`string`	Selectable in the Payload builder
`order.tags[*].slug`	`string`	Selectable in the Payload builder
`order.payments[*].id`	`string`	Selectable in the Payload builder
`order.payments[*].method`	`string`	Selectable in the Payload builder
`order.payments[*].provider`	`string`	Selectable in the Payload builder
`order.payments[*].status`	`string`	Selectable in the Payload builder
`order.payments[*].amount`	`string`	Selectable in the Payload builder
`order.payments[*].currency_code`	`string`	Selectable in the Payload builder
`order.payments[*].created_at`	`string`	Selectable in the Payload builder
`order.tenders[*].id`	`string`	Selectable in the Payload builder
`order.tenders[*].kind`	`string`	Selectable in the Payload builder
`order.tenders[*].amount`	`string`	Selectable in the Payload builder
`order.tenders[*].currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].base_amount`	`string`	Selectable in the Payload builder
`order.tenders[*].base_currency_code`	`string`	Selectable in the Payload builder
`order.tenders[*].created_at`	`string`	Selectable in the Payload builder
`order.metafields_count`	`integer`	Selectable in the Payload builder
`order.created_at`	`string`	Selectable in the Payload builder
`order.updated_at`	`string`	Selectable in the Payload builder
`order.cancelled_at`	`string`	Selectable in the Payload builder
`order.completed_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "order": {
    "amount_due_on_delivery": "...",
    "base_checkout_fee_total": "...",
    "base_cod_fee_total": "...",
    "base_currency_code": "...",
    "base_currency_rate": "...",
    "base_discount_total": "...",
    "base_duty_total": "...",
    "base_grand_total": "...",
    "base_refunded_total": "...",
    "base_shipping_total": "...",
    "base_subtotal": "...",
    "base_tax_total": "...",
    "billing_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "cancelled_at": null,
    "channel_id": null,
    "channel_type": null,
    "checkout_fee_lines": [
      {
        "amount": "40.00",
        "id": "ord_8e3f1a20",
        "is_optional": false,
        "name": "Buy two tees, get one free",
        "overridden": false,
        "tax_class_id": "..."
      }
    ],
    "checkout_fee_total": "...",
    "cod_fee_hsn_code": "...",
    "cod_fee_total": "...",
    "completed_at": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "created_by_app_id": null,
    "currency_code": "USD",
    "customer_email": "...",
    "customer_first_name": "...",
    "customer_id": null,
    "customer_last_name": "...",
    "customer_phone": "...",
    "customer_tax_id": null,
    "customer_tax_id_type": null,
    "de_minimis_applied": false,
    "discount_total": "40.00",
    "discounts": [
      {
        "allocations": [
          {
            "amount": "40.00",
            "is_free": true,
            "order_item_id": "oi_1b6d4c92",
            "per_unit_amount": "40.00",
            "product_id": 42,
            "quantity": 1,
            "variant_id": 1007
          }
        ],
        "amount": "40.00",
        "code": null,
        "id": "ord_8e3f1a20",
        "line_item_id": null,
        "name": "Buy two tees, get one free",
        "scope": "order",
        "source": "automatic",
        "source_id": "7c4b1e2f-9a8d-4c3b-b2a1-0f9e8d7c6b5a",
        "type": "buy_x_get_y",
        "value": "..."
      }
    ],
    "duty_collection_mode": "...",
    "duty_eligible": false,
    "duty_overridden": false,
    "duty_rule_currency": null,
    "duty_rule_id": null,
    "duty_total": "...",
    "exchange_fee_amount": "...",
    "exchange_fee_rate": "...",
    "external_order_id": null,
    "external_source": null,
    "financial_status": "paid",
    "fulfillment_status": "unfulfilled",
    "grand_total": "216.00",
    "id": "ord_8e3f1a20",
    "invoice_only": false,
    "is_archived": false,
    "is_tax_included": false,
    "is_test": false,
    "items": [
      {
        "base_discount_amount": "...",
        "base_duty_amount": "...",
        "base_tax_amount": "...",
        "base_total": "...",
        "base_unit_price": "...",
        "country_of_origin": null,
        "discount_amount": "...",
        "duties": [
          {
            "amount": "40.00",
            "country_code": "...",
            "currency_code": "USD",
            "harmonized_code": "..."
          }
        ],
        "duty_amount": "...",
        "duty_customs_value": "...",
        "duty_dutiable": false,
        "duty_exclusion_reason": "...",
        "duty_matched_origin": "...",
        "duty_rate": null,
        "duty_rate_desc": "...",
        "duty_rate_type": "...",
        "duty_specific_amount": null,
        "duty_specific_per": "...",
        "duty_weight_kg": "...",
        "external_id": null,
        "fulfilled_quantity": 0,
        "fulfillment_status": "unfulfilled",
        "harmonized_code": "...",
        "id": "ord_8e3f1a20",
        "image_url": "...",
        "matched_hs_code": "...",
        "price_converted": null,
        "product_id": 42,
        "properties": "...",
        "quantity": 1,
        "refunded_quantity": 0,
        "requires_shipping": false,
        "sku": "...",
        "tax_amount": "...",
        "tax_lines": [
          {
            "amount": "40.00",
            "jurisdiction": "...",
            "jurisdiction_type": "...",
            "name": "Buy two tees, get one free",
            "rate": "..."
          }
        ],
        "tax_name": "...",
        "tax_rate": null,
        "taxable": false,
        "title": "...",
        "total": "...",
        "unit_compare_price": null,
        "unit_price": "...",
        "variant_id": 1007,
        "variant_title": "...",
        "vendor": "...",
        "weight": null,
        "weight_unit": "..."
      }
    ],
    "locale": "en-US",
    "location_id": null,
    "market_id": null,
    "metafields_count": 0,
    "note": "...",
    "order_number": "#1042",
    "origin": "...",
    "payment_status": "captured",
    "payments": [
      {
        "amount": "40.00",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "method": "...",
        "provider": "...",
        "status": "..."
      }
    ],
    "rate_source": "...",
    "refunded_total": "...",
    "requires_shipping": false,
    "shipping_address": {
      "address1": "...",
      "address2": "...",
      "city": "...",
      "company": "...",
      "country": "...",
      "first_name": "...",
      "last_name": "...",
      "phone": "...",
      "postal_code": "...",
      "state": "..."
    },
    "shipping_total": "0.00",
    "status_slug": "confirmed",
    "subtotal": "...",
    "tags": [
      {
        "id": "ord_8e3f1a20",
        "name": "Buy two tees, get one free",
        "slug": "..."
      }
    ],
    "tax_address_missing": false,
    "tax_exempt": false,
    "tax_total": "16.00",
    "tax_zone_unmatched": false,
    "tenders": [
      {
        "amount": "40.00",
        "base_amount": "...",
        "base_currency_code": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "currency_code": "USD",
        "id": "ord_8e3f1a20",
        "kind": "..."
      }
    ],
    "total_items": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "version": 0
  }
}

Page metafield value created

EVENT page_metafields/create App scope: read_pages Staff permission: pages:write

Fired when a page metafield value is created.

Payload fields

Field	Type	Description
`page.id`	`string`	Always present
`page.title`	`string`	Selectable in the Payload builder
`page.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "page": {
    "id": "...",
    "slug": "...",
    "title": "..."
  }
}

Page metafield value deleted

EVENT page_metafields/delete App scope: read_pages Staff permission: pages:write

Fired when a page metafield value is deleted, including when its page is deleted.

Payload fields

Field	Type	Description
`page.id`	`string`	Always present
`page.title`	`string`	Selectable in the Payload builder
`page.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "page": {
    "id": "...",
    "slug": "...",
    "title": "..."
  }
}

Page metafield translations deleted

EVENT page_metafields/translations/delete App scope: read_pages Staff permission: pages:write

Fired when a page metafield's translation is cleared for a locale, including when its page is deleted.

Payload fields

Field	Type	Description
`metafield.page_id`	`string`	Always present
`metafield.page_title`	`string`	Selectable in the Payload builder
`metafield.page_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "...",
    "app_id": null,
    "definition_id": "...",
    "key": "...",
    "merchant_access": "...",
    "name": "...",
    "namespace": "...",
    "page_id": "...",
    "page_slug": "...",
    "page_title": "...",
    "type": "..."
  },
  "translation": {
    "value": null
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Page metafield translations updated

EVENT page_metafields/translations/update App scope: read_pages Staff permission: pages:write

Fired when a page metafield's translation is added or updated for a locale.

Payload fields

Field	Type	Description
`metafield.page_id`	`string`	Always present
`metafield.page_title`	`string`	Selectable in the Payload builder
`metafield.page_slug`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "...",
    "app_id": null,
    "definition_id": "...",
    "key": "...",
    "merchant_access": "...",
    "name": "...",
    "namespace": "...",
    "page_id": "...",
    "page_slug": "...",
    "page_title": "...",
    "type": "..."
  },
  "translation": {
    "value": null
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Page metafield value updated

EVENT page_metafields/update App scope: read_pages Staff permission: pages:write

Fired when a page metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`page.id`	`string`	Always present
`page.title`	`string`	Selectable in the Payload builder
`page.slug`	`string`	Selectable in the Payload builder
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "page": {
    "id": "...",
    "slug": "...",
    "title": "..."
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "...",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "...",
      "name": "...",
      "namespace": "...",
      "owner_type": "...",
      "sort_order": 0,
      "type": "...",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  }
}

Page created

EVENT pages/create App scope: read_pages Staff permission: pages:write

Fired when a custom page is created.

Payload fields

Field	Type	Description
`page.id`	`string`	Always present
`page.title`	`string`	Selectable in the Payload builder
`page.slug`	`string`	Selectable in the Payload builder
`page.content`	`string`	Selectable in the Payload builder
`page.status`	`string`	Selectable in the Payload builder
`page.seo_title`	`string`	Selectable in the Payload builder
`page.seo_description`	`string`	Selectable in the Payload builder
`page.template_handle`	`string`	Selectable in the Payload builder
`page.created_at`	`string`	Selectable in the Payload builder
`page.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "page": {
    "content": "\u003cp\u003eWe build gear for people who live outside.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "seo_description": "Who we are and why we build.",
    "seo_title": "About us",
    "slug": "about-us",
    "status": "published",
    "template_handle": "default_page",
    "title": "About us",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Page deleted

EVENT pages/delete App scope: read_pages Staff permission: pages:write

Fired when a custom page is deleted.

Payload fields

Field	Type	Description
`page.id`	`string`	Always present
`page.title`	`string`	Selectable in the Payload builder
`page.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "page": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "slug": "about-us",
    "title": "About us"
  }
}

Page translations deleted

EVENT pages/translations/delete App scope: read_pages Staff permission: pages:write

Fired when a page's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`page.id`	`string`	Always present
`page.title`	`string`	Selectable in the Payload builder
`page.slug`	`string`	Selectable in the Payload builder
`page.content`	`string`	Selectable in the Payload builder
`page.status`	`string`	Selectable in the Payload builder
`page.seo_title`	`string`	Selectable in the Payload builder
`page.seo_description`	`string`	Selectable in the Payload builder
`page.template_handle`	`string`	Selectable in the Payload builder
`page.created_at`	`string`	Selectable in the Payload builder
`page.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.content`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "page": {
    "content": "\u003cp\u003eWe build gear for people who live outside.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "seo_description": "Who we are and why we build.",
    "seo_title": "About us",
    "slug": "about-us",
    "status": "published",
    "template_handle": "default_page",
    "title": "About us",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "translation": {
    "content": "",
    "seo_description": "",
    "seo_title": "",
    "slug": "",
    "title": ""
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Page translations updated

EVENT pages/translations/update App scope: read_pages Staff permission: pages:write

Fired when a page's translations are added or updated for a locale. Payload carries only the fields that changed.

Payload fields

Field	Type	Description
`page.id`	`string`	Always present
`page.title`	`string`	Selectable in the Payload builder
`page.slug`	`string`	Selectable in the Payload builder
`page.content`	`string`	Selectable in the Payload builder
`page.status`	`string`	Selectable in the Payload builder
`page.seo_title`	`string`	Selectable in the Payload builder
`page.seo_description`	`string`	Selectable in the Payload builder
`page.template_handle`	`string`	Selectable in the Payload builder
`page.created_at`	`string`	Selectable in the Payload builder
`page.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.content`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "page": {
    "content": "\u003cp\u003eWe build gear for people who live outside.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "seo_description": "Who we are and why we build.",
    "seo_title": "About us",
    "slug": "about-us",
    "status": "published",
    "template_handle": "default_page",
    "title": "About us",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "translation": {
    "content": "\u003cp\u003eNous créons du matériel pour les passionnés de plein air.\u003c/p\u003e",
    "seo_description": "Qui nous sommes et pourquoi nous créons.",
    "seo_title": "À propos",
    "slug": "a-propos",
    "title": "À propos"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Page updated

EVENT pages/update App scope: read_pages Staff permission: pages:write

Fired when a custom page is updated.

Payload fields

Field	Type	Description
`page.id`	`string`	Always present
`page.title`	`string`	Selectable in the Payload builder
`page.slug`	`string`	Selectable in the Payload builder
`page.content`	`string`	Selectable in the Payload builder
`page.status`	`string`	Selectable in the Payload builder
`page.seo_title`	`string`	Selectable in the Payload builder
`page.seo_description`	`string`	Selectable in the Payload builder
`page.template_handle`	`string`	Selectable in the Payload builder
`page.created_at`	`string`	Selectable in the Payload builder
`page.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "page": {
    "content": "\u003cp\u003eWe build gear for people who live outside.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "seo_description": "Who we are and why we build.",
    "seo_title": "About us",
    "slug": "about-us",
    "status": "published",
    "template_handle": "default_page",
    "title": "About us",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Policy translations deleted

EVENT policies/translations/delete App scope: read_pages Staff permission: pages:write

Fired when a policy's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`policy.id`	`string`	Always present
`policy.type`	`string`	Selectable in the Payload builder
`policy.title`	`string`	Selectable in the Payload builder
`policy.slug`	`string`	Selectable in the Payload builder
`policy.content`	`string`	Selectable in the Payload builder
`policy.status`	`string`	Selectable in the Payload builder
`policy.seo_title`	`string`	Selectable in the Payload builder
`policy.seo_description`	`string`	Selectable in the Payload builder
`policy.created_at`	`string`	Selectable in the Payload builder
`policy.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.content`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "policy": {
    "content": "\u003cp\u003eReturns are accepted within 30 days of delivery.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "seo_description": "Our 30-day return terms.",
    "seo_title": "Refund policy",
    "slug": "refund-policy",
    "status": "published",
    "title": "Refund policy",
    "type": "refund",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "translation": {
    "content": "",
    "seo_description": "",
    "seo_title": "",
    "slug": "",
    "title": ""
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Policy translations updated

EVENT policies/translations/update App scope: read_pages Staff permission: pages:write

Fired when a policy's translations are added or updated for a locale. Payload carries only the fields that changed.

Payload fields

Field	Type	Description
`policy.id`	`string`	Always present
`policy.type`	`string`	Selectable in the Payload builder
`policy.title`	`string`	Selectable in the Payload builder
`policy.slug`	`string`	Selectable in the Payload builder
`policy.content`	`string`	Selectable in the Payload builder
`policy.status`	`string`	Selectable in the Payload builder
`policy.seo_title`	`string`	Selectable in the Payload builder
`policy.seo_description`	`string`	Selectable in the Payload builder
`policy.created_at`	`string`	Selectable in the Payload builder
`policy.updated_at`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.content`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "policy": {
    "content": "\u003cp\u003eReturns are accepted within 30 days of delivery.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "seo_description": "Our 30-day return terms.",
    "seo_title": "Refund policy",
    "slug": "refund-policy",
    "status": "published",
    "title": "Refund policy",
    "type": "refund",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "translation": {
    "content": "\u003cp\u003eLes retours sont acceptés sous 30 jours.\u003c/p\u003e",
    "seo_description": "Nos conditions de retour sous 30 jours.",
    "seo_title": "Politique de remboursement",
    "slug": "politique-remboursement",
    "title": "Politique de remboursement"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Policy updated

EVENT policies/update App scope: read_pages Staff permission: pages:write

Fired when a store policy is updated.

Payload fields

Field	Type	Description
`policy.id`	`string`	Always present
`policy.type`	`string`	Selectable in the Payload builder
`policy.title`	`string`	Selectable in the Payload builder
`policy.slug`	`string`	Selectable in the Payload builder
`policy.content`	`string`	Selectable in the Payload builder
`policy.status`	`string`	Selectable in the Payload builder
`policy.seo_title`	`string`	Selectable in the Payload builder
`policy.seo_description`	`string`	Selectable in the Payload builder
`policy.created_at`	`string`	Selectable in the Payload builder
`policy.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "policy": {
    "content": "\u003cp\u003eReturns are accepted within 30 days of delivery.\u003c/p\u003e",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "seo_description": "Our 30-day return terms.",
    "seo_title": "Refund policy",
    "slug": "refund-policy",
    "status": "published",
    "title": "Refund policy",
    "type": "refund",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Channel code changed

EVENT channel_identities/rekeyed App scope: read_products Staff permission: products:write

Fired when a channel code your app reads from a product's or variant's SKU or metafield changes because the merchant changed that value. The platform replaces the code in the same save and keeps the old one as history; the payload carries both. Delivered only to the app that owns the identity binding. Send the product again under the new code, remove the item that used previous_value, and drop any copy of the old code you keep. A value that would duplicate another product's code in the same binding keeps its old code and fires nothing; identity diagnostics report the duplicate. Generated and canonical-ID codes never change.

Payload fields

Field	Type	Description
`binding_id`	`string`	Always present The identity binding whose code changed.
`declaration_key`	`string`	Always present The key of the identity declaration in your app's contract, for example `item_id`.
`catalog_context_id`	`string`	Selectable in the Payload builder The catalog context the binding belongs to, or null for an installation-wide binding.
`owner_type`	`string`	Always present `product` or `variant`: what the code identifies.
`owner_id`	`integer`	Always present The ID of the product or variant whose code changed.
`product_id`	`integer`	Always present The product the owner belongs to; equal to owner_id for a product.
`previous_value`	`string`	Always present The code that was in use before. Remove the item you sent under it.
`value`	`string`	Always present The code in use now. Send the product again under it.
`source`	`string`	Always present Where the code is read from: `sku` or `metafield`.
`changed_at`	`string`	Always present When the code changed, in the store's time zone with its offset (RFC 3339).

Payload shape

Sample payload

{
  "binding_id": "8dcfed2c-caf8-4cf4-9904-31aac69ea66b",
  "catalog_context_id": null,
  "changed_at": "2026-10-09T08:30:00+05:30",
  "declaration_key": "item_id",
  "owner_id": 326,
  "owner_type": "product",
  "previous_value": "MINIPOLAROID_326",
  "product_id": 326,
  "source": "metafield",
  "value": "326"
}

List-page SEO translations deleted

EVENT list_page_seo/translations/delete App scope: read_products Staff permission: products:write

Fired when translated SEO fields are cleared for the public brand, vendor, or category list page in a locale. The payload identifies the list with page_type and carries the cleared fields as empty strings.

Payload fields

Field	Type	Description
`list_page_seo.id`	`integer`	Always present The stable storage id for this list-page SEO record.
`list_page_seo.page_type`	`string`	Always present The public catalog list being described: brand_list, vendor_list, category_list, or collection_list.
`list_page_seo.seo_title`	`string`	Selectable in the Payload builder The list page's SEO title in the store's default language.
`list_page_seo.seo_description`	`string`	Selectable in the Payload builder The list page's SEO description in the store's default language.
`list_page_seo.social_title`	`string`	Selectable in the Payload builder The default-language social sharing title override.
`list_page_seo.social_description`	`string`	Selectable in the Payload builder The default-language social sharing description override.
`list_page_seo.social_image_id`	`string`	Selectable in the Payload builder The assigned site-asset image id, or null when no override is assigned.
`list_page_seo.robots_index`	`boolean`	Selectable in the Payload builder Whether search engines may index this list page.
`list_page_seo.robots_follow`	`boolean`	Selectable in the Payload builder Whether search engines may follow links from this list page.
`list_page_seo.updated_at`	`string`	Selectable in the Payload builder When the source list-page SEO settings last changed, in the store's timezone.
`locale`	`string`	Selectable in the Payload builder The locale whose list-page SEO translation changed.
`translation.seo_title`	`string`	Selectable in the Payload builder The translated SEO title; an empty string on the delete event means it was removed.
`translation.seo_description`	`string`	Selectable in the Payload builder The translated SEO description; an empty string on the delete event means it was removed.
`translation.social_title`	`string`	Selectable in the Payload builder The translated social title; an empty string on the delete event means it was removed.
`translation.social_description`	`string`	Selectable in the Payload builder The translated social description; an empty string on the delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's list-page SEO translation changed, in the store's timezone.

Payload shape

Sample payload

{
  "list_page_seo": {
    "id": 42,
    "page_type": "brand_list",
    "robots_follow": true,
    "robots_index": true,
    "seo_description": "Browse every brand available in our store.",
    "seo_title": "Shop brands",
    "social_description": "Discover brands selected by our team.",
    "social_image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "social_title": "Our brands",
    "updated_at": "2026-08-27T09:30:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "seo_description": "",
    "seo_title": "",
    "social_description": "",
    "social_title": ""
  },
  "updated_at": "2026-08-27T09:30:00+05:30"
}

List-page SEO translations updated

EVENT list_page_seo/translations/update App scope: read_products Staff permission: products:write

Fired when translated SEO fields are added or updated for the public brand, vendor, or category list page in a locale. The payload identifies the list with page_type and carries only the translated fields that changed.

Payload fields

Field	Type	Description
`list_page_seo.id`	`integer`	Always present The stable storage id for this list-page SEO record.
`list_page_seo.page_type`	`string`	Always present The public catalog list being described: brand_list, vendor_list, category_list, or collection_list.
`list_page_seo.seo_title`	`string`	Selectable in the Payload builder The list page's SEO title in the store's default language.
`list_page_seo.seo_description`	`string`	Selectable in the Payload builder The list page's SEO description in the store's default language.
`list_page_seo.social_title`	`string`	Selectable in the Payload builder The default-language social sharing title override.
`list_page_seo.social_description`	`string`	Selectable in the Payload builder The default-language social sharing description override.
`list_page_seo.social_image_id`	`string`	Selectable in the Payload builder The assigned site-asset image id, or null when no override is assigned.
`list_page_seo.robots_index`	`boolean`	Selectable in the Payload builder Whether search engines may index this list page.
`list_page_seo.robots_follow`	`boolean`	Selectable in the Payload builder Whether search engines may follow links from this list page.
`list_page_seo.updated_at`	`string`	Selectable in the Payload builder When the source list-page SEO settings last changed, in the store's timezone.
`locale`	`string`	Selectable in the Payload builder The locale whose list-page SEO translation changed.
`translation.seo_title`	`string`	Selectable in the Payload builder The translated SEO title; an empty string on the delete event means it was removed.
`translation.seo_description`	`string`	Selectable in the Payload builder The translated SEO description; an empty string on the delete event means it was removed.
`translation.social_title`	`string`	Selectable in the Payload builder The translated social title; an empty string on the delete event means it was removed.
`translation.social_description`	`string`	Selectable in the Payload builder The translated social description; an empty string on the delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's list-page SEO translation changed, in the store's timezone.

Payload shape

Sample payload

{
  "list_page_seo": {
    "id": 42,
    "page_type": "brand_list",
    "robots_follow": true,
    "robots_index": true,
    "seo_description": "Browse every brand available in our store.",
    "seo_title": "Shop brands",
    "social_description": "Discover brands selected by our team.",
    "social_image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "social_title": "Our brands",
    "updated_at": "2026-08-27T09:30:00+05:30"
  },
  "locale": "fr",
  "translation": {
    "seo_description": "Parcourez toutes les marques disponibles dans notre boutique.",
    "seo_title": "Découvrir nos marques",
    "social_description": "Découvrez les marques sélectionnées par notre équipe.",
    "social_title": "Nos marques"
  },
  "updated_at": "2026-08-27T09:30:00+05:30"
}

List-page SEO updated

EVENT list_page_seo/update App scope: read_products Staff permission: products:write

Fired when SEO settings change for the public brand, vendor, or category list page. The payload identifies the list with page_type and carries its current source snapshot.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

robots_follow robots_index seo_description seo_title social_description social_image_id social_title

Payload fields

Field	Type	Description
`list_page_seo.id`	`integer`	Always present The stable storage id for this list-page SEO record.
`list_page_seo.page_type`	`string`	Always present The public catalog list being described: brand_list, vendor_list, category_list, or collection_list.
`list_page_seo.seo_title`	`string`	Selectable in the Payload builder The list page's SEO title in the store's default language.
`list_page_seo.seo_description`	`string`	Selectable in the Payload builder The list page's SEO description in the store's default language.
`list_page_seo.social_title`	`string`	Selectable in the Payload builder The default-language social sharing title override.
`list_page_seo.social_description`	`string`	Selectable in the Payload builder The default-language social sharing description override.
`list_page_seo.social_image_id`	`string`	Selectable in the Payload builder The assigned site-asset image id, or null when no override is assigned.
`list_page_seo.robots_index`	`boolean`	Selectable in the Payload builder Whether search engines may index this list page.
`list_page_seo.robots_follow`	`boolean`	Selectable in the Payload builder Whether search engines may follow links from this list page.
`list_page_seo.updated_at`	`string`	Selectable in the Payload builder When the source list-page SEO settings last changed, in the store's timezone.
`changed_fields`	`array`	Always present The source list-page SEO fields changed by this event.

Payload shape

Sample payload

{
  "changed_fields": [
    "seo_title",
    "seo_description"
  ],
  "list_page_seo": {
    "id": 42,
    "page_type": "brand_list",
    "robots_follow": true,
    "robots_index": true,
    "seo_description": "Browse every brand available in our store.",
    "seo_title": "Shop brands",
    "social_description": "Discover brands selected by our team.",
    "social_image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "social_title": "Our brands",
    "updated_at": "2026-08-27T09:30:00+05:30"
  }
}

Product metafield value created

EVENT product_metafields/create App scope: read_products Staff permission: products:write

Fired when a product metafield value is created.

Payload fields

Field	Type	Description
`product.product_id`	`integer`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
      "id": 42,
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "variable",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  },
  "product": {
    "product_id": 42
  }
}

Product metafield value deleted

EVENT product_metafields/delete App scope: read_products Staff permission: products:write

Fired when a product metafield value is deleted on its own. Deleting the product deletes its metafields without this event.

Payload fields

Field	Type	Description
`product.product_id`	`integer`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
      "id": 42,
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "variable",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  },
  "product": {
    "product_id": 42
  }
}

Product metafield translations deleted

EVENT product_metafields/translations/delete App scope: read_products Staff permission: products:write

Fired when a product metafield's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`metafield.product_id`	`integer`	Always present
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "definition_id": "mfd_2b9c4e01",
    "key": "material",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "specs",
    "product_id": 42,
    "type": "variable"
  },
  "translation": {
    "value": "Organic cotton"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Product metafield translations updated

EVENT product_metafields/translations/update App scope: read_products Staff permission: products:write

Fired when a product metafield's translations are added or updated for a locale. Payload carries only the fields that changed.

Payload fields

Field	Type	Description
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`metafield.product_id`	`integer`	Always present
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "definition_id": "mfd_2b9c4e01",
    "key": "material",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "specs",
    "product_id": 42,
    "type": "variable"
  },
  "translation": {
    "value": "Organic cotton"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Product metafield value updated

EVENT product_metafields/update App scope: read_products Staff permission: products:write

Fired when a product metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`product.product_id`	`integer`	Always present
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
      "id": 42,
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "variable",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
      "id": 42,
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "variable",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  },
  "product": {
    "product_id": 42
  }
}

product_publications/create

EVENT product_publications/create App scope: read_products Staff permission: products:write

Payload fields

Field	Type	Description
`publication_id`	`string`	Always present
`version`	`integer`	Always present
`channel_id`	`string`	Always present
`installation_id`	`string`	Selectable in the Payload builder
`product.id`	`integer`	Always present
`product.storefront_url`	`string`	Selectable in the Payload builder
`product.is_gift_card`	`boolean`	Selectable in the Payload builder
`product.gift_only`	`boolean`	Selectable in the Payload builder
`product.hide_from_listings`	`boolean`	Selectable in the Payload builder
`product.title`	`string`	Selectable in the Payload builder
`product.slug`	`string`	Selectable in the Payload builder
`product.description`	`string`	Selectable in the Payload builder
`product.short_description`	`string`	Selectable in the Payload builder
`product.type`	`string`	Selectable in the Payload builder
`product.status`	`string`	Selectable in the Payload builder
`product.vendor_id`	`integer`	Selectable in the Payload builder
`product.vendor`	`string`	Selectable in the Payload builder
`product.brand_id`	`integer`	Selectable in the Payload builder
`product.tags`	`array`	Selectable in the Payload builder
`product.tag_ids`	`array`	Selectable in the Payload builder
`product.attribute_ids`	`array`	Selectable in the Payload builder
`product.seo_title`	`string`	Selectable in the Payload builder
`product.seo_description`	`string`	Selectable in the Payload builder
`product.template_handle`	`string`	Selectable in the Payload builder
`product.sku`	`string`	Selectable in the Payload builder
`product.barcode`	`string`	Selectable in the Payload builder
`product.condition`	`string`	Selectable in the Payload builder
`product.mpn`	`string`	Selectable in the Payload builder
`product.brand`	`string`	Selectable in the Payload builder
`product.no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.identifier_status`	`string`	Selectable in the Payload builder
`product.weight`	`number`	Selectable in the Payload builder
`product.weight_unit`	`string`	Selectable in the Payload builder
`product.length`	`number`	Selectable in the Payload builder
`product.width`	`number`	Selectable in the Payload builder
`product.height`	`number`	Selectable in the Payload builder
`product.dimension_unit`	`string`	Selectable in the Payload builder
`product.hs_code`	`string`	Selectable in the Payload builder
`product.country_of_origin`	`string`	Selectable in the Payload builder
`product.inventory_source`	`string`	Selectable in the Payload builder
`product.inventory_group_id`	`string`	Selectable in the Payload builder
`product.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.max_order_quantity`	`integer`	Selectable in the Payload builder
`product.total_stock`	`integer`	Selectable in the Payload builder
`product.inventory_tracking_state`	`string`	Selectable in the Payload builder
`product.requires_shipping`	`boolean`	Selectable in the Payload builder
`product.publish_at`	`string`	Selectable in the Payload builder
`product.publish_at_iso`	`string`	Selectable in the Payload builder
`product.published_at`	`string`	Selectable in the Payload builder
`product.created_at`	`string`	Selectable in the Payload builder
`product.updated_at`	`string`	Selectable in the Payload builder
`product.sales_count`	`integer`	Selectable in the Payload builder
`product.formatted_regular_price`	`string`	Selectable in the Payload builder
`product.formatted_sale_price`	`string`	Selectable in the Payload builder
`product.formatted_price_min`	`string`	Selectable in the Payload builder
`product.formatted_price_max`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_min`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_max`	`string`	Selectable in the Payload builder
`product.prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.prices[*].regular_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_price`	`string`	Selectable in the Payload builder
`product.prices[*].cost_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].price`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_name`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_name`	`string`	Selectable in the Payload builder
`product.images[*].id`	`integer`	Selectable in the Payload builder
`product.images[*].file_id`	`string`	Selectable in the Payload builder
`product.images[*].url`	`string`	Selectable in the Payload builder
`product.images[*].cdn_url`	`string`	Selectable in the Payload builder
`product.images[*].thumbnail_url`	`string`	Selectable in the Payload builder
`product.images[*].media_type`	`string`	Selectable in the Payload builder
`product.images[*].alt_text`	`string`	Selectable in the Payload builder
`product.images[*].sort_order`	`integer`	Selectable in the Payload builder
`product.images[*].created_at`	`string`	Selectable in the Payload builder
`product.inventory[*].location_id`	`string`	Selectable in the Payload builder
`product.inventory[*].location_name`	`string`	Selectable in the Payload builder
`product.inventory[*].quantity`	`integer`	Selectable in the Payload builder
`product.inventory[*].reserved`	`integer`	Selectable in the Payload builder
`product.inventory[*].checkout_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].order_committed`	`integer`	Selectable in the Payload builder
`product.inventory[*].other_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].available`	`integer`	Selectable in the Payload builder
`product.inventory[*].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.category_ids`	`array`	Selectable in the Payload builder
`product.categories[*].id`	`integer`	Selectable in the Payload builder
`product.categories[*].name`	`string`	Selectable in the Payload builder
`product.categories[*].slug`	`string`	Selectable in the Payload builder
`product.categories[*].path`	`string`	Selectable in the Payload builder
`product.channel_ids`	`array`	Selectable in the Payload builder
`product.channel_publications[*].channel_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].publication_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].version`	`integer`	Selectable in the Payload builder
`product.channel_publications[*].status`	`string`	Selectable in the Payload builder
`product.channel_publications[*].code`	`string`	Selectable in the Payload builder
`product.channel_publications[*].message`	`string`	Selectable in the Payload builder
`product.quantity_tiers[*].target_type`	`string`	Always present
`product.quantity_tiers[*].target_id`	`integer`	Always present
`product.quantity_tiers[*].min_quantity`	`integer`	Always present
`product.quantity_tiers[*].percent`	`string`	Always present
`product.variants_count`	`integer`	Selectable in the Payload builder
`product.variants[*].id`	`integer`	Always present
`product.variants[*].product_id`	`integer`	Always present
`product.variants[*].sku`	`string`	Selectable in the Payload builder
`product.variants[*].barcode`	`string`	Selectable in the Payload builder
`product.variants[*].condition`	`string`	Selectable in the Payload builder
`product.variants[*].mpn`	`string`	Selectable in the Payload builder
`product.variants[*].no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.variants[*].identifier_status`	`string`	Selectable in the Payload builder
`product.variants[*].title`	`string`	Selectable in the Payload builder
`product.variants[*].title_is_custom`	`boolean`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_name`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_slug`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_label`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_value`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_color`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].weight`	`number`	Selectable in the Payload builder
`product.variants[*].weight_unit`	`string`	Selectable in the Payload builder
`product.variants[*].length`	`number`	Selectable in the Payload builder
`product.variants[*].width`	`number`	Selectable in the Payload builder
`product.variants[*].height`	`number`	Selectable in the Payload builder
`product.variants[*].dimension_unit`	`string`	Selectable in the Payload builder
`product.variants[*].hs_code`	`string`	Selectable in the Payload builder
`product.variants[*].country_of_origin`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_source`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_group_id`	`string`	Selectable in the Payload builder
`product.variants[*].overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[*].max_order_quantity`	`integer`	Selectable in the Payload builder
`product.variants[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`product.variants[*].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].image_id`	`integer`	Selectable in the Payload builder
`product.variants[*].created_at`	`string`	Selectable in the Payload builder
`product.variants[*].updated_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].prices[].regular_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].cost_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].price`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_name`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].available`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_sku`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].available`	`integer`	Selectable in the Payload builder
`product.variants[*].metafields_count`	`integer`	Selectable in the Payload builder
`product.metafields_count`	`integer`	Selectable in the Payload builder
`product.warnings`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "channel_id": "...",
  "installation_id": null,
  "product": {
    "attribute_ids": [],
    "barcode": null,
    "brand": null,
    "brand_id": null,
    "categories": [
      {
        "id": 0,
        "name": "...",
        "path": "...",
        "slug": "..."
      }
    ],
    "category_ids": [],
    "channel_ids": [],
    "channel_publications": [
      {
        "channel_id": "...",
        "code": null,
        "message": null,
        "publication_id": "...",
        "status": "...",
        "version": 0
      }
    ],
    "condition": "...",
    "country_of_origin": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": null,
    "dimension_unit": null,
    "formatted_price_max": null,
    "formatted_price_min": null,
    "formatted_regular_price": null,
    "formatted_sale_price": null,
    "formatted_sale_price_max": null,
    "formatted_sale_price_min": null,
    "gift_only": false,
    "height": null,
    "hide_from_listings": false,
    "hs_code": null,
    "id": 0,
    "identifier_status": "...",
    "images": [
      {
        "alt_text": null,
        "cdn_url": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "file_id": null,
        "id": 0,
        "media_type": "...",
        "sort_order": 0,
        "thumbnail_url": "...",
        "url": "..."
      }
    ],
    "inventory": [
      {
        "available": 0,
        "checkout_held": 0,
        "location_id": "...",
        "location_name": null,
        "low_stock_threshold": null,
        "order_committed": 0,
        "other_held": 0,
        "quantity": 0,
        "reserved": 0
      }
    ],
    "inventory_group_id": null,
    "inventory_source": "...",
    "inventory_tracking_state": "...",
    "is_gift_card": false,
    "length": null,
    "max_order_quantity": null,
    "metafields_count": 0,
    "mpn": null,
    "no_manufacturer_identifiers": false,
    "overall_low_stock_threshold": null,
    "prices": [
      {
        "cost_price": null,
        "currency_code": "...",
        "regular_price": "...",
        "sale_ends_at": null,
        "sale_ends_at_iso": null,
        "sale_price": null,
        "sale_starts_at": null,
        "sale_starts_at_iso": null
      }
    ],
    "publish_at": null,
    "publish_at_iso": null,
    "published_at": null,
    "quantity_tiers": [
      {
        "min_quantity": 0,
        "percent": "...",
        "target_id": 0,
        "target_type": "..."
      }
    ],
    "requires_shipping": false,
    "sales_count": 0,
    "seo_description": null,
    "seo_title": null,
    "shipping_prices": [
      {
        "currency_code": "...",
        "price": "..."
      }
    ],
    "short_description": null,
    "sku": "...",
    "slug": "...",
    "status": "...",
    "storefront_url": null,
    "tag_ids": [],
    "tags": [],
    "tax_classes": [
      {
        "market_id": "...",
        "market_name": "...",
        "tax_class_id": "...",
        "tax_class_name": "..."
      }
    ],
    "template_handle": null,
    "title": "...",
    "total_stock": null,
    "type": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variants": [
      {
        "attribute_values": [
          {
            "attribute_id": 0,
            "attribute_name": "...",
            "attribute_slug": "...",
            "option_color": null,
            "option_id": null,
            "option_label": null,
            "option_value": null,
            "sort_order": 0
          }
        ],
        "barcode": null,
        "condition": null,
        "country_of_origin": null,
        "created_at": "2026-06-09T12:00:00+05:30",
        "dimension_unit": null,
        "height": null,
        "hs_code": null,
        "id": 0,
        "identifier_status": null,
        "image_id": null,
        "inventory": [
          {
            "available": 0,
            "checkout_held": 0,
            "location_id": "...",
            "location_name": null,
            "low_stock_threshold": null,
            "order_committed": 0,
            "other_held": 0,
            "quantity": 0,
            "reserved": 0
          }
        ],
        "inventory_group_id": null,
        "inventory_groups": [
          {
            "available": 0,
            "checkout_held": 0,
            "group_id": "...",
            "group_name": "...",
            "group_sku": null,
            "order_committed": 0,
            "other_held": 0,
            "quantity": 0,
            "reserved": 0
          }
        ],
        "inventory_source": "...",
        "length": null,
        "max_order_quantity": null,
        "metafields_count": 0,
        "mpn": null,
        "no_manufacturer_identifiers": null,
        "overall_low_stock_threshold": null,
        "prices": [
          {
            "cost_price": null,
            "currency_code": "...",
            "regular_price": "...",
            "sale_ends_at": null,
            "sale_ends_at_iso": null,
            "sale_price": null,
            "sale_starts_at": null,
            "sale_starts_at_iso": null
          }
        ],
        "product_id": 0,
        "requires_shipping": null,
        "shipping_prices": [
          {
            "currency_code": "...",
            "price": "..."
          }
        ],
        "sku": "...",
        "sort_order": 0,
        "tax_classes": [
          {
            "market_id": "...",
            "market_name": "...",
            "tax_class_id": "...",
            "tax_class_name": "..."
          }
        ],
        "title": "...",
        "title_is_custom": false,
        "updated_at": "2026-06-09T12:00:00+05:30",
        "weight": null,
        "weight_unit": null,
        "width": null
      }
    ],
    "variants_count": null,
    "vendor": null,
    "vendor_id": null,
    "warnings": [],
    "weight": null,
    "weight_unit": null,
    "width": null
  },
  "publication_id": "...",
  "version": 0
}

product_publications/delete

EVENT product_publications/delete App scope: read_products Staff permission: products:write

Payload fields

Field	Type	Description
`publication_id`	`string`	Always present
`version`	`integer`	Always present
`channel_id`	`string`	Always present
`installation_id`	`string`	Selectable in the Payload builder
`product.id`	`integer`	Always present
`product.storefront_url`	`string`	Selectable in the Payload builder
`product.is_gift_card`	`boolean`	Selectable in the Payload builder
`product.gift_only`	`boolean`	Selectable in the Payload builder
`product.hide_from_listings`	`boolean`	Selectable in the Payload builder
`product.title`	`string`	Selectable in the Payload builder
`product.slug`	`string`	Selectable in the Payload builder
`product.description`	`string`	Selectable in the Payload builder
`product.short_description`	`string`	Selectable in the Payload builder
`product.type`	`string`	Selectable in the Payload builder
`product.status`	`string`	Selectable in the Payload builder
`product.vendor_id`	`integer`	Selectable in the Payload builder
`product.vendor`	`string`	Selectable in the Payload builder
`product.brand_id`	`integer`	Selectable in the Payload builder
`product.tags`	`array`	Selectable in the Payload builder
`product.tag_ids`	`array`	Selectable in the Payload builder
`product.attribute_ids`	`array`	Selectable in the Payload builder
`product.seo_title`	`string`	Selectable in the Payload builder
`product.seo_description`	`string`	Selectable in the Payload builder
`product.template_handle`	`string`	Selectable in the Payload builder
`product.sku`	`string`	Selectable in the Payload builder
`product.barcode`	`string`	Selectable in the Payload builder
`product.condition`	`string`	Selectable in the Payload builder
`product.mpn`	`string`	Selectable in the Payload builder
`product.brand`	`string`	Selectable in the Payload builder
`product.no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.identifier_status`	`string`	Selectable in the Payload builder
`product.weight`	`number`	Selectable in the Payload builder
`product.weight_unit`	`string`	Selectable in the Payload builder
`product.length`	`number`	Selectable in the Payload builder
`product.width`	`number`	Selectable in the Payload builder
`product.height`	`number`	Selectable in the Payload builder
`product.dimension_unit`	`string`	Selectable in the Payload builder
`product.hs_code`	`string`	Selectable in the Payload builder
`product.country_of_origin`	`string`	Selectable in the Payload builder
`product.inventory_source`	`string`	Selectable in the Payload builder
`product.inventory_group_id`	`string`	Selectable in the Payload builder
`product.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.max_order_quantity`	`integer`	Selectable in the Payload builder
`product.total_stock`	`integer`	Selectable in the Payload builder
`product.inventory_tracking_state`	`string`	Selectable in the Payload builder
`product.requires_shipping`	`boolean`	Selectable in the Payload builder
`product.publish_at`	`string`	Selectable in the Payload builder
`product.publish_at_iso`	`string`	Selectable in the Payload builder
`product.published_at`	`string`	Selectable in the Payload builder
`product.created_at`	`string`	Selectable in the Payload builder
`product.updated_at`	`string`	Selectable in the Payload builder
`product.sales_count`	`integer`	Selectable in the Payload builder
`product.formatted_regular_price`	`string`	Selectable in the Payload builder
`product.formatted_sale_price`	`string`	Selectable in the Payload builder
`product.formatted_price_min`	`string`	Selectable in the Payload builder
`product.formatted_price_max`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_min`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_max`	`string`	Selectable in the Payload builder
`product.prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.prices[*].regular_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_price`	`string`	Selectable in the Payload builder
`product.prices[*].cost_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].price`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_name`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_name`	`string`	Selectable in the Payload builder
`product.images[*].id`	`integer`	Selectable in the Payload builder
`product.images[*].file_id`	`string`	Selectable in the Payload builder
`product.images[*].url`	`string`	Selectable in the Payload builder
`product.images[*].cdn_url`	`string`	Selectable in the Payload builder
`product.images[*].thumbnail_url`	`string`	Selectable in the Payload builder
`product.images[*].media_type`	`string`	Selectable in the Payload builder
`product.images[*].alt_text`	`string`	Selectable in the Payload builder
`product.images[*].sort_order`	`integer`	Selectable in the Payload builder
`product.images[*].created_at`	`string`	Selectable in the Payload builder
`product.inventory[*].location_id`	`string`	Selectable in the Payload builder
`product.inventory[*].location_name`	`string`	Selectable in the Payload builder
`product.inventory[*].quantity`	`integer`	Selectable in the Payload builder
`product.inventory[*].reserved`	`integer`	Selectable in the Payload builder
`product.inventory[*].checkout_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].order_committed`	`integer`	Selectable in the Payload builder
`product.inventory[*].other_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].available`	`integer`	Selectable in the Payload builder
`product.inventory[*].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.category_ids`	`array`	Selectable in the Payload builder
`product.categories[*].id`	`integer`	Selectable in the Payload builder
`product.categories[*].name`	`string`	Selectable in the Payload builder
`product.categories[*].slug`	`string`	Selectable in the Payload builder
`product.categories[*].path`	`string`	Selectable in the Payload builder
`product.channel_ids`	`array`	Selectable in the Payload builder
`product.channel_publications[*].channel_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].publication_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].version`	`integer`	Selectable in the Payload builder
`product.channel_publications[*].status`	`string`	Selectable in the Payload builder
`product.channel_publications[*].code`	`string`	Selectable in the Payload builder
`product.channel_publications[*].message`	`string`	Selectable in the Payload builder
`product.quantity_tiers[*].target_type`	`string`	Always present
`product.quantity_tiers[*].target_id`	`integer`	Always present
`product.quantity_tiers[*].min_quantity`	`integer`	Always present
`product.quantity_tiers[*].percent`	`string`	Always present
`product.variants_count`	`integer`	Selectable in the Payload builder
`product.variants[*].id`	`integer`	Always present
`product.variants[*].product_id`	`integer`	Always present
`product.variants[*].sku`	`string`	Selectable in the Payload builder
`product.variants[*].barcode`	`string`	Selectable in the Payload builder
`product.variants[*].condition`	`string`	Selectable in the Payload builder
`product.variants[*].mpn`	`string`	Selectable in the Payload builder
`product.variants[*].no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.variants[*].identifier_status`	`string`	Selectable in the Payload builder
`product.variants[*].title`	`string`	Selectable in the Payload builder
`product.variants[*].title_is_custom`	`boolean`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_name`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_slug`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_label`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_value`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_color`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].weight`	`number`	Selectable in the Payload builder
`product.variants[*].weight_unit`	`string`	Selectable in the Payload builder
`product.variants[*].length`	`number`	Selectable in the Payload builder
`product.variants[*].width`	`number`	Selectable in the Payload builder
`product.variants[*].height`	`number`	Selectable in the Payload builder
`product.variants[*].dimension_unit`	`string`	Selectable in the Payload builder
`product.variants[*].hs_code`	`string`	Selectable in the Payload builder
`product.variants[*].country_of_origin`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_source`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_group_id`	`string`	Selectable in the Payload builder
`product.variants[*].overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[*].max_order_quantity`	`integer`	Selectable in the Payload builder
`product.variants[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`product.variants[*].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].image_id`	`integer`	Selectable in the Payload builder
`product.variants[*].created_at`	`string`	Selectable in the Payload builder
`product.variants[*].updated_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].prices[].regular_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].cost_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].price`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_name`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].available`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_sku`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].available`	`integer`	Selectable in the Payload builder
`product.variants[*].metafields_count`	`integer`	Selectable in the Payload builder
`product.metafields_count`	`integer`	Selectable in the Payload builder
`product.warnings`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "channel_id": "...",
  "installation_id": null,
  "product": {
    "attribute_ids": [],
    "barcode": null,
    "brand": null,
    "brand_id": null,
    "categories": [
      {
        "id": 0,
        "name": "...",
        "path": "...",
        "slug": "..."
      }
    ],
    "category_ids": [],
    "channel_ids": [],
    "channel_publications": [
      {
        "channel_id": "...",
        "code": null,
        "message": null,
        "publication_id": "...",
        "status": "...",
        "version": 0
      }
    ],
    "condition": "...",
    "country_of_origin": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": null,
    "dimension_unit": null,
    "formatted_price_max": null,
    "formatted_price_min": null,
    "formatted_regular_price": null,
    "formatted_sale_price": null,
    "formatted_sale_price_max": null,
    "formatted_sale_price_min": null,
    "gift_only": false,
    "height": null,
    "hide_from_listings": false,
    "hs_code": null,
    "id": 0,
    "identifier_status": "...",
    "images": [
      {
        "alt_text": null,
        "cdn_url": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "file_id": null,
        "id": 0,
        "media_type": "...",
        "sort_order": 0,
        "thumbnail_url": "...",
        "url": "..."
      }
    ],
    "inventory": [
      {
        "available": 0,
        "checkout_held": 0,
        "location_id": "...",
        "location_name": null,
        "low_stock_threshold": null,
        "order_committed": 0,
        "other_held": 0,
        "quantity": 0,
        "reserved": 0
      }
    ],
    "inventory_group_id": null,
    "inventory_source": "...",
    "inventory_tracking_state": "...",
    "is_gift_card": false,
    "length": null,
    "max_order_quantity": null,
    "metafields_count": 0,
    "mpn": null,
    "no_manufacturer_identifiers": false,
    "overall_low_stock_threshold": null,
    "prices": [
      {
        "cost_price": null,
        "currency_code": "...",
        "regular_price": "...",
        "sale_ends_at": null,
        "sale_ends_at_iso": null,
        "sale_price": null,
        "sale_starts_at": null,
        "sale_starts_at_iso": null
      }
    ],
    "publish_at": null,
    "publish_at_iso": null,
    "published_at": null,
    "quantity_tiers": [
      {
        "min_quantity": 0,
        "percent": "...",
        "target_id": 0,
        "target_type": "..."
      }
    ],
    "requires_shipping": false,
    "sales_count": 0,
    "seo_description": null,
    "seo_title": null,
    "shipping_prices": [
      {
        "currency_code": "...",
        "price": "..."
      }
    ],
    "short_description": null,
    "sku": "...",
    "slug": "...",
    "status": "...",
    "storefront_url": null,
    "tag_ids": [],
    "tags": [],
    "tax_classes": [
      {
        "market_id": "...",
        "market_name": "...",
        "tax_class_id": "...",
        "tax_class_name": "..."
      }
    ],
    "template_handle": null,
    "title": "...",
    "total_stock": null,
    "type": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variants": [
      {
        "attribute_values": [
          {
            "attribute_id": 0,
            "attribute_name": "...",
            "attribute_slug": "...",
            "option_color": null,
            "option_id": null,
            "option_label": null,
            "option_value": null,
            "sort_order": 0
          }
        ],
        "barcode": null,
        "condition": null,
        "country_of_origin": null,
        "created_at": "2026-06-09T12:00:00+05:30",
        "dimension_unit": null,
        "height": null,
        "hs_code": null,
        "id": 0,
        "identifier_status": null,
        "image_id": null,
        "inventory": [
          {
            "available": 0,
            "checkout_held": 0,
            "location_id": "...",
            "location_name": null,
            "low_stock_threshold": null,
            "order_committed": 0,
            "other_held": 0,
            "quantity": 0,
            "reserved": 0
          }
        ],
        "inventory_group_id": null,
        "inventory_groups": [
          {
            "available": 0,
            "checkout_held": 0,
            "group_id": "...",
            "group_name": "...",
            "group_sku": null,
            "order_committed": 0,
            "other_held": 0,
            "quantity": 0,
            "reserved": 0
          }
        ],
        "inventory_source": "...",
        "length": null,
        "max_order_quantity": null,
        "metafields_count": 0,
        "mpn": null,
        "no_manufacturer_identifiers": null,
        "overall_low_stock_threshold": null,
        "prices": [
          {
            "cost_price": null,
            "currency_code": "...",
            "regular_price": "...",
            "sale_ends_at": null,
            "sale_ends_at_iso": null,
            "sale_price": null,
            "sale_starts_at": null,
            "sale_starts_at_iso": null
          }
        ],
        "product_id": 0,
        "requires_shipping": null,
        "shipping_prices": [
          {
            "currency_code": "...",
            "price": "..."
          }
        ],
        "sku": "...",
        "sort_order": 0,
        "tax_classes": [
          {
            "market_id": "...",
            "market_name": "...",
            "tax_class_id": "...",
            "tax_class_name": "..."
          }
        ],
        "title": "...",
        "title_is_custom": false,
        "updated_at": "2026-06-09T12:00:00+05:30",
        "weight": null,
        "weight_unit": null,
        "width": null
      }
    ],
    "variants_count": null,
    "vendor": null,
    "vendor_id": null,
    "warnings": [],
    "weight": null,
    "weight_unit": null,
    "width": null
  },
  "publication_id": "...",
  "version": 0
}

product_publications/update

EVENT product_publications/update App scope: read_products Staff permission: products:write

Payload fields

Field	Type	Description
`publication_id`	`string`	Always present
`version`	`integer`	Always present
`channel_id`	`string`	Always present
`installation_id`	`string`	Selectable in the Payload builder
`product.id`	`integer`	Always present
`product.storefront_url`	`string`	Selectable in the Payload builder
`product.is_gift_card`	`boolean`	Selectable in the Payload builder
`product.gift_only`	`boolean`	Selectable in the Payload builder
`product.hide_from_listings`	`boolean`	Selectable in the Payload builder
`product.title`	`string`	Selectable in the Payload builder
`product.slug`	`string`	Selectable in the Payload builder
`product.description`	`string`	Selectable in the Payload builder
`product.short_description`	`string`	Selectable in the Payload builder
`product.type`	`string`	Selectable in the Payload builder
`product.status`	`string`	Selectable in the Payload builder
`product.vendor_id`	`integer`	Selectable in the Payload builder
`product.vendor`	`string`	Selectable in the Payload builder
`product.brand_id`	`integer`	Selectable in the Payload builder
`product.tags`	`array`	Selectable in the Payload builder
`product.tag_ids`	`array`	Selectable in the Payload builder
`product.attribute_ids`	`array`	Selectable in the Payload builder
`product.seo_title`	`string`	Selectable in the Payload builder
`product.seo_description`	`string`	Selectable in the Payload builder
`product.template_handle`	`string`	Selectable in the Payload builder
`product.sku`	`string`	Selectable in the Payload builder
`product.barcode`	`string`	Selectable in the Payload builder
`product.condition`	`string`	Selectable in the Payload builder
`product.mpn`	`string`	Selectable in the Payload builder
`product.brand`	`string`	Selectable in the Payload builder
`product.no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.identifier_status`	`string`	Selectable in the Payload builder
`product.weight`	`number`	Selectable in the Payload builder
`product.weight_unit`	`string`	Selectable in the Payload builder
`product.length`	`number`	Selectable in the Payload builder
`product.width`	`number`	Selectable in the Payload builder
`product.height`	`number`	Selectable in the Payload builder
`product.dimension_unit`	`string`	Selectable in the Payload builder
`product.hs_code`	`string`	Selectable in the Payload builder
`product.country_of_origin`	`string`	Selectable in the Payload builder
`product.inventory_source`	`string`	Selectable in the Payload builder
`product.inventory_group_id`	`string`	Selectable in the Payload builder
`product.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.max_order_quantity`	`integer`	Selectable in the Payload builder
`product.total_stock`	`integer`	Selectable in the Payload builder
`product.inventory_tracking_state`	`string`	Selectable in the Payload builder
`product.requires_shipping`	`boolean`	Selectable in the Payload builder
`product.publish_at`	`string`	Selectable in the Payload builder
`product.publish_at_iso`	`string`	Selectable in the Payload builder
`product.published_at`	`string`	Selectable in the Payload builder
`product.created_at`	`string`	Selectable in the Payload builder
`product.updated_at`	`string`	Selectable in the Payload builder
`product.sales_count`	`integer`	Selectable in the Payload builder
`product.formatted_regular_price`	`string`	Selectable in the Payload builder
`product.formatted_sale_price`	`string`	Selectable in the Payload builder
`product.formatted_price_min`	`string`	Selectable in the Payload builder
`product.formatted_price_max`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_min`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_max`	`string`	Selectable in the Payload builder
`product.prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.prices[*].regular_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_price`	`string`	Selectable in the Payload builder
`product.prices[*].cost_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].price`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_name`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_name`	`string`	Selectable in the Payload builder
`product.images[*].id`	`integer`	Selectable in the Payload builder
`product.images[*].file_id`	`string`	Selectable in the Payload builder
`product.images[*].url`	`string`	Selectable in the Payload builder
`product.images[*].cdn_url`	`string`	Selectable in the Payload builder
`product.images[*].thumbnail_url`	`string`	Selectable in the Payload builder
`product.images[*].media_type`	`string`	Selectable in the Payload builder
`product.images[*].alt_text`	`string`	Selectable in the Payload builder
`product.images[*].sort_order`	`integer`	Selectable in the Payload builder
`product.images[*].created_at`	`string`	Selectable in the Payload builder
`product.inventory[*].location_id`	`string`	Selectable in the Payload builder
`product.inventory[*].location_name`	`string`	Selectable in the Payload builder
`product.inventory[*].quantity`	`integer`	Selectable in the Payload builder
`product.inventory[*].reserved`	`integer`	Selectable in the Payload builder
`product.inventory[*].checkout_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].order_committed`	`integer`	Selectable in the Payload builder
`product.inventory[*].other_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].available`	`integer`	Selectable in the Payload builder
`product.inventory[*].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.category_ids`	`array`	Selectable in the Payload builder
`product.categories[*].id`	`integer`	Selectable in the Payload builder
`product.categories[*].name`	`string`	Selectable in the Payload builder
`product.categories[*].slug`	`string`	Selectable in the Payload builder
`product.categories[*].path`	`string`	Selectable in the Payload builder
`product.channel_ids`	`array`	Selectable in the Payload builder
`product.channel_publications[*].channel_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].publication_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].version`	`integer`	Selectable in the Payload builder
`product.channel_publications[*].status`	`string`	Selectable in the Payload builder
`product.channel_publications[*].code`	`string`	Selectable in the Payload builder
`product.channel_publications[*].message`	`string`	Selectable in the Payload builder
`product.quantity_tiers[*].target_type`	`string`	Always present
`product.quantity_tiers[*].target_id`	`integer`	Always present
`product.quantity_tiers[*].min_quantity`	`integer`	Always present
`product.quantity_tiers[*].percent`	`string`	Always present
`product.variants_count`	`integer`	Selectable in the Payload builder
`product.variants[*].id`	`integer`	Always present
`product.variants[*].product_id`	`integer`	Always present
`product.variants[*].sku`	`string`	Selectable in the Payload builder
`product.variants[*].barcode`	`string`	Selectable in the Payload builder
`product.variants[*].condition`	`string`	Selectable in the Payload builder
`product.variants[*].mpn`	`string`	Selectable in the Payload builder
`product.variants[*].no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.variants[*].identifier_status`	`string`	Selectable in the Payload builder
`product.variants[*].title`	`string`	Selectable in the Payload builder
`product.variants[*].title_is_custom`	`boolean`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_name`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_slug`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_label`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_value`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_color`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].weight`	`number`	Selectable in the Payload builder
`product.variants[*].weight_unit`	`string`	Selectable in the Payload builder
`product.variants[*].length`	`number`	Selectable in the Payload builder
`product.variants[*].width`	`number`	Selectable in the Payload builder
`product.variants[*].height`	`number`	Selectable in the Payload builder
`product.variants[*].dimension_unit`	`string`	Selectable in the Payload builder
`product.variants[*].hs_code`	`string`	Selectable in the Payload builder
`product.variants[*].country_of_origin`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_source`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_group_id`	`string`	Selectable in the Payload builder
`product.variants[*].overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[*].max_order_quantity`	`integer`	Selectable in the Payload builder
`product.variants[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`product.variants[*].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].image_id`	`integer`	Selectable in the Payload builder
`product.variants[*].created_at`	`string`	Selectable in the Payload builder
`product.variants[*].updated_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].prices[].regular_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].cost_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].price`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_name`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].available`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_sku`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].available`	`integer`	Selectable in the Payload builder
`product.variants[*].metafields_count`	`integer`	Selectable in the Payload builder
`product.metafields_count`	`integer`	Selectable in the Payload builder
`product.warnings`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "channel_id": "...",
  "installation_id": null,
  "product": {
    "attribute_ids": [],
    "barcode": null,
    "brand": null,
    "brand_id": null,
    "categories": [
      {
        "id": 0,
        "name": "...",
        "path": "...",
        "slug": "..."
      }
    ],
    "category_ids": [],
    "channel_ids": [],
    "channel_publications": [
      {
        "channel_id": "...",
        "code": null,
        "message": null,
        "publication_id": "...",
        "status": "...",
        "version": 0
      }
    ],
    "condition": "...",
    "country_of_origin": null,
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": null,
    "dimension_unit": null,
    "formatted_price_max": null,
    "formatted_price_min": null,
    "formatted_regular_price": null,
    "formatted_sale_price": null,
    "formatted_sale_price_max": null,
    "formatted_sale_price_min": null,
    "gift_only": false,
    "height": null,
    "hide_from_listings": false,
    "hs_code": null,
    "id": 0,
    "identifier_status": "...",
    "images": [
      {
        "alt_text": null,
        "cdn_url": "...",
        "created_at": "2026-06-09T12:00:00+05:30",
        "file_id": null,
        "id": 0,
        "media_type": "...",
        "sort_order": 0,
        "thumbnail_url": "...",
        "url": "..."
      }
    ],
    "inventory": [
      {
        "available": 0,
        "checkout_held": 0,
        "location_id": "...",
        "location_name": null,
        "low_stock_threshold": null,
        "order_committed": 0,
        "other_held": 0,
        "quantity": 0,
        "reserved": 0
      }
    ],
    "inventory_group_id": null,
    "inventory_source": "...",
    "inventory_tracking_state": "...",
    "is_gift_card": false,
    "length": null,
    "max_order_quantity": null,
    "metafields_count": 0,
    "mpn": null,
    "no_manufacturer_identifiers": false,
    "overall_low_stock_threshold": null,
    "prices": [
      {
        "cost_price": null,
        "currency_code": "...",
        "regular_price": "...",
        "sale_ends_at": null,
        "sale_ends_at_iso": null,
        "sale_price": null,
        "sale_starts_at": null,
        "sale_starts_at_iso": null
      }
    ],
    "publish_at": null,
    "publish_at_iso": null,
    "published_at": null,
    "quantity_tiers": [
      {
        "min_quantity": 0,
        "percent": "...",
        "target_id": 0,
        "target_type": "..."
      }
    ],
    "requires_shipping": false,
    "sales_count": 0,
    "seo_description": null,
    "seo_title": null,
    "shipping_prices": [
      {
        "currency_code": "...",
        "price": "..."
      }
    ],
    "short_description": null,
    "sku": "...",
    "slug": "...",
    "status": "...",
    "storefront_url": null,
    "tag_ids": [],
    "tags": [],
    "tax_classes": [
      {
        "market_id": "...",
        "market_name": "...",
        "tax_class_id": "...",
        "tax_class_name": "..."
      }
    ],
    "template_handle": null,
    "title": "...",
    "total_stock": null,
    "type": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variants": [
      {
        "attribute_values": [
          {
            "attribute_id": 0,
            "attribute_name": "...",
            "attribute_slug": "...",
            "option_color": null,
            "option_id": null,
            "option_label": null,
            "option_value": null,
            "sort_order": 0
          }
        ],
        "barcode": null,
        "condition": null,
        "country_of_origin": null,
        "created_at": "2026-06-09T12:00:00+05:30",
        "dimension_unit": null,
        "height": null,
        "hs_code": null,
        "id": 0,
        "identifier_status": null,
        "image_id": null,
        "inventory": [
          {
            "available": 0,
            "checkout_held": 0,
            "location_id": "...",
            "location_name": null,
            "low_stock_threshold": null,
            "order_committed": 0,
            "other_held": 0,
            "quantity": 0,
            "reserved": 0
          }
        ],
        "inventory_group_id": null,
        "inventory_groups": [
          {
            "available": 0,
            "checkout_held": 0,
            "group_id": "...",
            "group_name": "...",
            "group_sku": null,
            "order_committed": 0,
            "other_held": 0,
            "quantity": 0,
            "reserved": 0
          }
        ],
        "inventory_source": "...",
        "length": null,
        "max_order_quantity": null,
        "metafields_count": 0,
        "mpn": null,
        "no_manufacturer_identifiers": null,
        "overall_low_stock_threshold": null,
        "prices": [
          {
            "cost_price": null,
            "currency_code": "...",
            "regular_price": "...",
            "sale_ends_at": null,
            "sale_ends_at_iso": null,
            "sale_price": null,
            "sale_starts_at": null,
            "sale_starts_at_iso": null
          }
        ],
        "product_id": 0,
        "requires_shipping": null,
        "shipping_prices": [
          {
            "currency_code": "...",
            "price": "..."
          }
        ],
        "sku": "...",
        "sort_order": 0,
        "tax_classes": [
          {
            "market_id": "...",
            "market_name": "...",
            "tax_class_id": "...",
            "tax_class_name": "..."
          }
        ],
        "title": "...",
        "title_is_custom": false,
        "updated_at": "2026-06-09T12:00:00+05:30",
        "weight": null,
        "weight_unit": null,
        "width": null
      }
    ],
    "variants_count": null,
    "vendor": null,
    "vendor_id": null,
    "warnings": [],
    "weight": null,
    "weight_unit": null,
    "width": null
  },
  "publication_id": "...",
  "version": 0
}

Product created

EVENT products/create App scope: read_products Staff permission: products:write

Fired when a parent product is created. Payload carries the current parent product snapshot; variants and metafields emit their own events. During a CSV product import, products/create and products/update carry the product's complete variant list in product.variants and no per-variant variants/create or variants/update events are sent.

Payload fields

Field	Type	Description
`product.id`	`integer`	Always present
`product.storefront_url`	`string`	Selectable in the Payload builder
`product.is_gift_card`	`boolean`	Selectable in the Payload builder
`product.gift_only`	`boolean`	Selectable in the Payload builder
`product.hide_from_listings`	`boolean`	Selectable in the Payload builder
`product.title`	`string`	Selectable in the Payload builder
`product.slug`	`string`	Selectable in the Payload builder
`product.description`	`string`	Selectable in the Payload builder
`product.short_description`	`string`	Selectable in the Payload builder
`product.type`	`string`	Selectable in the Payload builder
`product.status`	`string`	Selectable in the Payload builder
`product.vendor_id`	`integer`	Selectable in the Payload builder
`product.vendor`	`string`	Selectable in the Payload builder
`product.brand_id`	`integer`	Selectable in the Payload builder
`product.tags`	`array`	Selectable in the Payload builder
`product.tag_ids`	`array`	Selectable in the Payload builder
`product.attribute_ids`	`array`	Selectable in the Payload builder
`product.seo_title`	`string`	Selectable in the Payload builder
`product.seo_description`	`string`	Selectable in the Payload builder
`product.template_handle`	`string`	Selectable in the Payload builder
`product.sku`	`string`	Selectable in the Payload builder
`product.barcode`	`string`	Selectable in the Payload builder
`product.condition`	`string`	Selectable in the Payload builder
`product.mpn`	`string`	Selectable in the Payload builder
`product.brand`	`string`	Selectable in the Payload builder
`product.no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.identifier_status`	`string`	Selectable in the Payload builder
`product.weight`	`number`	Selectable in the Payload builder
`product.weight_unit`	`string`	Selectable in the Payload builder
`product.length`	`number`	Selectable in the Payload builder
`product.width`	`number`	Selectable in the Payload builder
`product.height`	`number`	Selectable in the Payload builder
`product.dimension_unit`	`string`	Selectable in the Payload builder
`product.hs_code`	`string`	Selectable in the Payload builder
`product.country_of_origin`	`string`	Selectable in the Payload builder
`product.inventory_source`	`string`	Selectable in the Payload builder
`product.inventory_group_id`	`string`	Selectable in the Payload builder
`product.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.max_order_quantity`	`integer`	Selectable in the Payload builder
`product.total_stock`	`integer`	Selectable in the Payload builder
`product.inventory_tracking_state`	`string`	Selectable in the Payload builder
`product.requires_shipping`	`boolean`	Selectable in the Payload builder
`product.publish_at`	`string`	Selectable in the Payload builder
`product.publish_at_iso`	`string`	Selectable in the Payload builder
`product.published_at`	`string`	Selectable in the Payload builder
`product.created_at`	`string`	Selectable in the Payload builder
`product.updated_at`	`string`	Selectable in the Payload builder
`product.sales_count`	`integer`	Selectable in the Payload builder
`product.formatted_regular_price`	`string`	Selectable in the Payload builder
`product.formatted_sale_price`	`string`	Selectable in the Payload builder
`product.formatted_price_min`	`string`	Selectable in the Payload builder
`product.formatted_price_max`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_min`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_max`	`string`	Selectable in the Payload builder
`product.prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.prices[*].regular_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_price`	`string`	Selectable in the Payload builder
`product.prices[*].cost_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].price`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_name`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_name`	`string`	Selectable in the Payload builder
`product.images[*].id`	`integer`	Selectable in the Payload builder
`product.images[*].file_id`	`string`	Selectable in the Payload builder
`product.images[*].url`	`string`	Selectable in the Payload builder
`product.images[*].cdn_url`	`string`	Selectable in the Payload builder
`product.images[*].thumbnail_url`	`string`	Selectable in the Payload builder
`product.images[*].media_type`	`string`	Selectable in the Payload builder
`product.images[*].alt_text`	`string`	Selectable in the Payload builder
`product.images[*].sort_order`	`integer`	Selectable in the Payload builder
`product.images[*].created_at`	`string`	Selectable in the Payload builder
`product.inventory[*].location_id`	`string`	Selectable in the Payload builder
`product.inventory[*].location_name`	`string`	Selectable in the Payload builder
`product.inventory[*].quantity`	`integer`	Selectable in the Payload builder
`product.inventory[*].reserved`	`integer`	Selectable in the Payload builder
`product.inventory[*].checkout_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].order_committed`	`integer`	Selectable in the Payload builder
`product.inventory[*].other_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].available`	`integer`	Selectable in the Payload builder
`product.inventory[*].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.category_ids`	`array`	Selectable in the Payload builder
`product.categories[*].id`	`integer`	Selectable in the Payload builder
`product.categories[*].name`	`string`	Selectable in the Payload builder
`product.categories[*].slug`	`string`	Selectable in the Payload builder
`product.categories[*].path`	`string`	Selectable in the Payload builder
`product.channel_ids`	`array`	Selectable in the Payload builder
`product.channel_publications[*].channel_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].publication_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].version`	`integer`	Selectable in the Payload builder
`product.channel_publications[*].status`	`string`	Selectable in the Payload builder
`product.channel_publications[*].code`	`string`	Selectable in the Payload builder
`product.channel_publications[*].message`	`string`	Selectable in the Payload builder
`product.quantity_tiers[*].target_type`	`string`	Always present
`product.quantity_tiers[*].target_id`	`integer`	Always present
`product.quantity_tiers[*].min_quantity`	`integer`	Always present
`product.quantity_tiers[*].percent`	`string`	Always present
`product.variants_count`	`integer`	Selectable in the Payload builder
`product.variants[*].id`	`integer`	Always present
`product.variants[*].product_id`	`integer`	Always present
`product.variants[*].sku`	`string`	Selectable in the Payload builder
`product.variants[*].barcode`	`string`	Selectable in the Payload builder
`product.variants[*].condition`	`string`	Selectable in the Payload builder
`product.variants[*].mpn`	`string`	Selectable in the Payload builder
`product.variants[*].no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.variants[*].identifier_status`	`string`	Selectable in the Payload builder
`product.variants[*].title`	`string`	Selectable in the Payload builder
`product.variants[*].title_is_custom`	`boolean`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_name`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_slug`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_label`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_value`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_color`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].weight`	`number`	Selectable in the Payload builder
`product.variants[*].weight_unit`	`string`	Selectable in the Payload builder
`product.variants[*].length`	`number`	Selectable in the Payload builder
`product.variants[*].width`	`number`	Selectable in the Payload builder
`product.variants[*].height`	`number`	Selectable in the Payload builder
`product.variants[*].dimension_unit`	`string`	Selectable in the Payload builder
`product.variants[*].hs_code`	`string`	Selectable in the Payload builder
`product.variants[*].country_of_origin`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_source`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_group_id`	`string`	Selectable in the Payload builder
`product.variants[*].overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[*].max_order_quantity`	`integer`	Selectable in the Payload builder
`product.variants[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`product.variants[*].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].image_id`	`integer`	Selectable in the Payload builder
`product.variants[*].created_at`	`string`	Selectable in the Payload builder
`product.variants[*].updated_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].prices[].regular_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].cost_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].price`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_name`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].available`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_sku`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].available`	`integer`	Selectable in the Payload builder
`product.variants[*].metafields_count`	`integer`	Selectable in the Payload builder
`product.metafields_count`	`integer`	Selectable in the Payload builder
`product.warnings`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "product": {
    "attribute_ids": [
      1,
      2
    ],
    "brand": "Trailwear",
    "brand_id": 7,
    "categories": [
      {
        "id": 5,
        "name": "T-shirts",
        "path": "Clothing \u003e T-shirts",
        "slug": "t-shirts"
      }
    ],
    "category_ids": [
      5
    ],
    "channel_ids": [
      "22222222-2222-4222-8222-222222222222"
    ],
    "condition": "new",
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "\u003cp\u003eA breathable organic cotton tee.\u003c/p\u003e",
    "gift_only": false,
    "hide_from_listings": false,
    "id": 42,
    "identifier_status": "provided",
    "inventory_source": "track",
    "inventory_tracking_state": "tracked",
    "is_gift_card": false,
    "metafields_count": 0,
    "mpn": "TRB-TEE",
    "no_manufacturer_identifiers": false,
    "quantity_tiers": [],
    "requires_shipping": true,
    "sales_count": 0,
    "seo_title": "Trailblazer Tee",
    "short_description": "Breathable organic cotton tee.",
    "sku": "TRB-TEE",
    "slug": "trailblazer-tee",
    "status": "draft",
    "store_id": "11111111-1111-4111-8111-111111111111",
    "tag_ids": [
      8
    ],
    "tags": [
      "Outdoor"
    ],
    "title": "Trailblazer Tee",
    "total_stock": null,
    "type": "variable",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variants_count": 2,
    "vendor": "Acme Apparel",
    "vendor_id": 3
  }
}

Product deleted

EVENT products/delete App scope: read_products Staff permission: products:write

Fired when a product is deleted. Payload carries the product ID, title, and slug. Its metafields and its variants' metafields are deleted with it, without metafield delete events.

Payload fields

Field	Type	Description
`product.id`	`integer`	Always present
`product.title`	`string`	Selectable in the Payload builder
`product.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "product": {
    "id": 42,
    "slug": "trailblazer-tee",
    "title": "Trailblazer Tee — Revised"
  }
}

Product translations deleted

EVENT products/translations/delete App scope: read_products Staff permission: products:write

Fired when a product's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`product.id`	`integer`	Always present
`product.title`	`string`	Selectable in the Payload builder
`product.slug`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`translation.short_description`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "product": {
    "id": 42,
    "slug": "trailblazer-tee",
    "title": "Trailblazer Tee"
  },
  "translation": {
    "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
    "seo_description": "Shop the Trailblazer organic cotton tee.",
    "seo_title": "Trailblazer Tee — Organic Cotton",
    "short_description": "Breathable organic cotton tee.",
    "slug": "trailblazer-tee",
    "title": "Trailblazer Tee"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Product translations updated

EVENT products/translations/update App scope: read_products Staff permission: products:write

Fired when a product's translations are added or updated for a locale. Payload carries only the fields that changed.

Payload fields

Field	Type	Description
`product.id`	`integer`	Always present
`product.title`	`string`	Selectable in the Payload builder
`product.slug`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`translation.slug`	`string`	Selectable in the Payload builder
`translation.description`	`string`	Selectable in the Payload builder
`translation.short_description`	`string`	Selectable in the Payload builder
`translation.seo_title`	`string`	Selectable in the Payload builder
`translation.seo_description`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "product": {
    "id": 42,
    "slug": "trailblazer-tee",
    "title": "Trailblazer Tee"
  },
  "translation": {
    "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
    "seo_description": "Shop the Trailblazer organic cotton tee.",
    "seo_title": "Trailblazer Tee — Organic Cotton",
    "short_description": "Breathable organic cotton tee.",
    "slug": "trailblazer-tee",
    "title": "Trailblazer Tee"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Product updated

EVENT products/update App scope: read_products Staff permission: products:write

Fired when parent product fields change, or when variants are added or removed (changed_fields includes "variants"). Payload carries the current parent product snapshot plus changed_fields; variant fields, metafields, translations, and stock emit their own events. During a CSV product import, products/create and products/update carry the product's complete variant list in product.variants and no per-variant variants/create or variants/update events are sent.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

attribute_ids barcode brand brand_id category_ids channel_ids condition country_of_origin description dimension_unit gift_only height hide_from_listings hs_code identifier_status images inventory_group_id inventory_source length max_order_quantity mpn no_manufacturer_identifiers overall_low_stock_threshold prices publish_at published_at quantity_tiers requires_shipping seo_description seo_title shipping_prices short_description sku slug status tags tax_classes template_handle title variants vendor vendor_id weight weight_unit width

Payload fields

Field	Type	Description
`product.id`	`integer`	Always present
`product.storefront_url`	`string`	Selectable in the Payload builder
`product.is_gift_card`	`boolean`	Selectable in the Payload builder
`product.gift_only`	`boolean`	Selectable in the Payload builder
`product.hide_from_listings`	`boolean`	Selectable in the Payload builder
`product.title`	`string`	Selectable in the Payload builder
`product.slug`	`string`	Selectable in the Payload builder
`product.description`	`string`	Selectable in the Payload builder
`product.short_description`	`string`	Selectable in the Payload builder
`product.type`	`string`	Selectable in the Payload builder
`product.status`	`string`	Selectable in the Payload builder
`product.vendor_id`	`integer`	Selectable in the Payload builder
`product.vendor`	`string`	Selectable in the Payload builder
`product.brand_id`	`integer`	Selectable in the Payload builder
`product.tags`	`array`	Selectable in the Payload builder
`product.tag_ids`	`array`	Selectable in the Payload builder
`product.attribute_ids`	`array`	Selectable in the Payload builder
`product.seo_title`	`string`	Selectable in the Payload builder
`product.seo_description`	`string`	Selectable in the Payload builder
`product.template_handle`	`string`	Selectable in the Payload builder
`product.sku`	`string`	Selectable in the Payload builder
`product.barcode`	`string`	Selectable in the Payload builder
`product.condition`	`string`	Selectable in the Payload builder
`product.mpn`	`string`	Selectable in the Payload builder
`product.brand`	`string`	Selectable in the Payload builder
`product.no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.identifier_status`	`string`	Selectable in the Payload builder
`product.weight`	`number`	Selectable in the Payload builder
`product.weight_unit`	`string`	Selectable in the Payload builder
`product.length`	`number`	Selectable in the Payload builder
`product.width`	`number`	Selectable in the Payload builder
`product.height`	`number`	Selectable in the Payload builder
`product.dimension_unit`	`string`	Selectable in the Payload builder
`product.hs_code`	`string`	Selectable in the Payload builder
`product.country_of_origin`	`string`	Selectable in the Payload builder
`product.inventory_source`	`string`	Selectable in the Payload builder
`product.inventory_group_id`	`string`	Selectable in the Payload builder
`product.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.max_order_quantity`	`integer`	Selectable in the Payload builder
`product.total_stock`	`integer`	Selectable in the Payload builder
`product.inventory_tracking_state`	`string`	Selectable in the Payload builder
`product.requires_shipping`	`boolean`	Selectable in the Payload builder
`product.publish_at`	`string`	Selectable in the Payload builder
`product.publish_at_iso`	`string`	Selectable in the Payload builder
`product.published_at`	`string`	Selectable in the Payload builder
`product.created_at`	`string`	Selectable in the Payload builder
`product.updated_at`	`string`	Selectable in the Payload builder
`product.sales_count`	`integer`	Selectable in the Payload builder
`product.formatted_regular_price`	`string`	Selectable in the Payload builder
`product.formatted_sale_price`	`string`	Selectable in the Payload builder
`product.formatted_price_min`	`string`	Selectable in the Payload builder
`product.formatted_price_max`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_min`	`string`	Selectable in the Payload builder
`product.formatted_sale_price_max`	`string`	Selectable in the Payload builder
`product.prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.prices[*].regular_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_price`	`string`	Selectable in the Payload builder
`product.prices[*].cost_price`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at`	`string`	Selectable in the Payload builder
`product.prices[*].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].currency_code`	`string`	Selectable in the Payload builder
`product.shipping_prices[*].price`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].market_name`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_id`	`string`	Selectable in the Payload builder
`product.tax_classes[*].tax_class_name`	`string`	Selectable in the Payload builder
`product.images[*].id`	`integer`	Selectable in the Payload builder
`product.images[*].file_id`	`string`	Selectable in the Payload builder
`product.images[*].url`	`string`	Selectable in the Payload builder
`product.images[*].cdn_url`	`string`	Selectable in the Payload builder
`product.images[*].thumbnail_url`	`string`	Selectable in the Payload builder
`product.images[*].media_type`	`string`	Selectable in the Payload builder
`product.images[*].alt_text`	`string`	Selectable in the Payload builder
`product.images[*].sort_order`	`integer`	Selectable in the Payload builder
`product.images[*].created_at`	`string`	Selectable in the Payload builder
`product.inventory[*].location_id`	`string`	Selectable in the Payload builder
`product.inventory[*].location_name`	`string`	Selectable in the Payload builder
`product.inventory[*].quantity`	`integer`	Selectable in the Payload builder
`product.inventory[*].reserved`	`integer`	Selectable in the Payload builder
`product.inventory[*].checkout_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].order_committed`	`integer`	Selectable in the Payload builder
`product.inventory[*].other_held`	`integer`	Selectable in the Payload builder
`product.inventory[*].available`	`integer`	Selectable in the Payload builder
`product.inventory[*].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.category_ids`	`array`	Selectable in the Payload builder
`product.categories[*].id`	`integer`	Selectable in the Payload builder
`product.categories[*].name`	`string`	Selectable in the Payload builder
`product.categories[*].slug`	`string`	Selectable in the Payload builder
`product.categories[*].path`	`string`	Selectable in the Payload builder
`product.channel_ids`	`array`	Selectable in the Payload builder
`product.channel_publications[*].channel_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].publication_id`	`string`	Selectable in the Payload builder
`product.channel_publications[*].version`	`integer`	Selectable in the Payload builder
`product.channel_publications[*].status`	`string`	Selectable in the Payload builder
`product.channel_publications[*].code`	`string`	Selectable in the Payload builder
`product.channel_publications[*].message`	`string`	Selectable in the Payload builder
`product.quantity_tiers[*].target_type`	`string`	Always present
`product.quantity_tiers[*].target_id`	`integer`	Always present
`product.quantity_tiers[*].min_quantity`	`integer`	Always present
`product.quantity_tiers[*].percent`	`string`	Always present
`product.variants_count`	`integer`	Selectable in the Payload builder
`product.variants[*].id`	`integer`	Always present
`product.variants[*].product_id`	`integer`	Always present
`product.variants[*].sku`	`string`	Selectable in the Payload builder
`product.variants[*].barcode`	`string`	Selectable in the Payload builder
`product.variants[*].condition`	`string`	Selectable in the Payload builder
`product.variants[*].mpn`	`string`	Selectable in the Payload builder
`product.variants[*].no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`product.variants[*].identifier_status`	`string`	Selectable in the Payload builder
`product.variants[*].title`	`string`	Selectable in the Payload builder
`product.variants[*].title_is_custom`	`boolean`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_name`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].attribute_slug`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_id`	`integer`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_label`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_value`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].option_color`	`string`	Selectable in the Payload builder
`product.variants[].attribute_values[].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].weight`	`number`	Selectable in the Payload builder
`product.variants[*].weight_unit`	`string`	Selectable in the Payload builder
`product.variants[*].length`	`number`	Selectable in the Payload builder
`product.variants[*].width`	`number`	Selectable in the Payload builder
`product.variants[*].height`	`number`	Selectable in the Payload builder
`product.variants[*].dimension_unit`	`string`	Selectable in the Payload builder
`product.variants[*].hs_code`	`string`	Selectable in the Payload builder
`product.variants[*].country_of_origin`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_source`	`string`	Selectable in the Payload builder
`product.variants[*].inventory_group_id`	`string`	Selectable in the Payload builder
`product.variants[*].overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[*].max_order_quantity`	`integer`	Selectable in the Payload builder
`product.variants[*].requires_shipping`	`boolean`	Selectable in the Payload builder
`product.variants[*].sort_order`	`integer`	Selectable in the Payload builder
`product.variants[*].image_id`	`integer`	Selectable in the Payload builder
`product.variants[*].created_at`	`string`	Selectable in the Payload builder
`product.variants[*].updated_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].prices[].regular_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].cost_price`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at`	`string`	Selectable in the Payload builder
`product.variants[].prices[].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].currency_code`	`string`	Selectable in the Payload builder
`product.variants[].shipping_prices[].price`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].market_name`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_id`	`string`	Selectable in the Payload builder
`product.variants[].tax_classes[].tax_class_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].location_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].available`	`integer`	Selectable in the Payload builder
`product.variants[].inventory[].low_stock_threshold`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_id`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_name`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].group_sku`	`string`	Selectable in the Payload builder
`product.variants[].inventory_groups[].quantity`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].reserved`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].checkout_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].order_committed`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].other_held`	`integer`	Selectable in the Payload builder
`product.variants[].inventory_groups[].available`	`integer`	Selectable in the Payload builder
`product.variants[*].metafields_count`	`integer`	Selectable in the Payload builder
`product.metafields_count`	`integer`	Selectable in the Payload builder
`product.warnings`	`array`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status",
    "published_at"
  ],
  "product": {
    "attribute_ids": [
      1,
      2
    ],
    "brand": "Trailwear",
    "brand_id": 7,
    "categories": [
      {
        "id": 5,
        "name": "T-shirts",
        "path": "Clothing \u003e T-shirts",
        "slug": "t-shirts"
      }
    ],
    "category_ids": [
      5
    ],
    "channel_ids": [
      "22222222-2222-4222-8222-222222222222"
    ],
    "condition": "new",
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "\u003cp\u003eA breathable organic cotton tee.\u003c/p\u003e",
    "gift_only": false,
    "hide_from_listings": false,
    "id": 42,
    "identifier_status": "provided",
    "inventory_source": "track",
    "inventory_tracking_state": "tracked",
    "is_gift_card": false,
    "metafields_count": 0,
    "mpn": "TRB-TEE",
    "no_manufacturer_identifiers": false,
    "published_at": "2026-06-10T09:30:00+05:30",
    "quantity_tiers": [],
    "requires_shipping": true,
    "sales_count": 0,
    "seo_title": "Trailblazer Tee",
    "short_description": "Breathable organic cotton tee.",
    "sku": "TRB-TEE",
    "slug": "trailblazer-tee",
    "status": "active",
    "store_id": "11111111-1111-4111-8111-111111111111",
    "storefront_url": "https://store.example.com/products/trailblazer-tee",
    "tag_ids": [
      8
    ],
    "tags": [
      "Outdoor"
    ],
    "title": "Trailblazer Tee — Revised",
    "total_stock": null,
    "type": "variable",
    "updated_at": "2026-06-10T09:30:00+05:30",
    "variants_count": 2,
    "vendor": "Acme Apparel",
    "vendor_id": 3
  }
}

Variant metafield value created

EVENT variant_metafields/create App scope: read_products Staff permission: products:write

Fired when a variant metafield value is created.

Payload fields

Field	Type	Description
`variant.product_id`	`integer`	Selectable in the Payload builder
`variant.variant_id`	`integer`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
      "id": 42,
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "variable",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  },
  "variant": {
    "product_id": 42,
    "variant_id": 1007
  }
}

Variant metafield value deleted

EVENT variant_metafields/delete App scope: read_products Staff permission: products:write

Fired when a variant metafield value is deleted on its own. Removing the variant or deleting its product deletes its metafields without this event.

Payload fields

Field	Type	Description
`variant.product_id`	`integer`	Selectable in the Payload builder
`variant.variant_id`	`integer`	Always present
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
      "id": 42,
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "variable",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  },
  "variant": {
    "product_id": 42,
    "variant_id": 1007
  }
}

Variant metafield translations deleted

EVENT variant_metafields/translations/delete App scope: read_products Staff permission: products:write

Fired when a variant metafield's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`metafield.variant_id`	`integer`	Always present
`metafield.product_id`	`integer`	Always present
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "definition_id": "mfd_2b9c4e01",
    "key": "material",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "specs",
    "product_id": 42,
    "type": "variable",
    "variant_id": 1007
  },
  "translation": {
    "value": "Organic cotton"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Variant metafield translations updated

EVENT variant_metafields/translations/update App scope: read_products Staff permission: products:write

Fired when a variant metafield's translations are added or updated for a locale. Payload carries only the fields that changed.

Payload fields

Field	Type	Description
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`metafield.variant_id`	`integer`	Always present
`metafield.product_id`	`integer`	Always present
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "definition_id": "mfd_2b9c4e01",
    "key": "material",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "specs",
    "product_id": 42,
    "type": "variable",
    "variant_id": 1007
  },
  "translation": {
    "value": "Organic cotton"
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Variant metafield value updated

EVENT variant_metafields/update App scope: read_products Staff permission: products:write

Fired when a variant metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`variant.product_id`	`integer`	Selectable in the Payload builder
`variant.variant_id`	`integer`	Always present
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
      "id": 42,
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "variable",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "\u003cp\u003eA breathable organic cotton tee for long days outside.\u003c/p\u003e",
      "id": 42,
      "is_translatable": false,
      "key": "material",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "specs",
      "owner_type": "product",
      "sort_order": 0,
      "type": "variable",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Organic cotton"
  },
  "variant": {
    "product_id": 42,
    "variant_id": 1007
  }
}

Variant created

EVENT variants/create App scope: read_products Staff permission: products:write

Fired when a product variant is created. Variable product creation emits one event per created variant. During a CSV product import no variants/create events are sent; products/create and products/update carry the complete variant list in product.variants instead.

Payload fields

Field	Type	Description
`variant.id`	`integer`	Always present
`variant.product_id`	`integer`	Always present
`variant.sku`	`string`	Selectable in the Payload builder
`variant.barcode`	`string`	Selectable in the Payload builder
`variant.condition`	`string`	Selectable in the Payload builder
`variant.mpn`	`string`	Selectable in the Payload builder
`variant.no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`variant.identifier_status`	`string`	Selectable in the Payload builder
`variant.title`	`string`	Selectable in the Payload builder
`variant.title_is_custom`	`boolean`	Selectable in the Payload builder
`variant.attribute_values[*].attribute_id`	`integer`	Selectable in the Payload builder
`variant.attribute_values[*].attribute_name`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].attribute_slug`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].option_id`	`integer`	Selectable in the Payload builder
`variant.attribute_values[*].option_label`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].option_value`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].option_color`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].sort_order`	`integer`	Selectable in the Payload builder
`variant.weight`	`number`	Selectable in the Payload builder
`variant.weight_unit`	`string`	Selectable in the Payload builder
`variant.length`	`number`	Selectable in the Payload builder
`variant.width`	`number`	Selectable in the Payload builder
`variant.height`	`number`	Selectable in the Payload builder
`variant.dimension_unit`	`string`	Selectable in the Payload builder
`variant.hs_code`	`string`	Selectable in the Payload builder
`variant.country_of_origin`	`string`	Selectable in the Payload builder
`variant.inventory_source`	`string`	Selectable in the Payload builder
`variant.inventory_group_id`	`string`	Selectable in the Payload builder
`variant.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`variant.max_order_quantity`	`integer`	Selectable in the Payload builder
`variant.requires_shipping`	`boolean`	Selectable in the Payload builder
`variant.sort_order`	`integer`	Selectable in the Payload builder
`variant.image_id`	`integer`	Selectable in the Payload builder
`variant.created_at`	`string`	Selectable in the Payload builder
`variant.updated_at`	`string`	Selectable in the Payload builder
`variant.prices[*].currency_code`	`string`	Selectable in the Payload builder
`variant.prices[*].regular_price`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_price`	`string`	Selectable in the Payload builder
`variant.prices[*].cost_price`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_starts_at`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_ends_at`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`variant.shipping_prices[*].currency_code`	`string`	Selectable in the Payload builder
`variant.shipping_prices[*].price`	`string`	Selectable in the Payload builder
`variant.tax_classes[*].market_id`	`string`	Selectable in the Payload builder
`variant.tax_classes[*].market_name`	`string`	Selectable in the Payload builder
`variant.tax_classes[*].tax_class_id`	`string`	Selectable in the Payload builder
`variant.tax_classes[*].tax_class_name`	`string`	Selectable in the Payload builder
`variant.inventory[*].location_id`	`string`	Selectable in the Payload builder
`variant.inventory[*].location_name`	`string`	Selectable in the Payload builder
`variant.inventory[*].quantity`	`integer`	Selectable in the Payload builder
`variant.inventory[*].reserved`	`integer`	Selectable in the Payload builder
`variant.inventory[*].checkout_held`	`integer`	Selectable in the Payload builder
`variant.inventory[*].order_committed`	`integer`	Selectable in the Payload builder
`variant.inventory[*].other_held`	`integer`	Selectable in the Payload builder
`variant.inventory[*].available`	`integer`	Selectable in the Payload builder
`variant.inventory[*].low_stock_threshold`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].group_id`	`string`	Selectable in the Payload builder
`variant.inventory_groups[*].group_name`	`string`	Selectable in the Payload builder
`variant.inventory_groups[*].group_sku`	`string`	Selectable in the Payload builder
`variant.inventory_groups[*].quantity`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].reserved`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].checkout_held`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].order_committed`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].other_held`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].available`	`integer`	Selectable in the Payload builder
`variant.metafields_count`	`integer`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "variant": {
    "attribute_values": [
      {
        "attribute_id": 1,
        "attribute_name": "Color",
        "attribute_slug": "color",
        "option_id": 5,
        "option_label": "Red",
        "option_value": "red",
        "sort_order": 0
      },
      {
        "attribute_id": 2,
        "attribute_name": "Size",
        "attribute_slug": "size",
        "option_id": 9,
        "option_label": "M",
        "option_value": "m",
        "sort_order": 1
      }
    ],
    "condition": "new",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": 1007,
    "identifier_status": "provided",
    "inventory": [
      {
        "available": 120,
        "checkout_held": 0,
        "location_id": "33333333-3333-4333-8333-333333333333",
        "location_name": "Main warehouse",
        "order_committed": 0,
        "other_held": 0,
        "quantity": 120,
        "reserved": 0
      }
    ],
    "inventory_source": "track",
    "metafields_count": 0,
    "mpn": "TRB-TEE-RED-M",
    "prices": [
      {
        "currency_code": "USD",
        "regular_price": "29.00"
      }
    ],
    "product_id": 42,
    "requires_shipping": true,
    "shipping_prices": [],
    "sku": "TRB-TEE-RED-M",
    "sort_order": 0,
    "store_id": "11111111-1111-4111-8111-111111111111",
    "title": "Red / M",
    "title_is_custom": false,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "weight": 0.25,
    "weight_unit": "kg"
  }
}

Variant deleted

EVENT variants/delete App scope: read_products Staff permission: products:write

Fired when a product variant is deleted. Payload carries the variant ID, parent product ID, SKU, and title. Its metafields are deleted with it, without variant_metafields/delete events.

Payload fields

Field	Type	Description
`variant.id`	`integer`	Always present
`variant.product_id`	`integer`	Always present
`variant.sku`	`string`	Selectable in the Payload builder
`variant.title`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "variant": {
    "id": 1009,
    "product_id": 42,
    "sku": "TRB-TEE-RED-L",
    "store_id": "11111111-1111-4111-8111-111111111111",
    "title": "Red / L"
  }
}

Variant translations deleted

EVENT variants/translations/delete App scope: read_products Staff permission: products:write

Fired when a variant's translations are cleared for one or more fields in a locale.

Payload fields

Field	Type	Description
`variant.id`	`integer`	Always present
`variant.product_id`	`integer`	Always present
`variant.title`	`string`	Selectable in the Payload builder
`variant.sku`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "translation": {
    "title": "Trailblazer Tee"
  },
  "updated_at": "2026-06-09T12:00:00+05:30",
  "variant": {
    "id": 42,
    "product_id": 42,
    "sku": "TRB-TEE",
    "title": "Trailblazer Tee"
  }
}

Variant translations updated

EVENT variants/translations/update App scope: read_products Staff permission: products:write

Fired when a variant's translations are added or updated for a locale. Payload carries only the fields that changed.

Payload fields

Field	Type	Description
`variant.id`	`integer`	Always present
`variant.product_id`	`integer`	Always present
`variant.title`	`string`	Selectable in the Payload builder
`variant.sku`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.title`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "translation": {
    "title": "Trailblazer Tee"
  },
  "updated_at": "2026-06-09T12:00:00+05:30",
  "variant": {
    "id": 42,
    "product_id": 42,
    "sku": "TRB-TEE",
    "title": "Trailblazer Tee"
  }
}

Variant updated

EVENT variants/update App scope: read_products Staff permission: products:write

Fired when variant-owned fields change. Parent product fields are not repeated here. During a CSV product import no variants/update events are sent; products/update carries the complete variant list in product.variants instead.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

attribute_values barcode condition country_of_origin dimension_unit height hs_code identifier_status image_id inventory_group_id inventory_source length max_order_quantity mpn no_manufacturer_identifiers overall_low_stock_threshold prices requires_shipping shipping_prices sku sort_order tax_classes title title_is_custom weight weight_unit width

Payload fields

Field	Type	Description
`variant.id`	`integer`	Always present
`variant.product_id`	`integer`	Always present
`variant.sku`	`string`	Selectable in the Payload builder
`variant.barcode`	`string`	Selectable in the Payload builder
`variant.condition`	`string`	Selectable in the Payload builder
`variant.mpn`	`string`	Selectable in the Payload builder
`variant.no_manufacturer_identifiers`	`boolean`	Selectable in the Payload builder
`variant.identifier_status`	`string`	Selectable in the Payload builder
`variant.title`	`string`	Selectable in the Payload builder
`variant.title_is_custom`	`boolean`	Selectable in the Payload builder
`variant.attribute_values[*].attribute_id`	`integer`	Selectable in the Payload builder
`variant.attribute_values[*].attribute_name`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].attribute_slug`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].option_id`	`integer`	Selectable in the Payload builder
`variant.attribute_values[*].option_label`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].option_value`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].option_color`	`string`	Selectable in the Payload builder
`variant.attribute_values[*].sort_order`	`integer`	Selectable in the Payload builder
`variant.weight`	`number`	Selectable in the Payload builder
`variant.weight_unit`	`string`	Selectable in the Payload builder
`variant.length`	`number`	Selectable in the Payload builder
`variant.width`	`number`	Selectable in the Payload builder
`variant.height`	`number`	Selectable in the Payload builder
`variant.dimension_unit`	`string`	Selectable in the Payload builder
`variant.hs_code`	`string`	Selectable in the Payload builder
`variant.country_of_origin`	`string`	Selectable in the Payload builder
`variant.inventory_source`	`string`	Selectable in the Payload builder
`variant.inventory_group_id`	`string`	Selectable in the Payload builder
`variant.overall_low_stock_threshold`	`integer`	Selectable in the Payload builder
`variant.max_order_quantity`	`integer`	Selectable in the Payload builder
`variant.requires_shipping`	`boolean`	Selectable in the Payload builder
`variant.sort_order`	`integer`	Selectable in the Payload builder
`variant.image_id`	`integer`	Selectable in the Payload builder
`variant.created_at`	`string`	Selectable in the Payload builder
`variant.updated_at`	`string`	Selectable in the Payload builder
`variant.prices[*].currency_code`	`string`	Selectable in the Payload builder
`variant.prices[*].regular_price`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_price`	`string`	Selectable in the Payload builder
`variant.prices[*].cost_price`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_starts_at`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_starts_at_iso`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_ends_at`	`string`	Selectable in the Payload builder
`variant.prices[*].sale_ends_at_iso`	`string`	Selectable in the Payload builder
`variant.shipping_prices[*].currency_code`	`string`	Selectable in the Payload builder
`variant.shipping_prices[*].price`	`string`	Selectable in the Payload builder
`variant.tax_classes[*].market_id`	`string`	Selectable in the Payload builder
`variant.tax_classes[*].market_name`	`string`	Selectable in the Payload builder
`variant.tax_classes[*].tax_class_id`	`string`	Selectable in the Payload builder
`variant.tax_classes[*].tax_class_name`	`string`	Selectable in the Payload builder
`variant.inventory[*].location_id`	`string`	Selectable in the Payload builder
`variant.inventory[*].location_name`	`string`	Selectable in the Payload builder
`variant.inventory[*].quantity`	`integer`	Selectable in the Payload builder
`variant.inventory[*].reserved`	`integer`	Selectable in the Payload builder
`variant.inventory[*].checkout_held`	`integer`	Selectable in the Payload builder
`variant.inventory[*].order_committed`	`integer`	Selectable in the Payload builder
`variant.inventory[*].other_held`	`integer`	Selectable in the Payload builder
`variant.inventory[*].available`	`integer`	Selectable in the Payload builder
`variant.inventory[*].low_stock_threshold`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].group_id`	`string`	Selectable in the Payload builder
`variant.inventory_groups[*].group_name`	`string`	Selectable in the Payload builder
`variant.inventory_groups[*].group_sku`	`string`	Selectable in the Payload builder
`variant.inventory_groups[*].quantity`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].reserved`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].checkout_held`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].order_committed`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].other_held`	`integer`	Selectable in the Payload builder
`variant.inventory_groups[*].available`	`integer`	Selectable in the Payload builder
`variant.metafields_count`	`integer`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "prices"
  ],
  "variant": {
    "attribute_values": [
      {
        "attribute_id": 1,
        "attribute_name": "Color",
        "attribute_slug": "color",
        "option_id": 5,
        "option_label": "Red",
        "option_value": "red",
        "sort_order": 0
      },
      {
        "attribute_id": 2,
        "attribute_name": "Size",
        "attribute_slug": "size",
        "option_id": 9,
        "option_label": "M",
        "option_value": "m",
        "sort_order": 1
      }
    ],
    "condition": "new",
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": 1007,
    "identifier_status": "provided",
    "inventory": [
      {
        "available": 120,
        "checkout_held": 0,
        "location_id": "33333333-3333-4333-8333-333333333333",
        "location_name": "Main warehouse",
        "order_committed": 0,
        "other_held": 0,
        "quantity": 120,
        "reserved": 0
      }
    ],
    "inventory_source": "track",
    "metafields_count": 0,
    "mpn": "TRB-TEE-RED-M",
    "prices": [
      {
        "currency_code": "USD",
        "regular_price": "31.00"
      }
    ],
    "product_id": 42,
    "requires_shipping": true,
    "shipping_prices": [],
    "sku": "TRB-TEE-RED-M",
    "sort_order": 0,
    "store_id": "11111111-1111-4111-8111-111111111111",
    "title": "Red / M",
    "title_is_custom": false,
    "updated_at": "2026-06-10T10:00:00+05:30",
    "weight": 0.25,
    "weight_unit": "kg"
  }
}

recommendations/exclusions/update

EVENT recommendations/exclusions/update App scope: read_products Staff permission: online_store.recommendations:write

Payload fields

Field	Type	Description
`action`	`string`	Selectable in the Payload builder
`product.id`	`integer`	Always present
`product.title`	`string`	Selectable in the Payload builder
`product.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "action": "...",
  "product": {
    "id": 0,
    "slug": "...",
    "title": "..."
  }
}

recommendations/pins/update

EVENT recommendations/pins/update App scope: read_products Staff permission: online_store.recommendations:write

Payload fields

Field	Type	Description
`product_id`	`integer`	Always present
`pins[*].related_product_id`	`integer`	Selectable in the Payload builder
`pins[*].position`	`integer`	Selectable in the Payload builder
`products[*].id`	`integer`	Always present
`products[*].title`	`string`	Selectable in the Payload builder
`products[*].slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "pins": [
    {
      "position": 0,
      "related_product_id": 0
    }
  ],
  "product_id": 0,
  "products": [
    {
      "id": 0,
      "slug": "...",
      "title": "..."
    }
  ]
}

recommendations/rules/update

EVENT recommendations/rules/update App scope: read_products Staff permission: online_store.recommendations:write

Payload fields

Field	Type	Description
`rules[*].match_kind`	`string`	Selectable in the Payload builder
`rules[*].match_value`	`string`	Selectable in the Payload builder
`rules[*].sort`	`string`	Selectable in the Payload builder
`rules[*].position`	`integer`	Selectable in the Payload builder
`rules[*].include_subcategories`	`boolean`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "rules": [
    {
      "include_subcategories": false,
      "match_kind": "...",
      "match_value": null,
      "position": 0,
      "sort": "..."
    }
  ]
}

recommendations/settings/update

EVENT recommendations/settings/update App scope: read_products Staff permission: online_store.recommendations:write

Payload fields

Field	Type	Description
`settings.related_limit`	`integer`	Selectable in the Payload builder
`settings.recently_viewed_enabled`	`boolean`	Selectable in the Payload builder
`settings.recently_viewed_limit`	`integer`	Selectable in the Payload builder
`settings.history_window_days`	`integer`	Selectable in the Payload builder
`settings.hide_out_of_stock`	`boolean`	Selectable in the Payload builder
`settings.exclude_free_products`	`boolean`	Selectable in the Payload builder
`settings.cross_device_history`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "settings": {
    "cross_device_history": "...",
    "exclude_free_products": false,
    "hide_out_of_stock": false,
    "history_window_days": 0,
    "recently_viewed_enabled": false,
    "recently_viewed_limit": 0,
    "related_limit": 0
  }
}

Redirect created

EVENT redirects/create App scope: read_redirects Staff permission: online_store.redirects:write

Fired when a URL redirect is created — manually, by a slug change, or by a permalink rename.

Payload fields

Field	Type	Description
`redirect.id`	`string`	Always present
`redirect.kind`	`string`	Selectable in the Payload builder
`redirect.locale`	`string`	Selectable in the Payload builder
`redirect.path`	`string`	Selectable in the Payload builder
`redirect.target`	`string`	Selectable in the Payload builder
`redirect.redirect_type`	`integer`	Selectable in the Payload builder
`redirect.created_at`	`string`	Selectable in the Payload builder
`redirect.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "redirect": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "9a7e4a90-9ac4-4aa6-aeb8-baad66d9fc37",
    "kind": "manual",
    "locale": "fr",
    "path": "/old-summer-sale",
    "redirect_type": 301,
    "target": "/collections/summer-essentials",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Redirect deleted

EVENT redirects/delete App scope: read_redirects Staff permission: online_store.redirects:write

Fired when a URL redirect is deleted.

Payload fields

Field	Type	Description
`redirect.id`	`string`	Always present
`redirect.path`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "redirect": {
    "id": "9a7e4a90-9ac4-4aa6-aeb8-baad66d9fc37",
    "path": "/old-summer-sale"
  }
}

Redirect updated

EVENT redirects/update App scope: read_redirects Staff permission: online_store.redirects:write

Fired when a URL redirect is updated.

Payload fields

Field	Type	Description
`redirect.id`	`string`	Always present
`redirect.kind`	`string`	Selectable in the Payload builder
`redirect.locale`	`string`	Selectable in the Payload builder
`redirect.path`	`string`	Selectable in the Payload builder
`redirect.target`	`string`	Selectable in the Payload builder
`redirect.redirect_type`	`integer`	Selectable in the Payload builder
`redirect.created_at`	`string`	Selectable in the Payload builder
`redirect.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "redirect": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": "9a7e4a90-9ac4-4aa6-aeb8-baad66d9fc37",
    "kind": "manual",
    "locale": "fr",
    "path": "/old-summer-sale",
    "redirect_type": 301,
    "target": "/collections/summer-essentials",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Review settings updated

EVENT review_settings/update App scope: read_reviews Staff permission: reviews:write

Fired when product review settings change.

Payload fields

Field	Type	Description
`settings.moderation_mode`	`string`	Selectable in the Payload builder
`settings.blocked_words`	`array`	Selectable in the Payload builder
`settings.block_urls`	`boolean`	Selectable in the Payload builder
`settings.block_emails`	`boolean`	Selectable in the Payload builder
`settings.flag_low_ratings`	`boolean`	Selectable in the Payload builder
`settings.require_purchase`	`boolean`	Selectable in the Payload builder
`settings.allow_anonymous`	`boolean`	Selectable in the Payload builder
`settings.allow_images`	`boolean`	Selectable in the Payload builder
`settings.max_images`	`integer`	Selectable in the Payload builder
`settings.min_content_length`	`integer`	Selectable in the Payload builder
`settings.max_content_length`	`integer`	Selectable in the Payload builder
`settings.review_request_delay_days`	`integer`	Selectable in the Payload builder
`settings.reviewer_display`	`string`	Selectable in the Payload builder
`settings.enable_responses`	`boolean`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "settings": {
    "allow_anonymous": true,
    "allow_images": true,
    "block_emails": true,
    "block_urls": true,
    "blocked_words": [],
    "enable_responses": true,
    "flag_low_ratings": true,
    "max_content_length": 5000,
    "max_images": 5,
    "min_content_length": 10,
    "moderation_mode": "manual",
    "require_purchase": false,
    "review_request_delay_days": 3,
    "reviewer_display": "first_name"
  }
}

Review submitted

EVENT reviews/create App scope: read_reviews Staff permission: reviews:write

Fired when a shopper submits a product review. Submissions refused by the content filters are not saved and do not fire it. The review's status shows whether it was published or is waiting for approval.

Payload fields

Field	Type	Description
`review.id`	`string`	Always present
`review.product_id`	`integer`	Selectable in the Payload builder
`review.variant_id`	`integer`	Selectable in the Payload builder
`review.rating`	`integer`	Selectable in the Payload builder
`review.title`	`string`	Selectable in the Payload builder
`review.content`	`string`	Selectable in the Payload builder
`review.reviewer_name`	`string`	Selectable in the Payload builder
`review.status`	`string`	Selectable in the Payload builder
`review.moderation_reason`	`string`	Selectable in the Payload builder
`review.verified_purchase`	`boolean`	Selectable in the Payload builder
`review.helpful_count`	`integer`	Selectable in the Payload builder
`review.unhelpful_count`	`integer`	Selectable in the Payload builder
`review.store_response`	`string`	Selectable in the Payload builder
`review.images[*].id`	`string`	Always present
`review.images[*].url`	`string`	Selectable in the Payload builder
`review.images[*].width`	`integer`	Selectable in the Payload builder
`review.images[*].height`	`integer`	Selectable in the Payload builder
`review.images[*].sort_order`	`integer`	Selectable in the Payload builder
`review.created_at`	`string`	Selectable in the Payload builder
`review.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "review": {
    "content": "The shirt fits well and arrived as described.",
    "created_at": "2026-06-09T12:00:00+05:30",
    "helpful_count": 2,
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "images": [],
    "moderation_reason": null,
    "product_id": 42,
    "rating": 4,
    "reviewer_name": "Avery",
    "status": "approved",
    "store_response": null,
    "title": "Comfortable fit",
    "unhelpful_count": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variant_id": null,
    "verified_purchase": true
  }
}

Review deleted

EVENT reviews/delete App scope: read_reviews Staff permission: reviews:write

Fired when a product review is deleted.

Payload fields

Field	Type	Description
`review.id`	`string`	Always present
`review.product_id`	`integer`	Selectable in the Payload builder
`review.rating`	`integer`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "review": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "product_id": 42,
    "rating": 4
  }
}

Review updated

EVENT reviews/update App scope: read_reviews Staff permission: reviews:write

Fired when review moderation or the store response changes.

Payload fields

Field	Type	Description
`review.id`	`string`	Always present
`review.product_id`	`integer`	Selectable in the Payload builder
`review.variant_id`	`integer`	Selectable in the Payload builder
`review.rating`	`integer`	Selectable in the Payload builder
`review.title`	`string`	Selectable in the Payload builder
`review.content`	`string`	Selectable in the Payload builder
`review.reviewer_name`	`string`	Selectable in the Payload builder
`review.status`	`string`	Selectable in the Payload builder
`review.moderation_reason`	`string`	Selectable in the Payload builder
`review.verified_purchase`	`boolean`	Selectable in the Payload builder
`review.helpful_count`	`integer`	Selectable in the Payload builder
`review.unhelpful_count`	`integer`	Selectable in the Payload builder
`review.store_response`	`string`	Selectable in the Payload builder
`review.images[*].id`	`string`	Always present
`review.images[*].url`	`string`	Selectable in the Payload builder
`review.images[*].width`	`integer`	Selectable in the Payload builder
`review.images[*].height`	`integer`	Selectable in the Payload builder
`review.images[*].sort_order`	`integer`	Selectable in the Payload builder
`review.created_at`	`string`	Selectable in the Payload builder
`review.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "status",
    "moderation_reason"
  ],
  "review": {
    "content": "The shirt fits well and arrived as described.",
    "created_at": "2026-06-09T12:00:00+05:30",
    "helpful_count": 2,
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "images": [],
    "moderation_reason": null,
    "product_id": 42,
    "rating": 4,
    "reviewer_name": "Avery",
    "status": "approved",
    "store_response": null,
    "title": "Comfortable fit",
    "unhelpful_count": 0,
    "updated_at": "2026-06-09T12:00:00+05:30",
    "variant_id": null,
    "verified_purchase": true
  }
}

Search synonym group created

EVENT search_synonyms/create App scope: read_search Staff permission: online_store.search:write

Fired after a search synonym group is created. The search_synonym object describes the saved group. Its created_at and updated_at values, like every webhook timestamp, are in the store's time zone with its offset (RFC 3339).

Payload fields

Field	Type	Description
`search_synonym.id`	`string`	Always present Stable UUID of the created, updated, or deleted group. Always included, even when other fields are excluded from the subscription payload.
`search_synonym.locale`	`string`	Selectable in the Payload builder The group's store language code. For a locale change, the update contains the new code.
`search_synonym.terms`	`array`	Selectable in the Payload builder Array of 2–25 strings: the complete saved term set, with trimmed text, original case, and saved order. The delete event carries the terms from the deleted group's snapshot.
`search_synonym.created_at`	`string`	Selectable in the Payload builder When the group was created, in the store's time zone with its offset (RFC 3339).
`search_synonym.updated_at`	`string`	Selectable in the Payload builder When the group last changed, in the store's time zone with its offset (RFC 3339). On delete this is the group's recorded update time, not the deletion time.

Payload shape

Sample payload

{
  "search_synonym": {
    "created_at": "2026-08-03T14:30:00+05:30",
    "id": "3e41dbac-a931-4c43-9ff0-d430fa7b79c1",
    "locale": "en",
    "terms": [
      "tee",
      "t-shirt"
    ],
    "updated_at": "2026-08-03T14:30:00+05:30"
  }
}

Search synonym group deleted

EVENT search_synonyms/delete App scope: read_search Staff permission: online_store.search:write

Fired after an individual search synonym group is deleted. The search_synonym object is the group snapshot loaded for deletion. Its created_at and updated_at values describe that group; updated_at is not the deletion time. Removing a store language also removes its groups, without a separate search_synonyms/delete event for each group. Integrations mirroring groups should also handle store/locales/deleted.

Payload fields

Field	Type	Description
`search_synonym.id`	`string`	Always present Stable UUID of the created, updated, or deleted group. Always included, even when other fields are excluded from the subscription payload.
`search_synonym.locale`	`string`	Selectable in the Payload builder The group's store language code. For a locale change, the update contains the new code.
`search_synonym.terms`	`array`	Selectable in the Payload builder Array of 2–25 strings: the complete saved term set, with trimmed text, original case, and saved order. The delete event carries the terms from the deleted group's snapshot.
`search_synonym.created_at`	`string`	Selectable in the Payload builder When the group was created, in the store's time zone with its offset (RFC 3339).
`search_synonym.updated_at`	`string`	Selectable in the Payload builder When the group last changed, in the store's time zone with its offset (RFC 3339). On delete this is the group's recorded update time, not the deletion time.

Payload shape

Sample payload

{
  "search_synonym": {
    "created_at": "2026-08-03T14:30:00+05:30",
    "id": "3e41dbac-a931-4c43-9ff0-d430fa7b79c1",
    "locale": "en",
    "terms": [
      "tee",
      "t-shirt"
    ],
    "updated_at": "2026-08-03T14:35:00+05:30"
  }
}

Search synonym group updated

EVENT search_synonyms/update App scope: read_search Staff permission: online_store.search:write

Fired after a successful group update, including a PUT that leaves the language and terms unchanged. The search_synonym object contains the resulting group, not a before/after diff. Its timestamps are in the store's time zone with its offset (RFC 3339); updated_at is the group update time.

Payload fields

Field	Type	Description
`search_synonym.id`	`string`	Always present Stable UUID of the created, updated, or deleted group. Always included, even when other fields are excluded from the subscription payload.
`search_synonym.locale`	`string`	Selectable in the Payload builder The group's store language code. For a locale change, the update contains the new code.
`search_synonym.terms`	`array`	Selectable in the Payload builder Array of 2–25 strings: the complete saved term set, with trimmed text, original case, and saved order. The delete event carries the terms from the deleted group's snapshot.
`search_synonym.created_at`	`string`	Selectable in the Payload builder When the group was created, in the store's time zone with its offset (RFC 3339).
`search_synonym.updated_at`	`string`	Selectable in the Payload builder When the group last changed, in the store's time zone with its offset (RFC 3339). On delete this is the group's recorded update time, not the deletion time.

Payload shape

Sample payload

{
  "search_synonym": {
    "created_at": "2026-08-03T14:30:00+05:30",
    "id": "3e41dbac-a931-4c43-9ff0-d430fa7b79c1",
    "locale": "en",
    "terms": [
      "tee",
      "t-shirt"
    ],
    "updated_at": "2026-08-03T14:35:00+05:30"
  }
}

Site asset created

EVENT site_assets/create App scope: read_site_assets Staff permission: online_store.site_assets:read

Payload fields

Field	Type	Description
`file.id`	`string`	Always present The stable file id.
`file.type`	`string`	Always present The file namespace: upload or site_asset.
`file.media_type`	`string`	Always present The detected media class: image, video, document, or 3d.
`file.filename`	`string`	Always present The file name assigned when the file was created; use original_filename for its editable display name.
`file.original_filename`	`string`	Always present The merchant-facing filename.
`file.size_bytes`	`integer`	Always present The validated source size in bytes.
`file.mime_type`	`string`	Always present The MIME type detected from the source bytes.
`file.width`	`integer`	Selectable in the Payload builder The source width in pixels when applicable.
`file.height`	`integer`	Selectable in the Payload builder The source height in pixels when applicable.
`file.alt_text`	`string`	Selectable in the Payload builder The file's accessibility description.
`file.revision`	`integer`	Always present The current source revision.
`file.preview_status`	`string`	Always present Preview lifecycle state: none, pending, ready, or failed.
`file.preview_error_code`	`string`	Selectable in the Payload builder `STORAGE_PREVIEW_FAILED` when preview_status is failed; absent otherwise.
`file.preview_revision`	`integer`	Always present The source revision represented by the current preview; zero means no preview.
`file.preview_requested_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when preview work was most recently requested.
`file.preview_completed_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when the current preview became ready.
`file.created_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when the file became ready.
`file.updated_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when file metadata or preview state last changed.

Payload shape

Sample payload

{
  "file": {
    "alt_text": "Trail shoe in black",
    "created_at": "2026-06-09T12:00:00+05:30",
    "filename": "8f2a1c2b-9d4e-4a56-b789-0123456789ab.glb",
    "height": null,
    "id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "media_type": "3d",
    "mime_type": "model/gltf-binary",
    "original_filename": "trail-shoe.glb",
    "preview_completed_at": null,
    "preview_error_code": null,
    "preview_requested_at": null,
    "preview_revision": 0,
    "preview_status": "none",
    "revision": 1,
    "size_bytes": 8421934,
    "type": "site_asset",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "width": null
  }
}

Site asset deleted

EVENT site_assets/delete App scope: read_site_assets Staff permission: online_store.site_assets:read

Payload fields

Field	Type	Description
`file.id`	`string`	Always present The stable file id.
`file.type`	`string`	Always present The file namespace: upload or site_asset.
`file.media_type`	`string`	Always present The detected media class: image, video, document, or 3d.
`file.filename`	`string`	Always present The file name assigned when the file was created; use original_filename for its editable display name.
`file.original_filename`	`string`	Always present The merchant-facing filename.
`file.size_bytes`	`integer`	Always present The validated source size in bytes.
`file.mime_type`	`string`	Always present The MIME type detected from the source bytes.
`file.width`	`integer`	Selectable in the Payload builder The source width in pixels when applicable.
`file.height`	`integer`	Selectable in the Payload builder The source height in pixels when applicable.
`file.alt_text`	`string`	Selectable in the Payload builder The file's accessibility description.
`file.revision`	`integer`	Always present The current source revision.
`file.preview_status`	`string`	Always present Preview lifecycle state: none, pending, ready, or failed.
`file.preview_error_code`	`string`	Selectable in the Payload builder `STORAGE_PREVIEW_FAILED` when preview_status is failed; absent otherwise.
`file.preview_revision`	`integer`	Always present The source revision represented by the current preview; zero means no preview.
`file.preview_requested_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when preview work was most recently requested.
`file.preview_completed_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when the current preview became ready.
`file.created_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when the file became ready.
`file.updated_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when file metadata or preview state last changed.
`deleted_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when the file was deleted.

Payload shape

Sample payload

{
  "deleted_at": "2026-06-10T09:30:00+05:30",
  "file": {
    "alt_text": "Trail shoe in black",
    "created_at": "2026-06-09T12:00:00+05:30",
    "filename": "8f2a1c2b-9d4e-4a56-b789-0123456789ab.glb",
    "height": null,
    "id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "media_type": "3d",
    "mime_type": "model/gltf-binary",
    "original_filename": "trail-shoe.glb",
    "preview_completed_at": "2026-06-09T12:01:10+05:30",
    "preview_error_code": null,
    "preview_requested_at": "2026-06-09T12:00:02+05:30",
    "preview_revision": 1,
    "preview_status": "ready",
    "revision": 1,
    "size_bytes": 8421934,
    "type": "site_asset",
    "updated_at": "2026-06-09T12:01:10+05:30",
    "width": null
  }
}

Site asset updated

EVENT site_assets/update App scope: read_site_assets Staff permission: online_store.site_assets:read

Payload fields

Field	Type	Description
`file.id`	`string`	Always present The stable file id.
`file.type`	`string`	Always present The file namespace: upload or site_asset.
`file.media_type`	`string`	Always present The detected media class: image, video, document, or 3d.
`file.filename`	`string`	Always present The file name assigned when the file was created; use original_filename for its editable display name.
`file.original_filename`	`string`	Always present The merchant-facing filename.
`file.size_bytes`	`integer`	Always present The validated source size in bytes.
`file.mime_type`	`string`	Always present The MIME type detected from the source bytes.
`file.width`	`integer`	Selectable in the Payload builder The source width in pixels when applicable.
`file.height`	`integer`	Selectable in the Payload builder The source height in pixels when applicable.
`file.alt_text`	`string`	Selectable in the Payload builder The file's accessibility description.
`file.revision`	`integer`	Always present The current source revision.
`file.preview_status`	`string`	Always present Preview lifecycle state: none, pending, ready, or failed.
`file.preview_error_code`	`string`	Selectable in the Payload builder `STORAGE_PREVIEW_FAILED` when preview_status is failed; absent otherwise.
`file.preview_revision`	`integer`	Always present The source revision represented by the current preview; zero means no preview.
`file.preview_requested_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when preview work was most recently requested.
`file.preview_completed_at`	`string`	Selectable in the Payload builder Time in the store's time zone, with its offset (RFC 3339), when the current preview became ready.
`file.created_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when the file became ready.
`file.updated_at`	`string`	Always present Time in the store's time zone, with its offset (RFC 3339), when file metadata or preview state last changed.
`changed_fields`	`array`	Always present The file fields changed by this event.

Payload shape

Sample payload

{
  "changed_fields": [
    "preview_status",
    "preview_revision",
    "preview_completed_at"
  ],
  "file": {
    "alt_text": "Trail shoe in black",
    "created_at": "2026-06-09T12:00:00+05:30",
    "filename": "8f2a1c2b-9d4e-4a56-b789-0123456789ab.glb",
    "height": null,
    "id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "media_type": "3d",
    "mime_type": "model/gltf-binary",
    "original_filename": "trail-shoe.glb",
    "preview_completed_at": "2026-06-09T12:01:10+05:30",
    "preview_error_code": null,
    "preview_requested_at": "2026-06-09T12:00:02+05:30",
    "preview_revision": 1,
    "preview_status": "ready",
    "revision": 1,
    "size_bytes": 8421934,
    "type": "site_asset",
    "updated_at": "2026-06-09T12:01:10+05:30",
    "width": null
  }
}

Store language removed

EVENT store/locales/deleted App scope: read_translations Staff permission: settings.languages:read

Fired when a language is removed from the store; its stored translations and localized storefront data are removed. Subscribers should discard their complete mirror for that language.

Payload fields

Field	Type	Description
`locale`	`string`	Always present The canonical locale code removed from the store's enabled language set, for example pt-BR.
`deleted_at`	`string`	Always present When the language and its stored localized data were removed, in the store's time zone with its offset (RFC 3339).

Payload shape

Sample payload

{
  "deleted_at": "2026-07-08T18:40:00+05:30",
  "locale": "fr"
}

Store languages updated

EVENT store/locales/update App scope: read_translations Staff permission: settings.languages:read

Fired when the store's enabled or default language changes. The payload carries the complete enabled set and default language.

Payload fields

Field	Type	Description
`locales`	`array`	Always present The complete enabled language set after the change, as BCP 47 locale codes.
`default_locale`	`string`	Always present The locale code of the store's default source language after the change.
`updated_at`	`string`	Always present When the language settings changed, in the store's time zone with its offset (RFC 3339).

Payload shape

Sample payload

{
  "default_locale": "en",
  "locales": [
    "en",
    "fr",
    "hi"
  ],
  "updated_at": "2026-07-08T18:40:00+05:30"
}

Store translations deleted

EVENT store/translations/deleted App scope: read_translations Staff permission: settings.languages:read

Fired when stored translations, translated storefront messages, localized search documents, or active translation work for one enabled language are permanently removed without disabling the language. A reset that changes nothing does not fire this event.

Payload fields

Field	Type	Description
`locale`	`string`	Always present The canonical locale code of the enabled language whose stored translations were removed, for example pt-BR.
`deleted_at`	`string`	Always present When the stored translations became unavailable, in the store's time zone with its offset (RFC 3339).

Payload shape

Sample payload

{
  "deleted_at": "2026-07-08T18:40:00+05:30",
  "locale": "fr"
}

Store metafield value created

EVENT store_metafields/create App scope: read_storefront Staff permission: settings.metafield_definitions:write

Fired when a store metafield value is created.

Payload fields

Field	Type	Description
`store.name`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "...",
      "owner_type": "store",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "store": {
    "name": "..."
  }
}

Store metafield value deleted

EVENT store_metafields/delete App scope: read_storefront Staff permission: settings.metafield_definitions:write

Fired when a store metafield value is deleted.

Payload fields

Field	Type	Description
`store.name`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "...",
      "owner_type": "store",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "store": {
    "name": "..."
  }
}

Store metafield translations deleted

EVENT store_metafields/translations/delete App scope: read_storefront Staff permission: settings.metafield_definitions:write

Fired when a store metafield's translation is cleared for a locale.

Payload fields

Field	Type	Description
`metafield.store_name`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "definition_id": "...",
    "key": "...",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "...",
    "store_name": "...",
    "type": "string"
  },
  "translation": {
    "value": null
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Store metafield translations updated

EVENT store_metafields/translations/update App scope: read_storefront Staff permission: settings.metafield_definitions:write

Fired when a store metafield's translation is added or updated for a locale.

Payload fields

Field	Type	Description
`metafield.store_name`	`string`	Selectable in the Payload builder
`metafield.definition_id`	`string`	Always present
`metafield.namespace`	`string`	Selectable in the Payload builder
`metafield.key`	`string`	Selectable in the Payload builder
`metafield.name`	`string`	Selectable in the Payload builder
`metafield.type`	`string`	Selectable in the Payload builder
`metafield.app_id`	`string`	Selectable in the Payload builder
`metafield.app_access`	`string`	Selectable in the Payload builder
`metafield.merchant_access`	`string`	Selectable in the Payload builder
`locale`	`string`	Selectable in the Payload builder
`translation.value`	`string`	Selectable in the Payload builder
`updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": null,
    "definition_id": "...",
    "key": "...",
    "merchant_access": "read_write",
    "name": "...",
    "namespace": "...",
    "store_name": "...",
    "type": "string"
  },
  "translation": {
    "value": null
  },
  "updated_at": "2026-06-09T12:00:00+05:30"
}

Store metafield value updated

EVENT store_metafields/update App scope: read_storefront Staff permission: settings.metafield_definitions:write

Fired when a store metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`store.name`	`string`	Selectable in the Payload builder
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "...",
      "owner_type": "store",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": null,
      "id": "...",
      "is_translatable": false,
      "key": "...",
      "max_list_items": null,
      "max_value_length": null,
      "merchant_access": "read_write",
      "name": "...",
      "namespace": "...",
      "owner_type": "store",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 0
    },
    "display_value": null,
    "display_value_map": "...",
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "..."
  },
  "store": {
    "name": "..."
  }
}

storefront_messages/update

EVENT storefront_messages/update App scope: read_translations Staff permission: online_store.storefront_messages:write

Payload fields

Field	Type	Description
`action`	`string`	Selectable in the Payload builder
`message.code`	`string`	Always present
`message.locale`	`string`	Selectable in the Payload builder
`message.namespace`	`string`	Selectable in the Payload builder
`message.default_message`	`string`	Selectable in the Payload builder
`message.override_message`	`string`	Selectable in the Payload builder
`message.effective_message`	`string`	Selectable in the Payload builder
`message.placeholders`	`array`	Selectable in the Payload builder
`message.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "action": "...",
  "message": {
    "code": "...",
    "default_message": "...",
    "effective_message": "...",
    "locale": "fr",
    "namespace": "...",
    "override_message": null,
    "placeholders": [],
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Storefront languages updated

EVENT storefront/locales/update App scope: read_storefront Staff permission: online_store.preferences:read

Fired when the languages a storefront serves change, or the languages a country is served in. The payload carries the storefront's complete language set and every country's language choice.

Payload fields

Field	Type	Description
`storefront_id`	`string`	Always present The storefront whose languages changed.
`locales`	`array`	Always present Every language the storefront serves after the change, as BCP 47 locale codes.
`default_locale`	`string`	Always present The storefront's default language, served where a country has no language choice of its own.
`countries[*].country_code`	`string`	Always present
`countries[*].locales`	`array`	Always present
`countries[*].default_locale`	`string`	Always present
`updated_at`	`string`	Always present When the languages changed, in the store's time zone with its offset (RFC 3339).

Payload shape

Sample payload

{
  "countries": [
    {
      "country_code": "...",
      "default_locale": "en",
      "locales": [
        "en",
        "de",
        "fr"
      ]
    }
  ],
  "default_locale": "en",
  "locales": [
    "en",
    "de",
    "fr"
  ],
  "storefront_id": "c2ee5620-e43e-405b-899a-b90c212ce9e8",
  "updated_at": "2026-10-06T18:40:00+05:30"
}

Online Store preferences updated

EVENT storefront_preferences/update App scope: read_storefront Staff permission: online_store.preferences:write

Fired when the store-wide favicon or permalink structure changes.

Payload fields

Field	Type	Description
`preferences.favicon_file_id`	`string`	Selectable in the Payload builder
`preferences.permalinks.product`	`string`	Selectable in the Payload builder
`preferences.permalinks.shop`	`string`	Selectable in the Payload builder
`preferences.permalinks.category`	`string`	Selectable in the Payload builder
`preferences.permalinks.category_list`	`string`	Selectable in the Payload builder
`preferences.permalinks.collection`	`string`	Selectable in the Payload builder
`preferences.permalinks.collection_list`	`string`	Selectable in the Payload builder
`preferences.permalinks.vendor`	`string`	Selectable in the Payload builder
`preferences.permalinks.vendor_list`	`string`	Selectable in the Payload builder
`preferences.permalinks.brand`	`string`	Selectable in the Payload builder
`preferences.permalinks.brand_list`	`string`	Selectable in the Payload builder
`preferences.permalinks.blog`	`string`	Selectable in the Payload builder
`preferences.permalinks.blog_list`	`string`	Selectable in the Payload builder
`preferences.permalinks.blog_category`	`string`	Selectable in the Payload builder
`preferences.permalinks.page`	`string`	Selectable in the Payload builder
`preferences.permalinks.policy`	`string`	Selectable in the Payload builder
`preferences.permalinks.search`	`string`	Selectable in the Payload builder
`preferences.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [
    "title",
    "status"
  ],
  "preferences": {
    "favicon_file_id": null,
    "permalinks": {
      "blog": "...",
      "blog_category": "...",
      "blog_list": "...",
      "brand": "...",
      "brand_list": "...",
      "category": "...",
      "category_list": "...",
      "collection": "...",
      "collection_list": "...",
      "page": "...",
      "policy": "...",
      "product": "...",
      "search": "...",
      "shop": "...",
      "vendor": "...",
      "vendor_list": "..."
    },
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Storefront created

EVENT storefronts/create App scope: read_storefront Staff permission: online_store.preferences:write

Fired when a storefront is created.

Payload fields

Field	Type	Description
`storefront.id`	`string`	Always present
`storefront.name`	`string`	Selectable in the Payload builder
`storefront.type`	`string`	Selectable in the Payload builder
`storefront.is_primary`	`boolean`	Selectable in the Payload builder
`storefront.mode`	`string`	Selectable in the Payload builder
`storefront.password_protected`	`boolean`	Selectable in the Payload builder
`storefront.created_at`	`string`	Selectable in the Payload builder
`storefront.updated_at`	`string`	Selectable in the Payload builder
`storefront.markets[*].market_id`	`string`	Selectable in the Payload builder
`storefront.markets[*].market_name`	`string`	Selectable in the Payload builder
`storefront.domains[*].domain_id`	`string`	Selectable in the Payload builder
`storefront.domains[*].domain`	`string`	Selectable in the Payload builder
`storefront.domains[*].is_primary`	`boolean`	Selectable in the Payload builder
`storefront.domains[*].status`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "storefront": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "domains": [
      {
        "domain": "...",
        "domain_id": "...",
        "is_primary": false,
        "status": "..."
      }
    ],
    "id": "...",
    "is_primary": false,
    "markets": [
      {
        "market_id": "...",
        "market_name": "..."
      }
    ],
    "mode": "...",
    "name": "...",
    "password_protected": false,
    "type": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Storefront deleted

EVENT storefronts/delete App scope: read_storefront Staff permission: online_store.preferences:write

Fired when a storefront is deleted. Its domains are reassigned to the primary storefront.

Payload fields

Field	Type	Description
`storefront.id`	`string`	Always present
`storefront.name`	`string`	Selectable in the Payload builder
`storefront.type`	`string`	Selectable in the Payload builder
`storefront.is_primary`	`boolean`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "storefront": {
    "id": "...",
    "is_primary": false,
    "name": "...",
    "type": "..."
  }
}

Storefront updated

EVENT storefronts/update App scope: read_storefront Staff permission: online_store.preferences:write

Fired when storefront configuration changes, including catalog assignment, market assignment, domain assignment, primary-domain changes, domain locale or country pins, mode, password protection, maintenance settings, or coming-soon settings.

Payload fields

Field	Type	Description
`storefront.id`	`string`	Always present
`storefront.name`	`string`	Selectable in the Payload builder
`storefront.type`	`string`	Selectable in the Payload builder
`storefront.is_primary`	`boolean`	Selectable in the Payload builder
`storefront.mode`	`string`	Selectable in the Payload builder
`storefront.password_protected`	`boolean`	Selectable in the Payload builder
`storefront.created_at`	`string`	Selectable in the Payload builder
`storefront.updated_at`	`string`	Selectable in the Payload builder
`storefront.markets[*].market_id`	`string`	Selectable in the Payload builder
`storefront.markets[*].market_name`	`string`	Selectable in the Payload builder
`storefront.domains[*].domain_id`	`string`	Selectable in the Payload builder
`storefront.domains[*].domain`	`string`	Selectable in the Payload builder
`storefront.domains[*].is_primary`	`boolean`	Selectable in the Payload builder
`storefront.domains[*].status`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "storefront": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "domains": [
      {
        "domain": "...",
        "domain_id": "...",
        "is_primary": false,
        "status": "..."
      }
    ],
    "id": "...",
    "is_primary": false,
    "markets": [
      {
        "market_id": "...",
        "market_name": "..."
      }
    ],
    "mode": "...",
    "name": "...",
    "password_protected": false,
    "type": "...",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Tag created

EVENT tags/create App scope: read_products Staff permission: products:write

Fired when a product tag is created.

Payload fields

Field	Type	Description
`tag.id`	`integer`	Always present The stable product tag ID.
`tag.name`	`string`	Selectable in the Payload builder The merchant-facing tag name.
`tag.slug`	`string`	Selectable in the Payload builder The tag's URL-safe identifier.
`tag.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the tag.
`tag.created_at`	`string`	Selectable in the Payload builder When the tag was created.
`tag.updated_at`	`string`	Selectable in the Payload builder When the tag's name or slug last changed.
`tag.translations_updated_at`	`string`	Selectable in the Payload builder When any translation for the tag last changed, or null when none exist.

Payload shape

Sample payload

{
  "tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": 7,
    "name": "Summer Sale",
    "product_count": 0,
    "slug": "summer-sale",
    "translations_updated_at": null,
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Tag deleted

EVENT tags/delete App scope: read_products Staff permission: products:write

Fired after a product tag is deleted. If the tag had translations, one tags/translations/delete event is created for each translated locale before this event. The tag deletion and all related events are committed atomically.

Payload fields

Field	Type	Description
`tag.id`	`integer`	Always present The stable product tag ID.
`tag.name`	`string`	Selectable in the Payload builder The merchant-facing tag name.
`tag.slug`	`string`	Selectable in the Payload builder The tag's URL-safe identifier.

Payload shape

Sample payload

{
  "tag": {
    "id": 7,
    "name": "Summer Sale",
    "slug": "summer-sale"
  }
}

Tag translations deleted

EVENT tags/translations/delete App scope: read_products Staff permission: products:write

Fired when a tag's translations are cleared for one or more fields in a locale, including when the tag itself is deleted. A mixed write that updates some translated fields and clears others fires both translation events. Translation writes do not fire tags/update.

Payload fields

Field	Type	Description
`tag.id`	`integer`	Always present The stable product tag ID.
`tag.name`	`string`	Selectable in the Payload builder The merchant-facing tag name.
`tag.slug`	`string`	Selectable in the Payload builder The tag's URL-safe identifier.
`tag.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the tag.
`tag.created_at`	`string`	Selectable in the Payload builder When the tag was created.
`tag.updated_at`	`string`	Selectable in the Payload builder When the tag's name or slug last changed.
`tag.translations_updated_at`	`string`	Selectable in the Payload builder When any translation for the tag last changed, or null when none exist.
`locale`	`string`	Selectable in the Payload builder The locale whose tag translation changed.
`translation.name`	`string`	Selectable in the Payload builder An empty string marks a cleared name translation.
`updated_at`	`string`	Selectable in the Payload builder When this locale's tag translation changed.

Payload shape

Sample payload

{
  "locale": "fr",
  "tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": 7,
    "name": "Summer Sale",
    "product_count": 12,
    "slug": "summer-sale",
    "translations_updated_at": "2026-06-10T09:30:00+05:30",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "translation": {
    "name": ""
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Tag translations updated

EVENT tags/translations/update App scope: read_products Staff permission: products:write

Fired when a tag's translations are added or updated for a locale. The payload contains only the fields that changed. A mixed write that updates some translated fields and clears others fires both translation events. Translation writes do not fire tags/update.

Payload fields

Field	Type	Description
`tag.id`	`integer`	Always present The stable product tag ID.
`tag.name`	`string`	Selectable in the Payload builder The merchant-facing tag name.
`tag.slug`	`string`	Selectable in the Payload builder The tag's URL-safe identifier.
`tag.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the tag.
`tag.created_at`	`string`	Selectable in the Payload builder When the tag was created.
`tag.updated_at`	`string`	Selectable in the Payload builder When the tag's name or slug last changed.
`tag.translations_updated_at`	`string`	Selectable in the Payload builder When any translation for the tag last changed, or null when none exist.
`locale`	`string`	Selectable in the Payload builder The locale whose tag translation changed.
`translation.name`	`string`	Selectable in the Payload builder The updated translated tag name, when present.
`updated_at`	`string`	Selectable in the Payload builder When this locale's tag translation changed.

Payload shape

Sample payload

{
  "locale": "fr",
  "tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": 7,
    "name": "Summer Sale",
    "product_count": 12,
    "slug": "summer-sale",
    "translations_updated_at": "2026-06-10T09:30:00+05:30",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "translation": {
    "name": "Soldes d’été"
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Tag updated

EVENT tags/update App scope: read_products Staff permission: products:write

Fired when a product tag changes, including when product assignments change its product count. During a CSV product import, assignments changes are sent once per import chunk for each tag whose products changed, carrying the counts after the chunk.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

name product_count slug

Payload fields

Field	Type	Description
`tag.id`	`integer`	Always present The stable product tag ID.
`tag.name`	`string`	Selectable in the Payload builder The merchant-facing tag name.
`tag.slug`	`string`	Selectable in the Payload builder The tag's URL-safe identifier.
`tag.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the tag.
`tag.created_at`	`string`	Selectable in the Payload builder When the tag was created.
`tag.updated_at`	`string`	Selectable in the Payload builder When the tag's name or slug last changed.
`tag.translations_updated_at`	`string`	Selectable in the Payload builder When any translation for the tag last changed, or null when none exist.
`previous.id`	`integer`	Always present The stable product tag ID. This value is from before the update.
`previous.name`	`string`	Selectable in the Payload builder The merchant-facing tag name. This value is from before the update.
`previous.slug`	`string`	Selectable in the Payload builder The tag's URL-safe identifier. This value is from before the update.
`previous.product_count`	`integer`	Selectable in the Payload builder The number of products currently assigned to the tag. This value is from before the update.
`previous.created_at`	`string`	Selectable in the Payload builder When the tag was created. This value is from before the update.
`previous.updated_at`	`string`	Selectable in the Payload builder When the tag's name or slug last changed. This value is from before the update.
`previous.translations_updated_at`	`string`	Selectable in the Payload builder When any translation for the tag last changed, or null when none exist. This value is from before the update.
`changed_fields`	`array`	Always present The tag fields changed by this event: name and slug for source changes, product_count for assignment changes.
`change_type`	`string`	Always present Why tags/update fired: source for name/slug changes or assignments for product assignment count changes.

Payload shape

Sample payload

{
  "change_type": "assignments",
  "changed_fields": [
    "product_count"
  ],
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": 7,
    "name": "Summer Sale",
    "product_count": 12,
    "slug": "summer-sale",
    "translations_updated_at": "2026-06-09T12:00:00+05:30",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "tag": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "id": 7,
    "name": "Summer Sale",
    "product_count": 12,
    "slug": "summer-sale",
    "translations_updated_at": "2026-06-09T12:00:00+05:30",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Vendor metafield value created

EVENT vendor_metafields/create App scope: read_products Staff permission: products:write

Fired after a vendor metafield value is created. The payload contains the vendor identity, definition, and stored value.

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present The stable vendor id.
`vendor.name`	`string`	Selectable in the Payload builder The vendor name at the time the event was created.
`vendor.slug`	`string`	Selectable in the Payload builder The vendor slug at the time the event was created.
`metafield.definition.id`	`string`	Selectable in the Payload builder The stable metafield definition UUID.
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder The resource type that can hold this definition; vendor for these events.
`metafield.definition.namespace`	`string`	Selectable in the Payload builder The definition namespace.
`metafield.definition.key`	`string`	Selectable in the Payload builder The definition key within its namespace.
`metafield.definition.name`	`string`	Selectable in the Payload builder The merchant-facing definition name.
`metafield.definition.description`	`string`	Selectable in the Payload builder The optional merchant-facing definition description.
`metafield.definition.type`	`string`	Selectable in the Payload builder The metafield value type.
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder Whether the stored value can have locale-specific translations.
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder The maximum stored string length, or null when this limit does not apply.
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder The maximum number of list items, or null when this limit does not apply.
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder The definition's display order.
`metafield.definition.app_id`	`string`	Selectable in the Payload builder The owning app id, or null for a merchant-owned definition.
`metafield.definition.app_access`	`string`	Selectable in the Payload builder Whether another authorized app may read the definition: private or shared.
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder How Store Admin can access an app-owned definition: hidden, read, or read_write.
`metafield.definition.created_at`	`string`	Selectable in the Payload builder When the definition was created.
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder When the definition last changed.
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder The number of vendor values currently stored for this definition.
`metafield.value`	`string`	Selectable in the Payload builder The stored metafield value.
`metafield.created_at`	`string`	Selectable in the Payload builder When this vendor's value was created.
`metafield.updated_at`	`string`	Selectable in the Payload builder When this vendor's value last changed.

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "The supplier's origin city.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": false,
      "key": "origin_city",
      "max_list_items": null,
      "max_value_length": 100,
      "merchant_access": "read_write",
      "name": "Origin city",
      "namespace": "app:supplier-sync.details",
      "owner_type": "vendor",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Seoul"
  },
  "vendor": {
    "id": 7,
    "name": "Acme Supplies",
    "slug": "acme-supplies"
  }
}

Vendor metafield value deleted

EVENT vendor_metafields/delete App scope: read_products Staff permission: products:write

Fired when a vendor metafield value is deleted, including as part of vendor deletion. Removed translations have separate delete events.

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present The stable vendor id.
`vendor.name`	`string`	Selectable in the Payload builder The vendor name at the time the event was created.
`vendor.slug`	`string`	Selectable in the Payload builder The vendor slug at the time the event was created.
`metafield.definition.id`	`string`	Selectable in the Payload builder The stable metafield definition UUID.
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder The resource type that can hold this definition; vendor for these events.
`metafield.definition.namespace`	`string`	Selectable in the Payload builder The definition namespace.
`metafield.definition.key`	`string`	Selectable in the Payload builder The definition key within its namespace.
`metafield.definition.name`	`string`	Selectable in the Payload builder The merchant-facing definition name.
`metafield.definition.description`	`string`	Selectable in the Payload builder The optional merchant-facing definition description.
`metafield.definition.type`	`string`	Selectable in the Payload builder The metafield value type.
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder Whether the stored value can have locale-specific translations.
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder The maximum stored string length, or null when this limit does not apply.
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder The maximum number of list items, or null when this limit does not apply.
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder The definition's display order.
`metafield.definition.app_id`	`string`	Selectable in the Payload builder The owning app id, or null for a merchant-owned definition.
`metafield.definition.app_access`	`string`	Selectable in the Payload builder Whether another authorized app may read the definition: private or shared.
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder How Store Admin can access an app-owned definition: hidden, read, or read_write.
`metafield.definition.created_at`	`string`	Selectable in the Payload builder When the definition was created.
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder When the definition last changed.
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder The number of vendor values currently stored for this definition.
`metafield.value`	`string`	Selectable in the Payload builder The stored metafield value.
`metafield.created_at`	`string`	Selectable in the Payload builder When this vendor's value was created.
`metafield.updated_at`	`string`	Selectable in the Payload builder When this vendor's value last changed.

Payload shape

Sample payload

{
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "The supplier's origin city.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": false,
      "key": "origin_city",
      "max_list_items": null,
      "max_value_length": 100,
      "merchant_access": "read_write",
      "name": "Origin city",
      "namespace": "app:supplier-sync.details",
      "owner_type": "vendor",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Seoul"
  },
  "vendor": {
    "id": 7,
    "name": "Acme Supplies",
    "slug": "acme-supplies"
  }
}

Vendor metafield translations deleted

EVENT vendor_metafields/translations/delete App scope: read_products Staff permission: products:write

Fired after a vendor metafield translation is cleared, including during value or vendor deletion. The translated value is an empty string.

Payload fields

Field	Type	Description
`metafield.vendor_id`	`integer`	Always present The stable id of the vendor that holds the translated value.
`metafield.vendor_name`	`string`	Selectable in the Payload builder The vendor name when the event was created.
`metafield.vendor_slug`	`string`	Selectable in the Payload builder The vendor slug when the event was created.
`metafield.definition_id`	`string`	Always present The stable metafield definition UUID.
`metafield.namespace`	`string`	Selectable in the Payload builder The definition namespace.
`metafield.key`	`string`	Selectable in the Payload builder The definition key within its namespace.
`metafield.name`	`string`	Selectable in the Payload builder The merchant-facing definition name.
`metafield.type`	`string`	Selectable in the Payload builder The metafield value type.
`metafield.app_id`	`string`	Selectable in the Payload builder The owning app id, or null for a merchant-owned definition.
`metafield.app_access`	`string`	Selectable in the Payload builder Whether another authorized app may read the definition: private or shared.
`metafield.merchant_access`	`string`	Selectable in the Payload builder How Store Admin can access an app-owned definition: hidden, read, or read_write.
`locale`	`string`	Selectable in the Payload builder The locale whose vendor or metafield translation changed.
`translation.value`	`string`	Selectable in the Payload builder The translated metafield value; an empty string on the delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's translation last changed.

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "definition_id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
    "key": "origin_city",
    "merchant_access": "read_write",
    "name": "Origin city",
    "namespace": "app:supplier-sync.details",
    "type": "string",
    "vendor_id": 7,
    "vendor_name": "Acme Supplies",
    "vendor_slug": "acme-supplies"
  },
  "translation": {
    "value": ""
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Vendor metafield translations updated

EVENT vendor_metafields/translations/update App scope: read_products Staff permission: products:write

Fired after a vendor metafield translation is added or updated for a locale. The payload identifies the vendor, definition, locale, and translated value.

Payload fields

Field	Type	Description
`metafield.vendor_id`	`integer`	Always present The stable id of the vendor that holds the translated value.
`metafield.vendor_name`	`string`	Selectable in the Payload builder The vendor name when the event was created.
`metafield.vendor_slug`	`string`	Selectable in the Payload builder The vendor slug when the event was created.
`metafield.definition_id`	`string`	Always present The stable metafield definition UUID.
`metafield.namespace`	`string`	Selectable in the Payload builder The definition namespace.
`metafield.key`	`string`	Selectable in the Payload builder The definition key within its namespace.
`metafield.name`	`string`	Selectable in the Payload builder The merchant-facing definition name.
`metafield.type`	`string`	Selectable in the Payload builder The metafield value type.
`metafield.app_id`	`string`	Selectable in the Payload builder The owning app id, or null for a merchant-owned definition.
`metafield.app_access`	`string`	Selectable in the Payload builder Whether another authorized app may read the definition: private or shared.
`metafield.merchant_access`	`string`	Selectable in the Payload builder How Store Admin can access an app-owned definition: hidden, read, or read_write.
`locale`	`string`	Selectable in the Payload builder The locale whose vendor or metafield translation changed.
`translation.value`	`string`	Selectable in the Payload builder The translated metafield value; an empty string on the delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's translation last changed.

Payload shape

Sample payload

{
  "locale": "fr",
  "metafield": {
    "app_access": "shared",
    "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "definition_id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
    "key": "origin_city",
    "merchant_access": "read_write",
    "name": "Origin city",
    "namespace": "app:supplier-sync.details",
    "type": "string",
    "vendor_id": 7,
    "vendor_name": "Acme Supplies",
    "vendor_slug": "acme-supplies"
  },
  "translation": {
    "value": "Séoul"
  },
  "updated_at": "2026-06-10T09:30:00+05:30"
}

Vendor metafield value updated

EVENT vendor_metafields/update App scope: read_products Staff permission: products:write

Fired after a vendor metafield value changes. previous and current contain the value snapshots, and changed_fields is ["value"].

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present The stable vendor id.
`vendor.name`	`string`	Selectable in the Payload builder The vendor name at the time the event was created.
`vendor.slug`	`string`	Selectable in the Payload builder The vendor slug at the time the event was created.
`previous.definition.id`	`string`	Selectable in the Payload builder The stable metafield definition UUID.
`previous.definition.owner_type`	`string`	Selectable in the Payload builder The resource type that can hold this definition; vendor for these events.
`previous.definition.namespace`	`string`	Selectable in the Payload builder The definition namespace.
`previous.definition.key`	`string`	Selectable in the Payload builder The definition key within its namespace.
`previous.definition.name`	`string`	Selectable in the Payload builder The merchant-facing definition name.
`previous.definition.description`	`string`	Selectable in the Payload builder The optional merchant-facing definition description.
`previous.definition.type`	`string`	Selectable in the Payload builder The metafield value type.
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder Whether the stored value can have locale-specific translations.
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder The maximum stored string length, or null when this limit does not apply.
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder The maximum number of list items, or null when this limit does not apply.
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder The definition's display order.
`previous.definition.app_id`	`string`	Selectable in the Payload builder The owning app id, or null for a merchant-owned definition.
`previous.definition.app_access`	`string`	Selectable in the Payload builder Whether another authorized app may read the definition: private or shared.
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder How Store Admin can access an app-owned definition: hidden, read, or read_write.
`previous.definition.created_at`	`string`	Selectable in the Payload builder When the definition was created.
`previous.definition.updated_at`	`string`	Selectable in the Payload builder When the definition last changed.
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder The number of vendor values currently stored for this definition.
`previous.value`	`string`	Selectable in the Payload builder The stored value before the change.
`previous.created_at`	`string`	Selectable in the Payload builder When this vendor's value was created.
`previous.updated_at`	`string`	Selectable in the Payload builder When this vendor's value last changed.
`current.definition.id`	`string`	Selectable in the Payload builder The stable metafield definition UUID.
`current.definition.owner_type`	`string`	Selectable in the Payload builder The resource type that can hold this definition; vendor for these events.
`current.definition.namespace`	`string`	Selectable in the Payload builder The definition namespace.
`current.definition.key`	`string`	Selectable in the Payload builder The definition key within its namespace.
`current.definition.name`	`string`	Selectable in the Payload builder The merchant-facing definition name.
`current.definition.description`	`string`	Selectable in the Payload builder The optional merchant-facing definition description.
`current.definition.type`	`string`	Selectable in the Payload builder The metafield value type.
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder Whether the stored value can have locale-specific translations.
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder The maximum stored string length, or null when this limit does not apply.
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder The maximum number of list items, or null when this limit does not apply.
`current.definition.sort_order`	`integer`	Selectable in the Payload builder The definition's display order.
`current.definition.app_id`	`string`	Selectable in the Payload builder The owning app id, or null for a merchant-owned definition.
`current.definition.app_access`	`string`	Selectable in the Payload builder Whether another authorized app may read the definition: private or shared.
`current.definition.merchant_access`	`string`	Selectable in the Payload builder How Store Admin can access an app-owned definition: hidden, read, or read_write.
`current.definition.created_at`	`string`	Selectable in the Payload builder When the definition was created.
`current.definition.updated_at`	`string`	Selectable in the Payload builder When the definition last changed.
`current.definition.usage_count`	`integer`	Selectable in the Payload builder The number of vendor values currently stored for this definition.
`current.value`	`string`	Selectable in the Payload builder The stored value after the change.
`current.created_at`	`string`	Selectable in the Payload builder When this vendor's value was created.
`current.updated_at`	`string`	Selectable in the Payload builder When this vendor's value last changed.
`changed_fields`	`array`	Selectable in the Payload builder The metafield fields that changed. Vendor metafield update events currently contain value.

Payload shape

Sample payload

{
  "changed_fields": [
    "value"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "The supplier's origin city.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": false,
      "key": "origin_city",
      "max_list_items": null,
      "max_value_length": 100,
      "merchant_access": "read_write",
      "name": "Origin city",
      "namespace": "app:supplier-sync.details",
      "owner_type": "vendor",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "updated_at": "2026-06-10T09:30:00+05:30",
    "value": "Busan"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "shared",
      "app_id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "The supplier's origin city.",
      "id": "6b56de32-3f8c-4a25-a4cb-2d217ad7a8aa",
      "is_translatable": false,
      "key": "origin_city",
      "max_list_items": null,
      "max_value_length": 100,
      "merchant_access": "read_write",
      "name": "Origin city",
      "namespace": "app:supplier-sync.details",
      "owner_type": "vendor",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Seoul"
  },
  "vendor": {
    "id": 7,
    "name": "Acme Supplies",
    "slug": "acme-supplies"
  }
}

Vendor created

EVENT vendors/create App scope: read_products Staff permission: products:write

Fired after a vendor is created. The payload contains the new vendor snapshot; product_count is 0 and translations_updated_at is null.

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present The stable vendor id.
`vendor.name`	`string`	Selectable in the Payload builder The vendor name at the time the event was created.
`vendor.slug`	`string`	Selectable in the Payload builder The vendor slug at the time the event was created.
`vendor.description`	`string`	Selectable in the Payload builder The vendor description in the store's default language.
`vendor.seo_title`	`string`	Selectable in the Payload builder The vendor page's SEO title in the store's default language.
`vendor.seo_description`	`string`	Selectable in the Payload builder The vendor page's SEO description in the store's default language.
`vendor.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image UUID, or null when no image is assigned.
`vendor.image_url`	`string`	Selectable in the Payload builder The storefront URL for the assigned image, or an empty string.
`vendor.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string.
`vendor.product_count`	`integer`	Selectable in the Payload builder The number of products assigned to the vendor when the event was created.
`vendor.template_handle`	`string`	Selectable in the Payload builder The storefront Vendor template assigned to the vendor.
`vendor.created_at`	`string`	Selectable in the Payload builder When the vendor was created.
`vendor.updated_at`	`string`	Selectable in the Payload builder When the vendor last changed.
`vendor.translations_updated_at`	`string`	Selectable in the Payload builder When any vendor translation last changed, or null when none exist.

Payload shape

Sample payload

{
  "vendor": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme Supplies provides wholesale outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme Supplies",
    "product_count": 0,
    "seo_description": "Shop products supplied by Acme Supplies.",
    "seo_title": "Acme Supplies",
    "slug": "acme-supplies",
    "template_handle": "default_vendor",
    "translations_updated_at": null,
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Vendor deleted

EVENT vendors/delete App scope: read_products Staff permission: products:write

Fired after a vendor is deleted. Removed translations and metafield values have separate delete events.

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present The stable vendor id.
`vendor.name`	`string`	Selectable in the Payload builder The vendor name at the time the event was created.
`vendor.slug`	`string`	Selectable in the Payload builder The vendor slug at the time the event was created.

Payload shape

Sample payload

{
  "vendor": {
    "id": 7,
    "name": "Acme Supplies",
    "slug": "acme-supplies"
  }
}

Vendor translations deleted

EVENT vendors/translations/delete App scope: read_products Staff permission: products:write

Fired when vendor translations are cleared for one or more fields in a locale, including during vendor deletion. A write that updates some translated fields and clears others fires both translation events; translation writes do not fire vendors/update.

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present The stable vendor id.
`vendor.name`	`string`	Selectable in the Payload builder The vendor name at the time the event was created.
`vendor.slug`	`string`	Selectable in the Payload builder The vendor slug at the time the event was created.
`vendor.description`	`string`	Selectable in the Payload builder The vendor description in the store's default language.
`vendor.seo_title`	`string`	Selectable in the Payload builder The vendor page's SEO title in the store's default language.
`vendor.seo_description`	`string`	Selectable in the Payload builder The vendor page's SEO description in the store's default language.
`vendor.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image UUID, or null when no image is assigned.
`vendor.image_url`	`string`	Selectable in the Payload builder The storefront URL for the assigned image, or an empty string.
`vendor.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string.
`vendor.product_count`	`integer`	Selectable in the Payload builder The number of products assigned to the vendor when the event was created.
`vendor.template_handle`	`string`	Selectable in the Payload builder The storefront Vendor template assigned to the vendor.
`vendor.created_at`	`string`	Selectable in the Payload builder When the vendor was created.
`vendor.updated_at`	`string`	Selectable in the Payload builder When the vendor last changed.
`vendor.translations_updated_at`	`string`	Selectable in the Payload builder When any vendor translation last changed, or null when none exist.
`locale`	`string`	Selectable in the Payload builder The locale whose vendor or metafield translation changed.
`translation.name`	`string`	Selectable in the Payload builder The translated vendor name; an empty string on the delete event means it was removed.
`translation.slug`	`string`	Selectable in the Payload builder The translated vendor slug; an empty string on the delete event means it was removed.
`translation.description`	`string`	Selectable in the Payload builder The translated vendor description; an empty string on the delete event means it was removed.
`translation.seo_title`	`string`	Selectable in the Payload builder The translated SEO title; an empty string on the delete event means it was removed.
`translation.seo_description`	`string`	Selectable in the Payload builder The translated SEO description; an empty string on the delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's translation last changed.

Payload shape

Sample payload

{
  "locale": "fr",
  "translation": {
    "description": "",
    "name": "",
    "seo_description": "",
    "seo_title": "",
    "slug": ""
  },
  "updated_at": "2026-06-10T09:30:00+05:30",
  "vendor": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme Supplies provides wholesale outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme Supplies",
    "product_count": 12,
    "seo_description": "Shop products supplied by Acme Supplies.",
    "seo_title": "Acme Supplies",
    "slug": "acme-supplies",
    "template_handle": "default_vendor",
    "translations_updated_at": "2026-06-10T09:30:00+05:30",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Vendor translations updated

EVENT vendors/translations/update App scope: read_products Staff permission: products:write

Fired when vendor translations are added or updated for a locale. The payload contains only the fields that changed. A write that updates some translated fields and clears others fires both translation events; translation writes do not fire vendors/update.

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present The stable vendor id.
`vendor.name`	`string`	Selectable in the Payload builder The vendor name at the time the event was created.
`vendor.slug`	`string`	Selectable in the Payload builder The vendor slug at the time the event was created.
`vendor.description`	`string`	Selectable in the Payload builder The vendor description in the store's default language.
`vendor.seo_title`	`string`	Selectable in the Payload builder The vendor page's SEO title in the store's default language.
`vendor.seo_description`	`string`	Selectable in the Payload builder The vendor page's SEO description in the store's default language.
`vendor.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image UUID, or null when no image is assigned.
`vendor.image_url`	`string`	Selectable in the Payload builder The storefront URL for the assigned image, or an empty string.
`vendor.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string.
`vendor.product_count`	`integer`	Selectable in the Payload builder The number of products assigned to the vendor when the event was created.
`vendor.template_handle`	`string`	Selectable in the Payload builder The storefront Vendor template assigned to the vendor.
`vendor.created_at`	`string`	Selectable in the Payload builder When the vendor was created.
`vendor.updated_at`	`string`	Selectable in the Payload builder When the vendor last changed.
`vendor.translations_updated_at`	`string`	Selectable in the Payload builder When any vendor translation last changed, or null when none exist.
`locale`	`string`	Selectable in the Payload builder The locale whose vendor or metafield translation changed.
`translation.name`	`string`	Selectable in the Payload builder The translated vendor name; an empty string on the delete event means it was removed.
`translation.slug`	`string`	Selectable in the Payload builder The translated vendor slug; an empty string on the delete event means it was removed.
`translation.description`	`string`	Selectable in the Payload builder The translated vendor description; an empty string on the delete event means it was removed.
`translation.seo_title`	`string`	Selectable in the Payload builder The translated SEO title; an empty string on the delete event means it was removed.
`translation.seo_description`	`string`	Selectable in the Payload builder The translated SEO description; an empty string on the delete event means it was removed.
`updated_at`	`string`	Selectable in the Payload builder When this locale's translation last changed.

Payload shape

Sample payload

{
  "locale": "fr",
  "translation": {
    "description": "Fournitures Acme distribue du matériel de plein air en gros.",
    "name": "Fournitures Acme",
    "seo_description": "Découvrez les produits distribués par Fournitures Acme.",
    "seo_title": "Fournitures Acme",
    "slug": "fournitures-acme"
  },
  "updated_at": "2026-06-10T09:30:00+05:30",
  "vendor": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme Supplies provides wholesale outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme Supplies",
    "product_count": 12,
    "seo_description": "Shop products supplied by Acme Supplies.",
    "seo_title": "Acme Supplies",
    "slug": "acme-supplies",
    "template_handle": "default_vendor",
    "translations_updated_at": "2026-06-10T09:30:00+05:30",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Vendor updated

EVENT vendors/update App scope: read_products Staff permission: products:write

Fired after vendor fields change. Product assignment changes do not fire this event; fetch the vendor when you need an authoritative product_count.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

description image_id name seo_description seo_title slug template_handle

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present The stable vendor id.
`vendor.name`	`string`	Selectable in the Payload builder The vendor name at the time the event was created.
`vendor.slug`	`string`	Selectable in the Payload builder The vendor slug at the time the event was created.
`vendor.description`	`string`	Selectable in the Payload builder The vendor description in the store's default language.
`vendor.seo_title`	`string`	Selectable in the Payload builder The vendor page's SEO title in the store's default language.
`vendor.seo_description`	`string`	Selectable in the Payload builder The vendor page's SEO description in the store's default language.
`vendor.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image UUID, or null when no image is assigned.
`vendor.image_url`	`string`	Selectable in the Payload builder The storefront URL for the assigned image, or an empty string.
`vendor.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string.
`vendor.product_count`	`integer`	Selectable in the Payload builder The number of products assigned to the vendor when the event was created.
`vendor.template_handle`	`string`	Selectable in the Payload builder The storefront Vendor template assigned to the vendor.
`vendor.created_at`	`string`	Selectable in the Payload builder When the vendor was created.
`vendor.updated_at`	`string`	Selectable in the Payload builder When the vendor last changed.
`vendor.translations_updated_at`	`string`	Selectable in the Payload builder When any vendor translation last changed, or null when none exist.
`previous.id`	`integer`	Always present The stable vendor id. This value is from before the update.
`previous.name`	`string`	Selectable in the Payload builder The vendor name at the time the event was created. This value is from before the update.
`previous.slug`	`string`	Selectable in the Payload builder The vendor slug at the time the event was created. This value is from before the update.
`previous.description`	`string`	Selectable in the Payload builder The vendor description in the store's default language. This value is from before the update.
`previous.seo_title`	`string`	Selectable in the Payload builder The vendor page's SEO title in the store's default language. This value is from before the update.
`previous.seo_description`	`string`	Selectable in the Payload builder The vendor page's SEO description in the store's default language. This value is from before the update.
`previous.image_id`	`string`	Selectable in the Payload builder The assigned Media-library image UUID, or null when no image is assigned. This value is from before the update.
`previous.image_url`	`string`	Selectable in the Payload builder The storefront URL for the assigned image, or an empty string. This value is from before the update.
`previous.image_cdn_url`	`string`	Selectable in the Payload builder The delivery URL for the assigned image, or an empty string. This value is from before the update.
`previous.product_count`	`integer`	Selectable in the Payload builder The number of products assigned to the vendor when the event was created. This value is from before the update.
`previous.template_handle`	`string`	Selectable in the Payload builder The storefront Vendor template assigned to the vendor. This value is from before the update.
`previous.created_at`	`string`	Selectable in the Payload builder When the vendor was created. This value is from before the update.
`previous.updated_at`	`string`	Selectable in the Payload builder When the vendor last changed. This value is from before the update.
`previous.translations_updated_at`	`string`	Selectable in the Payload builder When any vendor translation last changed, or null when none exist. This value is from before the update.
`changed_fields`	`array`	Always present The vendor fields changed by this event.
`change_type`	`string`	Always present Why vendors/update fired: source for vendor field edits.

Payload shape

Sample payload

{
  "change_type": "source",
  "changed_fields": [
    "image_id"
  ],
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme Supplies provides wholesale outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme Supplies",
    "product_count": 12,
    "seo_description": "Shop products supplied by Acme Supplies.",
    "seo_title": "Acme Supplies",
    "slug": "acme-supplies",
    "template_handle": "default_vendor",
    "translations_updated_at": "2026-06-09T12:00:00+05:30",
    "updated_at": "2026-06-10T09:30:00+05:30"
  },
  "vendor": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Acme Supplies provides wholesale outdoor gear.",
    "id": 7,
    "image_cdn_url": "https://assets.tringify.com/74e634ea-84ec-43b8-b66b-986214c2c5a3/upload/8f2a1c2b-9d4e-4a56-b789-0123456789ab.jpg",
    "image_id": "8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "image_url": "https://store.example.com/uploads/8f2a1c2b-9d4e-4a56-b789-0123456789ab",
    "name": "Acme Supplies",
    "product_count": 12,
    "seo_description": "Shop products supplied by Acme Supplies.",
    "seo_title": "Acme Supplies",
    "slug": "acme-supplies",
    "template_handle": "default_vendor",
    "translations_updated_at": "2026-06-09T12:00:00+05:30",
    "updated_at": "2026-06-10T09:30:00+05:30"
  }
}

Attributes#

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Blog#

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Possible changed_fields values

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Possible changed_fields values

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Possible changed_fields values

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Brands#

Payload fields

Possible `changed_fields` values

Possible `changed_fields` values

Possible `changed_fields` values