Events API reference Deprecated

Complete reference on how to use Akeneo PIM events

#Products

#Product created

#Format

A product created event follows this format:

{

  • events (array[object]) : [
    • {
        • action (string) • Event type
        • event_id (string) • Unique event identifier
        • event_datetime (string) • Event datetime
        • author (string) • Author of the event
        • author_type (string) • Type of the author "ui" or "api"
        • pim_source (string) • URL of the PIM that sends the event
        • data (object) : {
          • resource (object) : {
            • identifier (string) • Product identifier, i.e. the value of the only `pim_catalog_identifier` attribute
            • enabled (boolean) • Whether the product is enabled
            • family (string) • Family code from which the product inherits its attributes and attributes requirements
            • categories (array[string]) • Codes of the categories in which the product is classified
            • groups (array[string]) • Codes of the groups to which the product belong
            • parent (string) • Code of the parent product model when the product is a variant
            • values (object) : {
              • attributeCode (array[object]) : [
                • {
                    • scope (string) • Channel code of the product value
                    • locale (string) • Locale code of the product value
                    • data (object) • Product value
                  • }
                  ]
                }
              • associations (object) : {
                • associationTypeCode (object) : {
                  • groups (array[string]) • Array of group codes with which the product is in relation
                  • products (array[string]) • Array of product identifiers with which the product is in relation
                  • product_models (array[string]) • Array of product model codes with which the product is in relation.
                  }
                }
              • quantified_associations (object) : {
                • quantifiedAssociationTypeCode (object) : {
                  • products (array[object]) • Array of objects containing product identifiers and quantities with which the product is in relation : [
                    • {
                        • identifier (string)
                        • quantity (integer)
                      • }
                      ]
                    • product_models (array[object]) • Array of objects containing product model codes and quantities with which the product is in relation : [
                      • {
                          • code (string)
                          • quantity (integer)
                        • }
                        ]
                      }
                    }
                  • created (string) • Product creation date
                  • updated (string) • Date of the last product update
                  • metadata (object) • More information around the product (only available in the Enterprise Edition) : {
                    • workflow_status (string) • Status of the product regarding the user permissions (only available in the Enterprise Edition)
                    }
                  }
                }
            • }
            ]

          }

          #Example

          {
        "events": [
            {
                "action": "product.created",
                "event_id": "c306e088-fb76-479c-bbc0-18fef19da75d",
                "event_datetime": "2020-10-20T09:13:59+00:00",
                "author": "peter",
                "author_type": "ui",
                "pim_source": "https://demo.akeneo.com",
                "data": {
                    "resource": {
                        "identifier": "1111111304",
                        "family": "accessories",
                        "parent": null,
                        "groups": [],
                        "categories": [
                            "master_accessories_sunglasses",
                            "supplier_zaro"
                        ],
                        "enabled": true,
                        "values": {
                            "collection": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": [
                                        "winter_2020"
                                    ]
                                }
                            ],
                            "image": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": "9/9/c/c/99cc83f105199c667505cfa8ec1458c8be4f0814_sunglasses.jpg",
                                    "_links": {
                                        "download": {
                                            "href": "http://demo.akeneo.com/api/rest/v1/media-files/9/9/c/c/99cc83f105199c667505cfa8ec1458c8be4f0814_sunglasses.jpg/download"
                                        }
                                    }
                                }
                            ],
                            "ean": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": "1234567890316"
                                }
                            ],
                            "name": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": "Sunglasses"
                                }
                            ],
                            "weight": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": {
                                        "amount": "800.0000",
                                        "unit": "GRAM"
                                    }
                                }
                            ],
                            "description": [
                                {
                                    "locale": "en_US",
                                    "scope": "ecommerce",
                                    "data": "<p>Brown and gold sunglasses</p>"
                                }
                            ]
                        },
                        "created": "2020-10-20T08:30:28+00:00",
                        "updated": "2020-10-20T09:13:59+00:00",
                        "associations": {
                            "PACK": {
                                "groups": [],
                                "products": [],
                                "product_models": []
                            },
                            "SUBSTITUTION": {
                                "groups": [],
                                "products": [],
                                "product_models": []
                            },
                            "UPSELL": {
                                "groups": [],
                                "products": [],
                                "product_models": []
                            },
                            "X_SELL": {
                                "groups": [],
                                "products": [],
                                "product_models": []
                            }
                        },
                        "quantified_associations": [],
                        "metadata": {
                            "workflow_status": "working_copy"
                        }
                    }
                }
            }
        ]
    }

          #Product updated

          #Format

          A product updated event follows this format:

          {

          • events (array[object]) : [
            • {
                • action (string) • Event type
                • event_id (string) • Unique event identifier
                • event_datetime (string) • Event datetime
                • author (string) • Author of the event
                • author_type (string) • Type of the author "ui" or "api"
                • pim_source (string) • URL of the PIM that sends the event
                • data (object) : {
                  • resource (object) : {
                    • identifier (string) • Product identifier, i.e. the value of the only `pim_catalog_identifier` attribute
                    • enabled (boolean) • Whether the product is enabled
                    • family (string) • Family code from which the product inherits its attributes and attributes requirements
                    • categories (array[string]) • Codes of the categories in which the product is classified
                    • groups (array[string]) • Codes of the groups to which the product belong
                    • parent (string) • Code of the parent product model when the product is a variant
                    • values (object) : {
                      • attributeCode (array[object]) : [
                        • {
                            • scope (string) • Channel code of the product value
                            • locale (string) • Locale code of the product value
                            • data (object) • Product value
                          • }
                          ]
                        }
                      • associations (object) : {
                        • associationTypeCode (object) : {
                          • groups (array[string]) • Array of group codes with which the product is in relation
                          • products (array[string]) • Array of product identifiers with which the product is in relation
                          • product_models (array[string]) • Array of product model codes with which the product is in relation.
                          }
                        }
                      • quantified_associations (object) : {
                        • quantifiedAssociationTypeCode (object) : {
                          • products (array[object]) • Array of objects containing product identifiers and quantities with which the product is in relation : [
                            • {
                                • identifier (string)
                                • quantity (integer)
                              • }
                              ]
                            • product_models (array[object]) • Array of objects containing product model codes and quantities with which the product is in relation : [
                              • {
                                  • code (string)
                                  • quantity (integer)
                                • }
                                ]
                              }
                            }
                          • created (string) • Product creation date
                          • updated (string) • Date of the last product update
                          • metadata (object) • More information around the product (only available in the Enterprise Edition) : {
                            • workflow_status (string) • Status of the product regarding the user permissions (only available in the Enterprise Edition)
                            }
                          }
                        }
                    • }
                    ]

                  }

                  #Example

                  {
        "events": [
            {
                "action": "product.updated",
                "event_id": "c306e088-fb76-479c-bbc0-18fef19da75d",
                "event_datetime": "2020-10-20T09:13:59+00:00",
                "author": "peter",
                "author_type": "ui",
                "pim_source": "https://demo.akeneo.com",
                "data": {
                    "resource": {
                        "identifier": "1111111304",
                        "family": "accessories",
                        "parent": null,
                        "groups": [],
                        "categories": [
                            "master_accessories_sunglasses",
                            "supplier_zaro"
                        ],
                        "enabled": true,
                        "values": {
                            "collection": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": [
                                        "winter_2020"
                                    ]
                                }
                            ],
                            "image": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": "9/9/c/c/99cc83f105199c667505cfa8ec1458c8be4f0814_sunglasses.jpg",
                                    "_links": {
                                        "download": {
                                            "href": "http://demo.akeneo.com/api/rest/v1/media-files/9/9/c/c/99cc83f105199c667505cfa8ec1458c8be4f0814_sunglasses.jpg/download"
                                        }
                                    }
                                }
                            ],
                            "ean": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": "1234567890316"
                                }
                            ],
                            "name": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": "Sunglasses"
                                }
                            ],
                            "weight": [
                                {
                                    "locale": null,
                                    "scope": null,
                                    "data": {
                                        "amount": "800.0000",
                                        "unit": "GRAM"
                                    }
                                }
                            ],
                            "description": [
                                {
                                    "locale": "en_US",
                                    "scope": "ecommerce",
                                    "data": "<p>Brown and gold sunglasses</p>"
                                }
                            ]
                        },
                        "created": "2020-10-20T08:30:28+00:00",
                        "updated": "2020-10-20T09:13:59+00:00",
                        "associations": {
                            "PACK": {
                                "groups": [],
                                "products": [],
                                "product_models": []
                            },
                            "SUBSTITUTION": {
                                "groups": [],
                                "products": [],
                                "product_models": []
                            },
                            "UPSELL": {
                                "groups": [],
                                "products": [],
                                "product_models": []
                            },
                            "X_SELL": {
                                "groups": [],
                                "products": [],
                                "product_models": []
                            }
                        },
                        "quantified_associations": [],
                        "metadata": {
                            "workflow_status": "working_copy"
                        }
                    }
                }
            }
        ]
    }

                  #Product removed

                  #Format

                  A product removed event follows this format:

                  {

                  • events (array[object]) : [
                    • {
                        • action (string) • Event type
                        • event_id (string) • Unique event identifier
                        • event_datetime (string) • Event datetime
                        • author (string) • Author of the event
                        • author_type (string) • Type of the author "ui" or "api"
                        • pim_source (string) • URL of the PIM that sends the event
                        • data (object) : {
                          • resource (object) : {
                            • identifier (string)
                            }
                          }
                      • }
                      ]

                    }

                    #Example

                    {
        "events": [
            {
                "action": "product.removed",
                "event_id": "c306e088-fb76-479c-bbc0-18fef19da75d",
                "event_datetime": "2020-10-20T09:13:59+00:00",
                "author": "peter",
                "author_type": "ui",
                "pim_source": "https://demo.akeneo.com",
                "data": {
                    "resource": {
                        "identifier": "1111111304"
                    }
                }
            }
        ]
    }