Skip to main content
PATCH
/
retailers
/
api
/
v1
/
retailers
/
{retailer_id}
Update retailer
curl --request PATCH \
  --url https://www.closient.com/retailers/api/v1/retailers/{retailer_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metadata": {},
  "name": "<string>",
  "website": "<string>",
  "gln": "<string>",
  "category": "<string>",
  "marketplace_regions": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "metadata": {},
  "is_online": false,
  "is_physical": false,
  "website": "",
  "gln": "<string>",
  "is_canonical": false,
  "organization_id": "<string>",
  "marketplace_regions": [
    "<string>"
  ],
  "category": "<string>",
  "is_active": true
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
retailer_id
string<shortuuid>
required

Unique identifier of the retailer to update.

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

Body

application/json
​
metadata
Metadata · object

Developer-attached key/value data. Send {} or null to clear. Empty-string values delete that key. Omitted keys are preserved.

​
name
string | null
​
website
string | null
​
gln
string | null
​
category
string | null
​
marketplace_regions
string[] | null

Response

OK

​
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}$
​
name
string
required

Retailer display name.

​
created
string<date-time>
required

When the retailer was created.

​
metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.

​
is_online
boolean
default:false

Derived — true iff the retailer has at least one active OnlineStore.

​
is_physical
boolean
default:false

Derived — true iff the retailer has at least one active PhysicalStore.

​
website
string
default:""

Retailer's canonical homepage URL (separate from individual storefronts).

​
gln
string | null

GS1 Global Location Number.

​
is_canonical
boolean
default:false

True for Closient-curated retailers (read-only).

​
organization_id
string<shortuuid> | null

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}$
​
marketplace_regions
string[]

ISO 3166-1 alpha-2 region codes.

​
category
string | null

Retailer type/category classification.

​
is_active
boolean
default:true

Whether the retailer is active.