Order Status POST

URI

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

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

Description

This message enables you to create a new Order Status in your Brightpearl system.

Field Summary:

Field Description Data Type Required Notes
name

Name of the status

String True Maximum 64 characters. Cannot have a duplicate name for the same order type
orderTypeCode

The type of order that this status belongs to

String True Possible values are "SO", "SC", "PO" or "PC"
color

The hex color that the order status label will appear as

String True
remindAfterDays

The number of days that an order can be on this status before a notification is set to the user

Integer False Maximum of 9999. Defaults to 0
alertEmails

List of email addresses to send an alert to when an order lands on this status

List of strings False Maximum of 2 emails, each email must be no longer than 63 characters
emailContent

Optional additional content to be included in the alert emails sent to the addresses specified in alertEmails

String False Defaults to ""
batchProcess

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)

Boolean False Defaults to false

Example 1

Create a new order status with just the required fields.

Request URI

/order-status/

Request body

{
	"name": "New Sales Order Status",
	"orderTypeCode": "SO",
	"color": "#E7E6E4"
}

Response

{
	"response": 22
}

Example 2

Create a new order status with all fields.

Request URI

/order-status/

Request body

{
	"name": "New Sales Credit Status",
	"orderTypeCode": "SC",
	"color": "#E7E6E4",
	"remindAfterDays": 7,
	"alertEmails": [
		"email1@email.com",
		"email2@email.com"
	],
	"emailContent": "Remember to ring Dave about this Sales Credit",
	"batchProcess": true
}

Response

{
	"response": 23
}