xclade
Admin APIProduct categories

Create Product Category

Create a product category.

POST
/admin/product-categories
AuthorizationBearer <token>

In: header

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.

offset?number

The number of items to skip when retrieving a list.

limit?number

Limit the number of items returned in the list.

order?string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

with_deleted?boolean

Whether to include deleted records in the result.

Request Body

application/json

name*string

The product category's name.

description?string

The product category's description.

handle?string

The product category's handle.

is_internal?boolean

Whether the product category is only used and seen by admin users.

is_active?boolean

Whether the product category is active.

parent_category_id?string

The ID of a category that's the parent of this one.

rank?number

The sorting order of the product category among sibling categories.

metadata?object

The product category's metadata, used to store custom key-value pairs.

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" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "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"
}