Create or Update Categories

CategoryCreateCategoriesResponse Categories.CreateCategories(, )

POST/api/v2/public/categories

Creates or updates product categories, matched on category_code. Categories can be nested by setting parent_product_category_code. Setting flush to true deletes all existing categories first, so only use it when sending the complete set.

ParametersExpand Collapse

CategoryCreateCategoriesParams parameters

Boolean flush

Query param: When true, removes existing categories before inserting.

IReadOnlyList<Category>? categories

Body param: The list of category entries.

required string CategoryName

The category display name.

minLength1

required Boolean IsAdjustMinMax

Whether min/max stock levels should be automatically adjusted for products in this category.

required Boolean IsMarkdown

Whether markdown pricing is enabled for this category.

string? CategoryCode

Unique category code identifier.

Int? ExpirationOffset

Number of days offset for product expiration within this category.

formatint32

string? FriendlyCategoryName

A user-friendly alternative name for the category.

string? MarkdownPercentages

Comma-separated markdown percentage values.

string? ParentCategoryCode

The parent category code for hierarchy. Defaults to “0” (root) when not provided.

Int? ReceiptOffset

Number of days offset for receipt processing within this category.

formatint32

ReturnsExpand Collapse

class CategoryCreateCategoriesResponse:

Standard success response returned by mutation endpoints.

required Boolean Success

Indicates whether the operation completed successfully.

string? Data

Optional data payload returned by the operation.

string? Message

Human-readable message describing the result.

Create or Update Categories

CategoryCreateCategoriesParams parameters = new();

var response = await client.Categories.CreateCategories(parameters);

Console.WriteLine(response);

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}