Brightpearl Category Search

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/product-service/brightpearl-category-search

Refer to our documentation on URI syntax for more information on how to construct URIs.

Columns

Name Required Sortable Filterable Data type Reference data Description
id INTEGER None The Id of the Category. Can be used to retrieve all category information using Category Get.
name STRING None The Category name.
parentId INTEGER None The Id of the parent Category. Can be used to retrieve all parent category information usinge Category Get.
active BOOLEAN None Is the Category active.
createdOn PERIOD None The date the Category was created.
createdById INTEGER None The Id of the contact that created the Category. This can be used to retrieve contact information of the contact that created the category using the Contact get.
updatedOn PERIOD None The date the Category was last updated.
updatedBy INTEGER None The Id of the contact that last modified the Category. This can be used to retrieve contact information of the contact that last modified the category using the Contact get.

Sorting

Sorted by Sort Direction
id ASC

More information

Instructions for working with resources can be found in Resource search design