Get a deep diff between two entity versions or draft vs published.

1 min

GET

https://api.upstartcommerce.com/pim/diff

Returns a deep diff between two versions of a product or variant, or between the latest published version and the current draft.

entity_typestringType of entity to diff.

entity_idstringID of the product or variant.

modestringDiff mode - compare two versions or draft vs latest published.

from_versionintegerBase (older) version number. Required when mode=version.

to_versionintegerTarget (newer) version number. Required when mode=version.

fieldsstringComma-separated list of fields to include in the diff.

ignore_fieldsstringComma-separated list of fields to exclude from the diff.

pageintegerPage number for pagination.

page_sizeintegerNumber of diff entries per page.

acceptstringGenerated from available response content types

200Diff result.

422Unprocessable entity.

curl --request GET \
     --url 'https://api.upstartcommerce.com/pim/diff?entity_type=product&entity_id=string&mode=version&page=1&page_size=50' \
     --header 'accept: application/json'