Option GET

URI

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

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

Description

Returns the ID, name and sort order of an option.

Example 1

Requesting all product options

Request URI

/option/

Response

{
	"response": [
		{
			"id": 2,
			"name": "Apples",
			"sortOrder": 0
		},
		{
			"id": 1,
			"name": "Default",
			"sortOrder": 0
		},
		{
			"id": 4,
			"name": "Oranges",
			"sortOrder": 5
		},
		{
			"id": 3,
			"name": "Bananas",
			"sortOrder": 100
		}
	]
}

Example 2

Requesting options using an ID set

Request URI

/option/1,4

Response

{
	"response": [
		{
			"id": 1,
			"name": "Default",
			"sortOrder": 0
		},
		{
			"id": 4,
			"name": "Oranges",
			"sortOrder": 5
		}
	]
}