xclade
Admin APIProduct categories

Manage Products in Product Category

Manage products of a category to add or remove them.

POST
/admin/product-categories/{id}/products
AuthorizationBearer <token>

In: header

Path Parameters

id*string

The product category's ID.

Query Parameters

fields?string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the Retrieve Custom Links documentation.

Request Body

application/json

add?array<add>

The products to add.

remove?array<remove>

The product to remove.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X POST "https://{tenant}.api.myxclade.com/admin/product-categories/string/products" \  -H "Content-Type: application/json" \  -d '{}'
{
  "product_category": {
    "category_children": [
      {}
    ],
    "parent_category": {},
    "products": [
      {}
    ],
    "name": "string",
    "description": "string",
    "id": "string",
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "handle": "string",
    "deleted_at": "2019-08-24T14:15:22Z",
    "is_active": true,
    "is_internal": true,
    "rank": 0,
    "parent_category_id": "string"
  }
}

{
  "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"
}