Breaking change in Products endpoint and Webhook

What is going to change?

The response structure to PUT v1/products/{id} prices property will change. The prices property will be sent as an array of objects instead of an object. This change will also impact the webhook updated.product response payload as its response structure will change in the same way as the endpoint.

Response structure before

{
...
            "key": "lead_id",
            "name": "Lead",
            "order_nr": 21,
            "picklist_data": null,
            "field_type": "lead",
            "json_column_flag": false,
            "add_time": "2019-12-15 12:10:23",
            "update_time": "2019-12-15 12:10:23",
…
}

Response structure after

...
"add_time": "2019-12-19 11:36:49",
"update_time": "2019-12-26 13:35:17",
"prices": [{
  "EUR": {
   "id": 1,
   "product_id": 1,
   "price": 5,
   "currency": "EUR",
   "cost": 2,
   "overhead_cost": 3
  }
 ]
}
...

Why is it going to change?

This is done to increase the overall consistency of all Products endpoints and webhooks to align with best practices.

Who is affected?

• API consumers who strictly check the response structure of the PUT v1/products/{id} endpoint.
• Apps or users who either check themselves or use a tool to check the payload structure of updated.products webhook.

Published on September 24, 2021