Price List GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/product-service/price-list/{ID-SET}

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

Description

The message returns Price Lists. This message takes an optional ID Set to allow you to request particular Price Lists.

Key Fields:

  • priceListTypeCode: This specifies whether the Price List is a SELL or BUY .
  • gross: Indicates whether prices should be displayed as gross (inclusive of tax).

Example 1

Requesting all Price Lists.

Request URI

/price-list/

Response

{
	"response": [
		{
			"id": 0,
			"name": {
				"languageCode": "en",
				"text": "Cost",
				"format": "PLAINTEXT"
			},
			"code": "COST",
			"currencyCode": "GBP",
			"currencySymbol": "£",
			"currencyId": 1,
			"priceListTypeCode": "BUY",
			"gross": false
		},
		{
			"id": 1,
			"name": {
				"languageCode": "en",
				"text": "Wholesale",
				"format": "PLAINTEXT"
			},
			"code": "WHOLE",
			"currencyCode": "GBP",
			"currencySymbol": "£",
			"currencyId": 1,
			"priceListTypeCode": "SELL",
			"gross": true
		},
		{
			"id": 2,
			"name": {
				"languageCode": "en",
				"text": "Retail",
				"format": "PLAINTEXT"
			},
			"code": "RETAIL",
			"currencyCode": "GBP",
			"currencySymbol": "£",
			"currencyId": 1,
			"priceListTypeCode": "SELL",
			"gross": true
		}
	]
}

Example 2

Requesting Price List using an Id Set.

Request URI

/price-list/1,2

Response

{
	"response": [
		{
			"id": 1,
			"name": {
				"languageCode": "en",
				"text": "Wholesale",
				"format": "PLAINTEXT"
			},
			"code": "WHOLE",
			"currencyCode": "GBP",
			"currencySymbol": "£",
			"currencyId": 1,
			"priceListTypeCode": "SELL",
			"gross": true
		},
		{
			"id": 2,
			"name": {
				"languageCode": "en",
				"text": "Retail",
				"format": "PLAINTEXT"
			},
			"code": "RETAIL",
			"currencyCode": "GBP",
			"currencySymbol": "£",
			"currencyId": 1,
			"priceListTypeCode": "SELL",
			"gross": true
		}
	]
}