Skip to main content
GET
Preview a brand merge

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<shortuuid>
required

URL-safe identifier of the brand that stays (the survivor).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

donor_id
string<shortuuid>
required

URL-safe identifier of the brand to absorb (the donor). It is deleted by the merge. It must belong to the same organization as the survivor.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

What merging the donor into the survivor would do. Nothing has changed.

survivor
BrandMergeBrandOut · object
required

The brand that stays.

Example:
donor
BrandMergeBrandOut · object
required

The brand that would be absorbed and deleted.

Example:
products_reassigned
integer
required

Products that would move from the donor to the survivor.

survivor_counts
BrandMergeCountsOut · object
required

What the survivor carries today.

Example:
donor_counts
BrandMergeCountsOut · object
required

What the donor carries today and would move.

Example:
field_collisions
BrandMergeFieldCollisionOut · object[]
required

Profile fields where the donor's value would be dropped in favour of the survivor's.

Whether the donor has a logo.

Whether the survivor has a logo.