Brightpearl Category GET

URI

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

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

Description

The message returns Brightpearl Categories. This message takes in an optional ID Set to allow you to request particular Categories.

Key Fields:

  • partentId: This is the Id of the parent Category. If the Category is a root Category then this will be set to 0.

Example 1

Requesting all Categories.

Request URI

/brightpearl-category/

Response

{
	"response": [
		{
			"id": 276,
			"name": "Parts",
			"parentId": 0,
			"active": true,
			"createdOn": "2007-06-13T22:25:09.000+01:00",
			"createdById": 0,
			"updatedOn": "2009-05-29T12:00:41.000+01:00",
			"updatedById": 2,
			"description": {
				"languageCode": "en",
				"text": "\u003cp\u003eThis is the home page.\u003c/p\u003e",
				"format": "PLAINTEXT"
			}
		},
		{
			"id": 295,
			"name": "Services",
			"parentId": 0,
			"active": true,
			"createdOn": "2008-12-23T10:59:34.000Z",
			"createdById": 2,
			"updatedOn": "2009-04-23T00:35:47.000+01:00",
			"updatedById": 2,
			"description": {
				"languageCode": "en",
				"text": "",
				"format": "PLAINTEXT"
			}
		},
		{
			"id": 296,
			"name": "Other",
			"parentId": 0,
			"active": true,
			"createdOn": "2008-12-23T10:59:49.000Z",
			"createdById": 2,
			"updatedOn": "2009-04-23T00:35:57.000+01:00",
			"updatedById": 2,
			"description": {
				"languageCode": "en",
				"text": "",
				"format": "PLAINTEXT"
			}
		}
	]
}

Example 2

Requesting Categories using an Id Set.

Request URI

/brightpearl-category/276,296

Response

{
	"response": [
		{
			"id": 276,
			"name": "Parts",
			"parentId": 0,
			"active": true,
			"createdOn": "2007-06-13T22:25:09.000+01:00",
			"createdById": 0,
			"updatedOn": "2009-05-29T12:00:41.000+01:00",
			"updatedById": 2,
			"description": {
				"languageCode": "en",
				"text": "\u003cp\u003eThis is the home page.\u003c/p\u003e",
				"format": "PLAINTEXT"
			}
		},
		{
			"id": 296,
			"name": "Other",
			"parentId": 0,
			"active": true,
			"createdOn": "2008-12-23T10:59:49.000Z",
			"createdById": 2,
			"updatedOn": "2009-04-23T00:35:57.000+01:00",
			"updatedById": 2,
			"description": {
				"languageCode": "en",
				"text": "",
				"format": "PLAINTEXT"
			}
		}
	]
}