Synchronization events

Detailed events containing data changes.

Attributes

attribute_created

included with events: attribute_created

Example

{
  "type": "attribute_created",
  "payload": {
    "code": "attribute_code",
    "type": "TEXT",
    "scope": "local",
    "name": [
      {
        "language": "en_GB",
        "value": "This is the attribute name"
      }
    ]
  }
}

Schema

attribute_name_changed

included with events: attribute_created, attribute_updated

Example

{
  "type": "attribute_name_changed",
  "payload": {
    "name": [
      {
        "language": "en_GB",
        "value": "This is the new attribute name"
      }
    ]
  }
}

Schema

attribute_option_code_changed

included with events: attribute_created, attribute_updated

Example

{
  "type": "attribute_option_code_changed",
  "payload": {
    "option_code": "option_code",
    "previous_option_code": "previous_option_code"
  }
}

Schema

attribute_option_created

included with events: attribute_created, attribute_updated

Example

{
  "type": "attribute_option_created",
  "payload": {
    "option_code": "option_code",
    "option_name": [
      {
        "language": "en_GB",
        "value": "This is the option name"
      }
    ]
  }
}

Schema

attribute_option_deleted

included with events: attribute_updated

Example

{
  "type": "attribute_option_deleted",
  "payload": {
    "option_code": "option_code"
  }
}

Schema

attribute_option_name_changed

included with events: attribute_created, attribute_updated

Example

{
  "type": "attribute_option_name_changed",
  "payload": {
    "option_code": "option_code",
    "option_name": [
      {
        "language": "en_GB",
        "value": "This is the new option name"
      }
    ]
  }
}

Schema

Categories

category_created

included with events: category_created

Example

{
  "type": "category_created",
  "payload": {
    "code": "category_code",
    "name": [
      {
        "language": "en_GB",
        "value": "This is the category name"
      }
    ]
  }
}

Schema

category_name_changed

included with events: category_created, category_updated

Example

{
  "type": "attribute_name_changed",
  "payload": {
    "name": [
      {
        "language": "en_GB",
        "value": "This is the new category name"
      }
    ]
  }
}

Schema

Products

product_added_to_category

included with events: product_created, product_updated

Example

{
  "type": "product_added_to_category",
  "payload": {
    "category_code": "category_code"
  }
}

Schema

product_binding_added

included with events: product_created, product_updated

Example

{
  "type": "product_binding_added",
  "payload": {
    "attribute_code": "attribute_code"
  }
}

Schema

product_binding_removed

included with events: product_updated

Example

{
  "type": "product_binding_removed",
  "payload": {
    "attribute_code": "attribute_code"
  }
}

Schema

product_child_added

included with events: product_created, product_updated

Example

{
  "type": "product_child_added",
  "payload": {
    "child_sku": "Child sku",
    "child_quantity": 2
  }
}

Schema

product_child_quantity_changed

included with events: product_created, product_updated

Example

{
  "type": "product_child_quantity_changed",
  "payload": {
    "child_sku": "Child sku",
    "child_quantity": 2
  }
}

Schema

product_child_removed

included with events: product_updated

Example

{
  "type": "product_child_removed",
  "payload": {
    "child_sku": "Child sku"
  }
}

Schema

product_created

included with events: product_created

Example

{
  "type": "product_created",
  "payload": {
    "sku": "Product SKU",
    "type": "SIMPLE-PRODUCT",
    "category_codes": ["category_code"]
  }
}

Schema

product_removed_from_category

included with events: product_updated

Example

{
  "type": "product_removed_from_category",
  "payload": {
    "category_code": "category_code"
  }
}

Schema

product_value_added

included with events: product_created, product_updated

Example

{
  "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"
      }
    ]
  }
}

Schema

product_value_changed

included with events: product_created, product_updated

Example

{
  "type": "product_value_changed",
  "payload": {
    "attribute_code": "attribute_code",
    "attribute_type": "TEXT",
    "attribute_scope": "global",
    "value": "This is the attribute value"
  }
}

Schema

product_value_removed

included with events: product_updated

Example

{
  "type": "product_value_removed",
  "payload": {
    "attribute_code": "attribute_code",
    "attribute_type": "TEXT"
  }
}

Schema

product_variant_added

included with events: product_updated

Example

{
  "type": "product_variant_added",
  "payload": {
    "variant_sku": "Variant SKU",
    "binding_values": [
      {
        "attribute_code": "attribute_code",
        "attribute_type": "SELECT",
        "attribute_scope": "global",
        "value": "attribute_option_code"
      }
    ]
  }
}

Schema

product_variant_removed

included with events: product_updated

Example

{
  "type": "product_variant_removed",
  "payload": {
    "variant_sku": "Variant SKU"
  }
}

Schema