Option Value 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 of the option value, the ID of its associated option, the option name, and its sort order.

Example 1

Requesting all option Values for option ID 1

Request URI

/option/1/value

Response

{
	"response": [
		{
			"optionValueId": 1,
			"optionValueName": "Black",
			"optionId": 1
		},
		{
			"optionValueId": 2,
			"optionValueName": "Blue",
			"optionId": 1
		},
		{
			"optionValueId": 3,
			"optionValueName": "Green",
			"optionId": 1
		},
		{
			"optionValueId": 4,
			"optionValueName": "Orange",
			"optionId": 1
		},
		{
			"optionValueId": 5,
			"optionValueName": "Red",
			"optionId": 1
		},
		{
			"optionValueId": 6,
			"optionValueName": "White",
			"optionId": 1
		},
		{
			"optionValueId": 7,
			"optionValueName": "Yellow",
			"optionId": 1
		}
	]
}

Example 2

Requesting all option values for options with IDs 1 and 2

Request URI

/option/1,2/value

Response

{
	"response": [
		{
			"optionValueId": 1,
			"optionValueName": "Black",
			"optionId": 1
		},
		{
			"optionValueId": 2,
			"optionValueName": "Blue",
			"optionId": 1
		},
		{
			"optionValueId": 3,
			"optionValueName": "Green",
			"optionId": 1
		},
		{
			"optionValueId": 4,
			"optionValueName": "Orange",
			"optionId": 1
		},
		{
			"optionValueId": 5,
			"optionValueName": "Red",
			"optionId": 1
		},
		{
			"optionValueId": 6,
			"optionValueName": "White",
			"optionId": 1
		},
		{
			"optionValueId": 7,
			"optionValueName": "Yellow",
			"optionId": 1
		},
		{
			"optionValueId": 8,
			"optionValueName": "Small",
			"optionId": 2
		},
		{
			"optionValueId": 9,
			"optionValueName": "Medium",
			"optionId": 2
		},
		{
			"optionValueId": 10,
			"optionValueName": "Large",
			"optionId": 2
		},
		{
			"optionValueId": 11,
			"optionValueName": "X-Large",
			"optionId": 2
		},
		{
			"optionValueId": 12,
			"optionValueName": "XX-Large",
			"optionId": 2
		}
	]
}