Custom Field GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/order-service/order/{ID}/custom-field

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

Description

Get the custom data held against a given order. If you wish to see which custom fields are defined for this type of order, use a order custom field metadata GET request.

Example

Get the custom fields for order 123

Request URI

/order/123/custom-field

Response

{
	"response": {
		"PCF_FREEFORM": "This is a single line of text",
		"PCF_TEXTAREA": "This text\r\nis written across\r\nseveral lines",
		"PCF_DATE": "2015-06-19T00:00:00.000+01:00",
		"PCF_YESNO": true,
		"PCF_SELECTLI": {
			"id": 9,
			"value": "Ringo"
		},
		"PCF_NUMERIC": 456
	}
}