Skip to main content
POST
/
retailers
/
api
/
v1
/
organizations
/
{organization_id}
/
retailers
Create retailer
curl --request POST \
  --url https://www.closient.com/retailers/api/v1/organizations/{organization_id}/retailers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "is_online": true,
  "is_physical": true,
  "website": "",
  "gln": "<string>",
  "marketplace_regions": []
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "public_id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "is_online": true,
  "is_physical": true,
  "website": "",
  "gln": "<string>",
  "is_canonical": false,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketplace_regions": [
    "<string>"
  ],
  "is_active": true
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
organization_id
string<uuid>
required

UUID of the organization to create the retailer for.

Body

application/json
​
name
string
required
​
is_online
boolean
default:true
​
is_physical
boolean
default:true
​
website
string
default:""
​
gln
string | null
​
marketplace_regions
string[]

Response

OK

​
id
string<uuid>
required

Unique retailer identifier.

​
name
string
required

Retailer display name.

​
public_id
string
required

URL-safe retailer identifier.

​
created
string<date-time>
required

When the retailer was created.

​
is_online
boolean
default:true

Whether this retailer sells products online.

​
is_physical
boolean
default:true

Whether this retailer has physical store locations.

​
website
string
default:""

Retailer website URL.

​
gln
string | null

GS1 Global Location Number.

​
is_canonical
boolean
default:false

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

​
organization_id
string<uuid> | null

Owning organization for org-private retailers.

​
marketplace_regions
string[]

ISO 3166-1 alpha-2 region codes.

​
is_active
boolean
default:true

Whether the retailer is active.