Skip to main content
PATCH
Update merchant link

Authorizations

X-API-Key
string
header
required

Path Parameters

Id of the merchant link.

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

Body

application/json

Payload for PATCH /merchant-links/{link_id}. Only the keys present are applied.

The product is fixed at creation; delete and recreate to move a link.

name
string | null

Merchant name.

Required string length: 1 - 100
Pattern: ^[^\x00]{1,100}$
url
string | null

Direct URL to the product page. Must start with https://.

Required string length: 9 - 200
Pattern: ^[Hh][Tt][Tt][Pp][Ss]://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,191}$

Response

OK

A merchant link as read from the API. Mirrors :class:apps.products.models.MerchantLink.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
product_id
string<shortuuid>
required

The product this link is shown on.

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

The product's GTIN, normalized to GTIN-14.

name
string
required

Merchant name shown when no catalog merchant is attached.

merchant_name
string
required

Name of the catalog merchant attached to this link by Closient staff, which the hosted page shows in place of name. Empty string when none. Read-only.

url
string
required

Direct URL to the product page at the merchant (https).

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).