Synchronization events
Detailed events containing data changes.
Attributes
attribute_created
included with events: attribute_created
{
"type": "attribute_created",
"payload": {
"code": "attribute_code",
"type": "TEXT",
"scope": "local",
"name": [
{
"language": "en_GB",
"value": "This is the attribute name"
}
]
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"code": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["DATE", "FILE", "GALLERY", "IMAGE", "MULTI_SELECT", "NUMERIC", "PRICE", "PRODUCT_RELATION", "SELECT", "TEXT_AREA", "TEXT", "UNIT"]
},
"scope": {
"type": "string",
"enum": ["local", "global"]
},
"name": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"language",
"value"
]
}
}
},
"required": [
"code",
"type",
"scope",
"name"
]
}
},
"required": [
"type",
"payload"
]
}
attribute_name_changed
included with events: attribute_created, attribute_updated
{
"type": "attribute_name_changed",
"payload": {
"name": [
{
"language": "en_GB",
"value": "This is the new attribute name"
}
]
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"name": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"language",
"value"
]
}
}
},
"required": [
"name"
]
}
},
"required": [
"type",
"payload"
]
}
attribute_option_code_changed
included with events: attribute_created, attribute_updated
{
"type": "attribute_option_code_changed",
"payload": {
"option_code": "option_code",
"previous_option_code": "previous_option_code"
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"option_code": {
"type": "string"
},
"previous_option_code": {
"type": "string"
}
},
"required": [
"option_code",
"previous_option_code"
]
}
},
"required": [
"type",
"payload"
]
}
attribute_option_created
included with events: attribute_created, attribute_updated
{
"type": "attribute_option_created",
"payload": {
"option_code": "option_code",
"option_name": [
{
"language": "en_GB",
"value": "This is the option name"
}
]
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"option_code": {
"type": "string"
},
"option_name": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"language",
"value"
]
}
}
},
"required": [
"option_code",
"option_name"
]
}
},
"required": [
"type",
"payload"
]
}
attribute_option_deleted
included with events: attribute_updated
{
"type": "attribute_option_deleted",
"payload": {
"option_code": "option_code"
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"option_code": {
"type": "string"
}
},
"required": [
"option_code"
]
}
},
"required": [
"type",
"payload"
]
}
attribute_option_name_changed
included with events: attribute_created, attribute_updated
{
"type": "attribute_option_name_changed",
"payload": {
"option_code": "option_code",
"option_name": [
{
"language": "en_GB",
"value": "This is the new option name"
}
]
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"option_code": {
"type": "string"
},
"option_name": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"language",
"value"
]
}
}
},
"required": [
"option_code",
"option_name"
]
}
},
"required": [
"type",
"payload"
]
}
Categories
category_created
included with events: category_created
{
"type": "category_created",
"payload": {
"code": "category_code",
"name": [
{
"language": "en_GB",
"value": "This is the category name"
}
]
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"language",
"value"
]
}
}
},
"required": [
"code",
"name"
]
}
},
"required": [
"type",
"payload"
]
}
category_name_changed
included with events: category_created, category_updated
{
"type": "attribute_name_changed",
"payload": {
"name": [
{
"language": "en_GB",
"value": "This is the new category name"
}
]
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"language",
"value"
]
}
}
},
"required": [
"code",
"name"
]
}
},
"required": [
"type",
"payload"
]
}
Products
product_added_to_category
included with events: product_created, product_updated
{
"type": "product_added_to_category",
"payload": {
"category_code": "category_code"
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"category_code": {
"type": "string"
}
},
"required": [
"category_code"
]
}
},
"required": [
"type",
"payload"
]
}
product_binding_added
included with events: product_created, product_updated
{
"type": "product_binding_added",
"payload": {
"attribute_code": "attribute_code"
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"attribute_code": {
"type": "string"
}
},
"required": [
"attribute_code"
]
}
},
"required": [
"type",
"payload"
]
}
product_binding_removed
included with events: product_updated
{
"type": "product_binding_removed",
"payload": {
"attribute_code": "attribute_code"
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"attribute_code": {
"type": "string"
}
},
"required": [
"attribute_code"
]
}
},
"required": [
"type",
"payload"
]
}
product_child_added
included with events: product_created, product_updated
{
"type": "product_child_added",
"payload": {
"child_sku": "Child sku",
"child_quantity": 2
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"child_sku": {
"type": "string"
},
"child_quantity": {
"type": "integer"
}
},
"required": [
"child_sku",
"child_quantity"
]
}
},
"required": [
"type",
"payload"
]
}
product_child_quantity_changed
included with events: product_created, product_updated
{
"type": "product_child_quantity_changed",
"payload": {
"child_sku": "Child sku",
"child_quantity": 2
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"child_sku": {
"type": "string"
},
"child_quantity": {
"type": "integer"
}
},
"required": [
"child_sku",
"child_quantity"
]
}
},
"required": [
"type",
"payload"
]
}
product_child_removed
included with events: product_updated
{
"type": "product_child_removed",
"payload": {
"child_sku": "Child sku"
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"child_sku": {
"type": "string"
}
},
"required": [
"child_sku"
]
}
},
"required": [
"type",
"payload"
]
}
product_created
included with events: product_created
{
"type": "product_created",
"payload": {
"sku": "Product SKU",
"type": "SIMPLE-PRODUCT",
"category_codes": ["category_code"]
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"sku": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["SIMPLE-PRODUCT", "GROUPING-PRODUCT", "VARIABLE-PRODUCT"]
},
"category_codes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"sku",
"type",
"category_codes"
]
}
},
"required": [
"type",
"payload"
]
}
product_removed_from_category
included with events: product_updated
{
"type": "product_removed_from_category",
"payload": {
"category_code": "category_code"
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"category_code": {
"type": "string"
}
},
"required": [
"category_code"
]
}
},
"required": [
"type",
"payload"
]
}
product_value_added
included with events: product_created, product_updated
{
"type": "product_value_added",
"payload": {
"attribute_code": "attribute_code",
"attribute_type": "TEXT",
"attribute_scope": "local",
"value": [
{
"language": "en_GB",
"translation": "This is the attribute value"
}
]
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"attribute_code": {
"type": "string"
},
"attribute_type": {
"type": "string",
"enum": ["DATE", "FILE", "GALLERY", "IMAGE", "MULTI_SELECT", "NUMERIC", "PRICE", "PRODUCT_RELATION", "SELECT", "TEXT_AREA", "TEXT", "UNIT"]
},
"attribute_scope": {
"type": "string",
"enum": ["local", "global"]
},
"value": {
"oneOf": [
{
"type": "string",
"description": "For global attribute of type DATE, SELECT, TEXT_AREA and TEXT"
},
{
"type": "number",
"description": "For global attribute of type NUMERIC, PRICE and UNIT"
},
{
"type": "array",
"items": {
"type": "string"
},
"description": "For global attribute of type MULTI_SELECT and PRODUCT_RELATION"
},
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"url",
"path"
],
"description": "For global attribute of type IMAGE"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"url",
"path"
]
},
"description": "For global attribute of type FILE and GALLERY"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"value": {
"oneOf": [
{
"$ref": "#/components/schemas/AttributeValue"
}
]
}
},
"required": [
"language",
"value"
]
},
"description": "For local attributes same types as for global wrapped in translation array"
}
]
}
},
"required": [
"attribute_code",
"attribute_type",
"attribute_scope",
"value"
]
}
},
"required": [
"type",
"payload"
]
}
product_value_changed
included with events: product_created, product_updated
{
"type": "product_value_changed",
"payload": {
"attribute_code": "attribute_code",
"attribute_type": "TEXT",
"attribute_scope": "global",
"value": "This is the attribute value"
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of synchronization event."
},
"payload": {
"type": "object",
"description": "The detailed payload of the synchronization event.",
"properties": {
"attribute_code": {
"type": "string"
},
"attribute_type": {
"type": "string",
"enum": ["DATE", "FILE", "GALLERY", "IMAGE", "MULTI_SELECT", "NUMERIC", "PRICE", "PRODUCT_RELATION", "SELECT", "TEXT_AREA", "TEXT", "UNIT"]
},
"attribute_scope": {
"type": "string",
"enum": ["local", "global"]
},
"value": {
"oneOf": [
{
"type": "string",
"description": "For global attribute of type DATE, SELECT, TEXT_AREA and TEXT"
},
{
"type": "number",
"description": "For global attribute of type NUMERIC, PRICE and UNIT"
},
{
"type": "array",
"items": {
"type": "string"
},
"description": "For global attribute of type MULTI_SELECT and PRODUCT_RELATION"
},
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"url",
"path"
],
"description": "For global attribute of type IMAGE"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"url",
"path"
]
},
"description": "For global attribute of type FILE and GALLERY"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"value": {
"oneOf": [
{
"$ref": "#/components/schemas/AttributeValue"
}
]
}
},
"required": [
"language",
"value"
]
},
"description": "For local attributes same types as for global wrapped in translation array"
}
]
}
},
"required": [
"attribute_code",
"attribute_type",
"attribute_scope",
"value"
]
}
},
"required": [
"type",
"payload"
]
}
product_value_removed
included with events: product_updated
{
"type": "product_value_removed",
"payload": {
"attribute_code": "attribute_code",
"attribute_type": "TEXT"
}
}
{
"type": "object",
"properties": {
"type": {
"type": "string",