Return reason POST

URI

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

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

Description

Create a new return reason. All below fields are required.

Field Name Field Description
code A short code (maximum 6 characters, letters only) describing the return reason, used to see return reason at a glance on reports and to uniquely identify each return reason.
name A descriptive name (up to 32 characters) for this return reason.
action The action to take when an item is returned with this reason code. Current values are WRITE_OFF, RETURN_TO_INVENTORY and QUARANTINE.
active Whether or not this return reason can currently be used.

Example

Create a new return reason

Request URI

/return-reason

Request body

{
	"code": "UNWTD",
	"name": "Unwanted item",
	"action": "RETURN_TO_INVENTORY",
	"active": true
}

Response

{
	"response": "UNWTD"
}