Order Shipping Status GET

URI

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

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

Description

Order shipping status codes indicate the shipping 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. This API allows you to convert between the two.

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

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

Example

Request all shipping status codes.

Request URI

/order-shipping-status/

Response

{
	"response": [
		{
			"id": 1,
			"code": "NST",
			"description": "No stock tracked products on order"
		},
		{
			"id": 2,
			"code": "SNS",
			"description": "Stock not shipped"
		},
		{
			"id": 3,
			"code": "SPS",
			"description": "Stock part shipped"
		},
		{
			"id": 4,
			"code": "ASS",
			"description": "All stock shipped"
		}
	]
}