Return reason GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/return-reason/{code}

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

Description

Fetch one or all return reasons

Example 1

Fetch the return reason with code FLOOD

Request URI

/return-reason/FLOOD

Response

{
	"response": {
		"code": "FLOOD",
		"name": "Got wet in the 2014 flood",
		"action": "QUARANTINE",
		"active": false
	}
}

Example 2

Get all return reasons

Request URI

/return-reason

Response

{
	"response": [
		{
			"code": "DMGD",
			"name": "Damaged goods",
			"action": "WRITE_OFF",
			"active": true
		},
		{
			"code": "FLOOD",
			"name": "Got wet in the 2014 flood",
			"action": "QUARANTINE",
			"active": false
		}
	]
}