Order Status GET

URI

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

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

Description

Returns details about order statuses grouped by orderTypeCode sorted by sortOrder ascending.

  • Status ID
  • Name of the status
  • Order type code (SO, SC, PO or PC)
  • Sort order
  • If the status has been disabled (no longer used)
  • If the status should be visible to the customer
  • The color that represents the status. If present it will be a 3 or 6 character hex code e.g. #09C or #0099CC.
  • The number of days that an order can be on this status before a notification is set to the user
  • List of email addresses to send an alert to when an order lands on this status
  • Optional additional email body content for alert emails
  • Whether or not this order status should be included in end of day batch post processing (Only applies to sales order and sales credit statuses)
  • The State represent Order state name

Example 1

Requesting all statuses.

Request URI

/order-status/

Response

{
	"response": [
		{
			"statusId": 6,
			"name": "Pending PO",
			"orderTypeCode": "PO",
			"sortOrder": 0,
			"disabled": true,
			"visible": false,
			"color": "#15D115",
			"remindAfterDays": 1,
			"alertEmails": [
				"email@email.com"
			],
			"emailContent": "",
			"batchProcess": false,
			"state": "draft"
		},
		{
			"statusId": 7,
			"name": "Placed with supplier",
			"orderTypeCode": "PO",
			"sortOrder": 10,
			"disabled": false,
			"visible": false,
			"color": "#F994EC",
			"remindAfterDays": 0,
			"alertEmails": [
				"email1@email.com",
				"email2@anotheremail.com"
			],
			"emailContent": "The above email addresses will also get this text in their status change alerts",
			"batchProcess": false,
			"state": "draft"
		}
	]
}

Example 2

Requesting Statuses using an Id Set.

Request URI

/order-status/1,6

Response

{
	"response": [
		{
			"statusId": 1,
			"name": "Draft / Quote",
			"orderTypeCode": "SO",
			"sortOrder": 0,
			"disabled": false,
			"visible": true,
			"color": "#999999",
			"remindAfterDays": 10,
			"alertEmails": [
			],
			"emailContent": "",
			"batchProcess": false,
			"state": "draft"
		},
		{
			"statusId": 6,
			"name": "Pending PO",
			"orderTypeCode": "PO",
			"sortOrder": 0,
			"disabled": true,
			"visible": false,
			"color": "#F994EC",
			"remindAfterDays": 7,
			"alertEmails": [
				"email1@email.com",
				"email2@anotheremail.com"
			],
			"emailContent": "All of this has happened before, and it will happen again.",
			"batchProcess": false,
			"state": "draft"
		}
	]
}