Product Price GET

URI

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

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

Description

This method allows you to retrieve prices for products.

Usage:

  • You must specify an ID Set of product IDs you wish to get the prices for.
  • You may optionally specify an ID set of price list Ids you wish to filter by.
There is a request limit imposed on this message (currently set at 200) so if you wish to retrieve prices for a large number of products use the OPTIONS method.

Returns the product ID and array of associated priceLists.

productId: The Id of the product.

priceLists: The priceLists indicates attributes of the price list such as the priceListId, currencyCode and the quantityPrice map.

currencyCode Currency code of the prices.

sku The product's SKU for the price list.

quantityPrice: Maps breaks to prices.

  • All breaks must have a mapped price.
  • If there are no valid breaks the list will be returned with an empty map.
  • Each break will be unique.

Example 1

Requesting all product prices for product 1010.

Request URI

/product-price/1010

Response

{
	"response": [
		{
			"productId": 1010,
			"priceLists": [
				{
					"priceListId": 0,
					"currencyCode": "GBP",
					"currencyId": 1,
					"sku": "MPP-12455",
					"quantityPrice": {
						"1": "10",
						"5": "9.555",
						"15": "9",
						"25": "8",
						"50": "7.5",
						"200": "7"
					}
				},
				{
					"priceListId": 1,
					"currencyCode": "GBP",
					"currencyId": 1,
					"sku": "MUH-71823",
					"quantityPrice": {
						"1": "12",
						"100": "11",
						"1000": "10",
						"5000": "9.5"
					}
				},
				{
					"priceListId": 2,
					"currencyCode": "GBP",
					"currencyId": 1,
					"quantityPrice": {
						"1": "12.5000",
						"5": "12.3333",
						"25": "11.6667",
						"50": "12.3333",
						"150": "11.6667",
						"250": "10.8333"
					}
				}
			]
		}
	]
}

Example 2

Requesting all the product prices for products 1001 to 1005.

Request URI

/product-price/1001-1005/

Response

{
	"response": [
		{
			"productId": 1001,
			"priceLists": [
				{
					"priceListId": 0,
					"currencyCode": "GBP",
					"currencyId": 1,
					"sku": "MUH-71823",
					"quantityPrice": {
						"1": "5.00"
					}
				},
				{
					"priceListId": 1,
					"currencyCode": "GBP",
					"quantityPrice": {
						"1": "44"
					}
				}
			]
		},
		{
			"productId": 1003,
			"priceLists": [
				{
					"priceListId": 0,
					"currencyCode": "GBP",
					"currencyId": 1,
					"quantityPrice": {
						"1": "4.0444"
					}
				},
				{
					"priceListId": 1,
					"currencyCode": "GBP",
					"currencyId": 1,
					"sku": "MXC-87234",
					"quantityPrice": {
						"1": "22"
					}
				}
			]
		},
		{
			"productId": 1002,
			"priceLists": [
				{
					"priceListId": 0,
					"currencyCode": "GBP",
					"currencyId": 1,
					"quantityPrice": {
						"1": "30.3333"
					}
				},
				{
					"priceListId": 1,
					"currencyCode": "GBP",
					"currencyId": 1,
					"quantityPrice": {
						"1": "3.000"
					}
				}
			]
		},
		{
			"productId": 1005,
			"priceLists": [
				{
					"priceListId": 0,
					"currencyCode": "GBP",
					"currencyId": 1,
					"sku": "NHA-73641",
					"quantityPrice": {
						"1": "1.00"
					}
				},
				{
					"priceListId": 1,
					"currencyCode": "GBP",
					"currencyId": 1,
					"quantityPrice": {
						"1": "0"
					}
				}
			]
		},
		{
			"productId": 1004,
			"priceLists": [
				{
					"priceListId": 0,
					"currencyCode": "GBP",
					"currencyId": 1,
					"quantityPrice": {
						"1": "0.00"
					}
				},
				{
					"priceListId": 1,
					"currencyCode": "GBP",
					"currencyId": 1,
					"quantityPrice": {
						"1": "0"
					}
				}
			]
		}
	]
}

Example 3

Requesting all product prices for product 1010 on price lists 1 to 2.

Request URI

/product-price/1010/price-list/1,2

Response

{
	"response": [
		{
			"productId": 1010,
			"priceLists": [
				{
					"priceListId": 1,
					"currencyCode": "GBP",
					"currencyId": 1,
					"quantityPrice": {
						"1": "10",
						"5": "9.555",
						"15": "9",
						"25": "8",
						"50": "7.5",
						"200": "7"
					}
				},
				{
					"priceListId": 2,
					"currencyCode": "GBP",
					"currencyId": 1,
					"quantityPrice": {
						"1": "12",
						"100": "11",
						"1000": "10",
						"5000": "9.5"
					}
				}
			]
		}
	]
}