Delete retailer

Soft-delete an org-private retailer (sets is_active=False). Cannot delete canonical retailers.

DELETE /retailers/api/v1/retailers/{retailer_id}

Delete retailer

cURL

curl --request DELETE \
  --url https://www.closient.com/retailers/api/v1/retailers/{retailer_id} \
  --header 'X-API-Key: <api-key>'

403

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

Authorizations

APIKeyHeaderAuthOAuthTokenAuthSessionAuth

X-API-Key · string · header · required

Path Parameters

retailer_id · string<shortuuid> · required

Unique identifier of the retailer to delete.

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

204

No Content