Order Stock Status GET

URI

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

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

Description

Order stock status codes indicate the fulfilment status of a sale, credit or purchase. These codes are consistent across all Brightpearl accounts but we use the three letter codes in Order GET responses and require the integer IDs in Order SEARCH requests. This API allows you to convert between the two in your application code without hard coding the mapping.

This API does not support ID set filtering - it returns all the statuses. There are currently 13.

  • id Numeric identifier of the stock status
  • code Three letter identifier of the stock status
  • description A human readable description of the stock status

Example

Request all stock status codes.

Request URI

/order-stock-status/

Response

{
	"response": [
		{
			"id": 1,
			"code": "SON",
			"description": "Sales Order Not Fulfilled"
		},
		{
			"id": 2,
			"code": "SOP",
			"description": "Sales Order Part Fulfilled"
		},
		{
			"id": 3,
			"code": "SOA",
			"description": "Sales Order All Fulfilled"
		},
		{
			"id": 4,
			"code": "PON",
			"description": "Purchase Order Not Fulfilled"
		},
		{
			"id": 5,
			"code": "POP",
			"description": "Purchase Order Part Fulfilled"
		},
		{
			"id": 6,
			"code": "POA",
			"description": "Purchase Order All Fulfilled"
		},
		{
			"id": 7,
			"code": "SCN",
			"description": "Sales Credit Not Fulfilled"
		},
		{
			"id": 8,
			"code": "SCP",
			"description": "Sales Credit Part Fulfilled"
		},
		{
			"id": 9,
			"code": "SCA",
			"description": "Sales Credit All Fulfilled"
		},
		{
			"id": 10,
			"code": "PCN",
			"description": "Purchase Credit Not Fulfilled"
		},
		{
			"id": 11,
			"code": "PCP",
			"description": "Purchase Credit Part Fulfilled"
		},
		{
			"id": 12,
			"code": "PCA",
			"description": "Purchase Credit All Fulfilled"
		},
		{
			"id": 13,
			"code": "NON",
			"description": "Non stock-tracked order"
		}
	]
}