Order Type GET

URI

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

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

Description

Order type codes are used to identify the types of orders returned by the Order GET and Order SEARCH APIs - sales orders, sales credits, purchase orders and purchase credits. These codes are consistent across all Brightpearl accounts but we use the two letter codes in Order GET responses and require the integer IDs in Order SEARCH requests. This API allows you to convert between the two.

This API does not support ID set filtering - it returns all four types.

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

Example

Request all order types.

Request URI

/order-stock-status/

Response

{
	"response": [
		{
			"id": 1,
			"code": "SO",
			"description": "Sales Order"
		},
		{
			"id": 2,
			"code": "PO",
			"description": "Purchase Order"
		},
		{
			"id": 3,
			"code": "SC",
			"description": "Sales Credit"
		},
		{
			"id": 4,
			"code": "PC",
			"description": "Purchase Credit"
		}
	]
}