Categories

Manage product categories.

Base URL: /api/v1/partner/category

Endpoints Overview

Method	Endpoint	Description
GET	/{id}	Get category by id
POST	/	Create a new category
PUT	/{id}	Update category by id
DELETE	/{id}	Delete category by id
GET	/	List all categories

---

Get category by id

GET /api/v1/partner/category/{id}

Retrieve a single product category by its ID.

Path Parameters

Parameter	Type	Description
id	string	The id

Response

Returns a ProductCategoryView object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
name	string	Yes	Name
cannabis	boolean	No	Cannabis
blazeCategoryId	string	No	Blaze Category identifier
active	boolean	No	Whether active (default: true)
unitType	unittype	No	Unit Type (default: units)
lowThreshold	number	No	Low Threshold (default: ZERO)
complianceId	string	No	Compliance identifier
archived	boolean	No	Archived (default: false)
topLevelCategoryId	string	No	Top Level Category identifier
shopIds	string[]	No	Shop Ids
parentCategoryId	string	No	Parent Category identifier
wmCategory	string	No	Wm Category
externalId	string	No	External system identifier
priority	integer	No	Priority (default: 0)
masterId	string	No	Master identifier
platformCategoryId	string	No	Platform Category identifier
platformParentCategoryId	string	No	Platform Parent Category identifier
sourceMap	object	No	Source Map
photo	CompanyAsset	No	Photo
labelTemplateId	string	No	Label Template identifier
categoryApp	string	No	Category App. One of: DISTRO, MANUFACTURING
unitTrackingEnabled	boolean	No	Unit Tracking Enabled
isGiftCard	boolean	No	Is Gift Card
key	final string	No	Key

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "name": "string",
  "cannabis": false,
  "blazeCategoryId": "abc123",
  "active": true,
  "unitType": "units",
  "lowThreshold": "ZERO",
  "complianceId": "abc123",
  "archived": false,
  "topLevelCategoryId": "abc123",
  "shopIds": [],
  "parentCategoryId": "abc123",
  "wmCategory": "string",
  "externalId": "abc123",
  "priority": 0,
  "masterId": "abc123",
  "platformCategoryId": "abc123",
  "platformParentCategoryId": "abc123",
  "sourceMap": {},
  "photo": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "key": "string",
    "type": {},
    "publicURL": "string",
    "active": false,
    "priority": 0,
    "secured": true,
    "thumbURL": "string",
    "mediumURL": "string",
    "largeURL": "string",
    "largeX2URL": "string",
    "origURL": "string",
    "platformFileUrl": "string"
  },
  "labelTemplateId": "abc123",
  "categoryApp": "DISTRO",
  "unitTrackingEnabled": false,
  "isGiftCard": false,
  "key": {}
}

---

Create a new category

POST /api/v1/partner/category

Create a new product category. Send a ProductCategoryAddRequest in the request body.

Request Body

Fields

Field	Type	Required	Description
name	string	Yes	Name
cannabis	boolean	No	Cannabis
priority	integer	No	Priority (default: 0)
active	boolean	No	Whether active (default: true)
lowThreshold	number	No	Low Threshold
wmCategory	string	No	Wm Category
externalId	string	No	External system identifier
complianceId	string	No	Compliance identifier
parentId	string	No	Parent identifier
shopId	string	No	Shop identifier
topLevelCategoryId	string	No	Top Level Category identifier
photo	CompanyAsset	No	Photo
labelTemplateId	string	No	Label Template identifier
platformCategoryId	string	No	Platform Category identifier
platformParentCategoryId	string	No	Platform Parent Category identifier

JSON

{
  "name": "string",
  "cannabis": false,
  "priority": 0,
  "active": true,
  "lowThreshold": 0,
  "wmCategory": "string",
  "externalId": "abc123",
  "complianceId": "abc123",
  "parentId": "abc123",
  "shopId": "abc123",
  "topLevelCategoryId": "abc123",
  "photo": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "key": "string",
    "type": {},
    "publicURL": "string",
    "active": false,
    "priority": 0,
    "secured": true,
    "thumbURL": "string",
    "mediumURL": "string",
    "largeURL": "string",
    "largeX2URL": "string",
    "origURL": "string",
    "platformFileUrl": "string"
  },
  "labelTemplateId": "abc123",
  "platformCategoryId": "abc123",
  "platformParentCategoryId": "abc123"
}

Response

Returns a ProductCategoryView object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
name	string	Yes	Name
cannabis	boolean	No	Cannabis
blazeCategoryId	string	No	Blaze Category identifier
active	boolean	No	Whether active (default: true)
unitType	unittype	No	Unit Type (default: units)
lowThreshold	number	No	Low Threshold (default: ZERO)
complianceId	string	No	Compliance identifier
archived	boolean	No	Archived (default: false)
topLevelCategoryId	string	No	Top Level Category identifier
shopIds	string[]	No	Shop Ids
parentCategoryId	string	No	Parent Category identifier
wmCategory	string	No	Wm Category
externalId	string	No	External system identifier
priority	integer	No	Priority (default: 0)
masterId	string	No	Master identifier
platformCategoryId	string	No	Platform Category identifier
platformParentCategoryId	string	No	Platform Parent Category identifier
sourceMap	object	No	Source Map
photo	CompanyAsset	No	Photo
labelTemplateId	string	No	Label Template identifier
categoryApp	string	No	Category App. One of: DISTRO, MANUFACTURING
unitTrackingEnabled	boolean	No	Unit Tracking Enabled
isGiftCard	boolean	No	Is Gift Card
key	final string	No	Key

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "name": "string",
  "cannabis": false,
  "blazeCategoryId": "abc123",
  "active": true,
  "unitType": "units",
  "lowThreshold": "ZERO",
  "complianceId": "abc123",
  "archived": false,
  "topLevelCategoryId": "abc123",
  "shopIds": [],
  "parentCategoryId": "abc123",
  "wmCategory": "string",
  "externalId": "abc123",
  "priority": 0,
  "masterId": "abc123",
  "platformCategoryId": "abc123",
  "platformParentCategoryId": "abc123",
  "sourceMap": {},
  "photo": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "key": "string",
    "type": {},
    "publicURL": "string",
    "active": false,
    "priority": 0,
    "secured": true,
    "thumbURL": "string",
    "mediumURL": "string",
    "largeURL": "string",
    "largeX2URL": "string",
    "origURL": "string",
    "platformFileUrl": "string"
  },
  "labelTemplateId": "abc123",
  "categoryApp": "DISTRO",
  "unitTrackingEnabled": false,
  "isGiftCard": false,
  "key": {}
}

---

Update category by id

PUT /api/v1/partner/category/{id}

Update an existing product category by ID. Send the full ProductCategoryView object in the request body.

Path Parameters

Parameter	Type	Description
id	string	The id

Request Body

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
name	string	Yes	Name
cannabis	boolean	No	Cannabis
blazeCategoryId	string	No	Blaze Category identifier
active	boolean	No	Whether active (default: true)
unitType	unittype	No	Unit Type (default: units)
lowThreshold	number	No	Low Threshold (default: ZERO)
complianceId	string	No	Compliance identifier
archived	boolean	No	Archived (default: false)
topLevelCategoryId	string	No	Top Level Category identifier
shopIds	string[]	No	Shop Ids
parentCategoryId	string	No	Parent Category identifier
wmCategory	string	No	Wm Category
externalId	string	No	External system identifier
priority	integer	No	Priority (default: 0)
masterId	string	No	Master identifier
platformCategoryId	string	No	Platform Category identifier
platformParentCategoryId	string	No	Platform Parent Category identifier
sourceMap	object	No	Source Map
photo	CompanyAsset	No	Photo
labelTemplateId	string	No	Label Template identifier
categoryApp	string	No	Category App. One of: DISTRO, MANUFACTURING
unitTrackingEnabled	boolean	No	Unit Tracking Enabled
isGiftCard	boolean	No	Is Gift Card
key	final string	No	Key

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "name": "string",
  "cannabis": false,
  "blazeCategoryId": "abc123",
  "active": true,
  "unitType": "units",
  "lowThreshold": "ZERO",
  "complianceId": "abc123",
  "archived": false,
  "topLevelCategoryId": "abc123",
  "shopIds": [],
  "parentCategoryId": "abc123",
  "wmCategory": "string",
  "externalId": "abc123",
  "priority": 0,
  "masterId": "abc123",
  "platformCategoryId": "abc123",
  "platformParentCategoryId": "abc123",
  "sourceMap": {},
  "photo": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "key": "string",
    "type": {},
    "publicURL": "string",
    "active": false,
    "priority": 0,
    "secured": true,
    "thumbURL": "string",
    "mediumURL": "string",
    "largeURL": "string",
    "largeX2URL": "string",
    "origURL": "string",
    "platformFileUrl": "string"
  },
  "labelTemplateId": "abc123",
  "categoryApp": "DISTRO",
  "unitTrackingEnabled": false,
  "isGiftCard": false,
  "key": {}
}

Response

Returns a ProductCategoryView object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
name	string	Yes	Name
cannabis	boolean	No	Cannabis
blazeCategoryId	string	No	Blaze Category identifier
active	boolean	No	Whether active (default: true)
unitType	unittype	No	Unit Type (default: units)
lowThreshold	number	No	Low Threshold (default: ZERO)
complianceId	string	No	Compliance identifier
archived	boolean	No	Archived (default: false)
topLevelCategoryId	string	No	Top Level Category identifier
shopIds	string[]	No	Shop Ids
parentCategoryId	string	No	Parent Category identifier
wmCategory	string	No	Wm Category
externalId	string	No	External system identifier
priority	integer	No	Priority (default: 0)
masterId	string	No	Master identifier
platformCategoryId	string	No	Platform Category identifier
platformParentCategoryId	string	No	Platform Parent Category identifier
sourceMap	object	No	Source Map
photo	CompanyAsset	No	Photo
labelTemplateId	string	No	Label Template identifier
categoryApp	string	No	Category App. One of: DISTRO, MANUFACTURING
unitTrackingEnabled	boolean	No	Unit Tracking Enabled
isGiftCard	boolean	No	Is Gift Card
key	final string	No	Key

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "name": "string",
  "cannabis": false,
  "blazeCategoryId": "abc123",
  "active": true,
  "unitType": "units",
  "lowThreshold": "ZERO",
  "complianceId": "abc123",
  "archived": false,
  "topLevelCategoryId": "abc123",
  "shopIds": [],
  "parentCategoryId": "abc123",
  "wmCategory": "string",
  "externalId": "abc123",
  "priority": 0,
  "masterId": "abc123",
  "platformCategoryId": "abc123",
  "platformParentCategoryId": "abc123",
  "sourceMap": {},
  "photo": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "key": "string",
    "type": {},
    "publicURL": "string",
    "active": false,
    "priority": 0,
    "secured": true,
    "thumbURL": "string",
    "mediumURL": "string",
    "largeURL": "string",
    "largeX2URL": "string",
    "origURL": "string",
    "platformFileUrl": "string"
  },
  "labelTemplateId": "abc123",
  "categoryApp": "DISTRO",
  "unitTrackingEnabled": false,
  "isGiftCard": false,
  "key": {}
}

---

Delete category by id

DELETE /api/v1/partner/category/{id}

Delete a product category by its ID.

Path Parameters

Parameter	Type	Description
id	string	The id

---

List all categories

GET /api/v1/partner/category

Retrieve all product categories. Returns the complete list without pagination.

Response

Returns a ListResult<ProductCategoryView> object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
name	string	Yes	Name
cannabis	boolean	No	Cannabis
blazeCategoryId	string	No	Blaze Category identifier
active	boolean	No	Whether active (default: true)
unitType	unittype	No	Unit Type (default: units)
lowThreshold	number	No	Low Threshold (default: ZERO)
complianceId	string	No	Compliance identifier
archived	boolean	No	Archived (default: false)
topLevelCategoryId	string	No	Top Level Category identifier
shopIds	string[]	No	Shop Ids
parentCategoryId	string	No	Parent Category identifier
wmCategory	string	No	Wm Category
externalId	string	No	External system identifier
priority	integer	No	Priority (default: 0)
masterId	string	No	Master identifier
platformCategoryId	string	No	Platform Category identifier
platformParentCategoryId	string	No	Platform Parent Category identifier
sourceMap	object	No	Source Map
photo	CompanyAsset	No	Photo
labelTemplateId	string	No	Label Template identifier
categoryApp	string	No	Category App. One of: DISTRO, MANUFACTURING
unitTrackingEnabled	boolean	No	Unit Tracking Enabled
isGiftCard	boolean	No	Is Gift Card
key	final string	No	Key

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "name": "string",
  "cannabis": false,
  "blazeCategoryId": "abc123",
  "active": true,
  "unitType": "units",
  "lowThreshold": "ZERO",
  "complianceId": "abc123",
  "archived": false,
  "topLevelCategoryId": "abc123",
  "shopIds": [],
  "parentCategoryId": "abc123",
  "wmCategory": "string",
  "externalId": "abc123",
  "priority": 0,
  "masterId": "abc123",
  "platformCategoryId": "abc123",
  "platformParentCategoryId": "abc123",
  "sourceMap": {},
  "photo": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "name": "string",
    "key": "string",
    "type": {},
    "publicURL": "string",
    "active": false,
    "priority": 0,
    "secured": true,
    "thumbURL": "string",
    "mediumURL": "string",
    "largeURL": "string",
    "largeX2URL": "string",
    "origURL": "string",
    "platformFileUrl": "string"
  },
  "labelTemplateId": "abc123",
  "categoryApp": "DISTRO",
  "unitTrackingEnabled": false,
  "isGiftCard": false,
  "key": {}
}