xclade
Admin APICollections

Delete a Collection

Delete a product collection.

DELETE
/admin/collections/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

The collection's ID.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X DELETE "https://{tenant}.api.myxclade.com/admin/collections/string"
{
  "id": "string",
  "object": "collection",
  "deleted": true
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}

List Product Variants

Retrieve a list of product variants. The product variants can be filtered by fields such as `id`. The product variants can also be sorted or paginated.

List Collections

Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated.