Migrate products from v3 to v5
Changes in the Products API v5
Here is a summary of the changes in the Products API v5:
| Field | Type | Required | Notes |
|---|---|---|---|
| id | string | Yes | Renamed from productID |
| url | string | Yes | Renamed from productUrl |
| price | float | No | New field |
| strikeThroughPrice | float | No | New field |
| defaultImageUrl | string | No | New field |
| images | []string | No | Type has changed |
| variants[].id | string | Yes | Renamed from variants[].variantID |
| variants[].url | string | Yes | Renamed from variants[].productUrl |
| variants[].price | float | No | Type has changed |
| variants[].strikeThroughPrice | float | No | Renamed from variants[].oldPrice, type has changed |
| variants[].description | string | No | New field |
| variants[].defaultImageUrl | string | No | New field |
| variants[].images | []string | No | Replaced variants[].imageID |
Images
- We got rid of the
imageIDfield and replaced it with an array of image URLs. This change allows you to provide
multiple images for a single product or variant in a more straightforward way. defaultImageUrlis a new field that allows you to set a default image for a product or variant.
Prices
- within new API, prices (
priceandstrikeThroughPrice) are represented as floats. In the previous version, they
were integers (cents).
Events
The structure for handling events in Omnisend API v5 (link)
differs from v3 (link1, link2)
because v5 offers significantly more flexibility. To ensure a smooth transition for your existing event integrations
when upgrading, you need to
- add the
compatibility: no-originheader to your API calls.
This modification guarantees that your segmentation and automation rules will continue to operate properly.
Updated 1 day ago