Product GET

URI

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

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

Description

id: The unique ID of the product

brandId: The ID of the brand the product belongs to.

collectionId: The ID of collection the product belongs to.

productTypeId: The ID of the Product Type.

identity: Details such information as the SKU, ISBN, EAN and UPC of the product

productGroupId: The ID of which this product is a group of.

featured: Products can be flagged as featured if they are of particular significance.

stock: Details information pertinent to stock/inventory i.e. is the product stock tracked

financialDetails: Details financial information of the product.

salesChannels: Details information pertinent to a sales channel. A sales channel is a means of selling the product. The default sales channel is the Brightpearl Ecommerce store, other channels can be obtain by the use of the query parameter contextChannelId (value channel id).Default channel information includes details such as the name of the channel, product name, product condition, categories and translated descriptions/short descriptions of the product. For other channel the sales channel shall also include availableToSellOnChannel and sellWhenNoStock.

composition: Details the composition of the product i.e. is a bundle

bundleComponents: Details the component products of the bundle.

bundleComponent Fields Description
productId the productId of the bundle component product.
productQuantity the quantity of bundle component product.
composition the composition of the bundle component product.

variations: This section is for information regarding the variations for a product.

customFields: A map of custom field Code to value. (Optional)

nullCustomFields: A List of custom field Codes which currently have a value of Null. (Optional)

Note: The ID set in the request URI is not optional. It is not possible to get all Products in a single call. The request can be limited to the context of a sales channel by the use of the query parameter contextChannelId (value channel id); only products assigned to this channel shall be returned.The Product OPTIONS message will programmatically explain how to download all Products in multiple calls.

nominalCodeStock: The Account Code / Nominal code for Stock

nominalCodePurchases: The Account Code / Nominal code for Purchases

nominalCodeSales: The Account Code / Nominal code for Sales

seasonIds: The IDs of the seasons this product has

createdOn, updatedOn: The date the product was created and last updated

reporting: For the purposes of reporting a product can only appear against one of each of the following:

  • categoryId Product category
  • subcategoryId Product category which is a child of categoryId
  • seasonId Season

Note: To include customFields and nullCustomFields please see Include Optional Sections.

primarySupplierId: The ID of the primary supplier

status: A code representing the lifecycle status of the product (eg. LIVE or ARCHIVED)

salesPopupMessage: A message which will be displayed to the user when this product used in a sale

warehousePopupMessage: A message which will be displayed to the user when this product handled by the warehouse

Example 1

Retrieve products with ID 1008

Request URI

/product/1008

Response

{
	"response": [
		{
			"id": 1008,
			"brandId": 74,
			"collectionId": 32,
			"productTypeId": 1,
			"nominalCodeStock": "1200",
			"nominalCodePurchases": "5002",
			"nominalCodeSales": "4000",
			"seasonIds": [
			],
			"identity": {
				"sku": "SKU0001",
				"isbn": "0-684-84328-5",
				"ean": "ISNB0-9712345-",
				"upc": "5778400001",
				"barcode": "738737638"
			},
			"productGroupId": 0,
			"featured": false,
			"stock": {
				"stockTracked": true,
				"weight": {
					"magnitude": 0.7
				},
				"dimensions": {
					"length": 2,
					"height": 12,
					"width": 5,
					"volume": 120
				}
			},
			"financialDetails": {
				"taxCode": {
					"id": 7,
					"code": "T20"
				}
			},
			"salesChannels": [
				{
					"salesChannelName": "Brightpearl",
					"productName": "Product B",
					"productCondition": "new",
					"categories": [
						{
							"categoryCode": "276"
						},
						{
							"categoryCode": "295"
						}
					],
					"description": {
						"languageCode": "en",
						"text": "

Some description

", "format": "HTML_FRAGMENT" }, "shortDescription": { "languageCode": "en", "text": "

Some short description

", "format": "HTML_FRAGMENT" } } ], "composition": { "bundle": false }, "variations": [ { "optionId": 1, "optionName": "Colour", "optionValueId": 1, "optionValue": "Black" }, { "optionId": 3, "optionName": "Colour", "optionValueId": 9, "optionValue": "Black" } ], "warehouses": { "2": { "defaultLocationId": 5, "reorderLevel": 1, "reorderQuantity": 0 }, "3": { "defaultLocationId": 0, "reorderLevel": 1, "reorderQuantity": 1 } }, "createdOn": "2015-01-08T17:57:18.000Z", "updatedOn": "2015-04-01T13:17:58.000Z", "reporting": { "categoryId": 353, "subcategoryId": 369, "seasonId": 2 }, "primarySupplierId": 202, "status": "LIVE", "salesPopupMessage": "Offer the extended warranty" } ] }

Example 2

Example of the Product GET when using query parameter contextChannelId

Request URI

/product/1008?contextChannelId=5

Response

{
	"response": [
		{
			"id": 1008,
			"brandId": 74,
			"collectionId": 32,
			"productTypeId": 1,
			"nominalCodeStock": "1200",
			"nominalCodePurchases": "5002",
			"nominalCodeSales": "4000",
			"seasonIds": [
				1
			],
			"identity": {
				"sku": "SKU0001",
				"isbn": "0-684-84328-5",
				"ean": "ISNB0-9712345-",
				"upc": "5778400001",
				"barcode": "738737638"
			},
			"productGroupId": 0,
			"featured": false,
			"stock": {
				"stockTracked": true,
				"weight": {
					"magnitude": 0.7
				},
				"dimensions": {
					"length": 2,
					"height": 12,
					"width": 5,
					"volume": 120
				}
			},
			"financialDetails": {
				"taxCode": {
					"id": 7,
					"code": "T20"
				}
			},
			"salesChannels": [
				{
					"id": 5,
					"salesChannelName": "My Magento Store",
					"productName": "Product B",
					"productCondition": "new",
					"categories": [
						{
							"categoryCode": "276"
						},
						{
							"categoryCode": "295"
						}
					],
					"description": {
						"languageCode": "en",
						"text": "

Some description

", "format": "HTML_FRAGMENT" }, "shortDescription": { "languageCode": "en", "text": "

Some short description

", "format": "HTML_FRAGMENT" }, "availableToSellOnChannel": true, "sellWhenNoStock": false } ], "composition": { "bundle": false }, "variations": [ { "optionId": 1, "optionName": "Colour", "optionValueId": 1, "optionValue": "Black" }, { "optionId": 3, "optionName": "Colour", "optionValueId": 9, "optionValue": "Black" } ], "warehouses": { "2": { "defaultLocationId": 5, "reorderLevel": 1, "reorderQuantity": 0 }, "3": { "defaultLocationId": 0, "reorderLevel": 1, "reorderQuantity": 1 } }, "createdOn": "2015-01-08T17:57:18.000Z", "updatedOn": "2015-04-01T13:17:58.000Z", "reporting": { }, "primarySupplierId": 202, "status": "LIVE", "salesPopupMessage": "Offer the extended warranty" } ] }

Example 3

Example of the Product GET when requesting to include customFields and nullCustomFields

Request URI

/product/1018?includeOptional=customFields,nullCustomFields

Response

{
	"response": [
		{
			"id": 1018,
			"brandId": 76,
			"collectionId": 32,
			"productTypeId": 1,
			"nominalCodeStock": "1200",
			"nominalCodePurchases": "5002",
			"nominalCodeSales": "4000",
			"seasonIds": [
				1,
				2
			],
			"identity": {
				"sku": "",
				"barcode": ""
			},
			"featured": false,
			"stock": {
				"stockTracked": true,
				"weight": {
					"magnitude": 0.7
				},
				"dimensions": {
					"length": 2,
					"height": 12,
					"width": 5,
					"volume": 120
				}
			},
			"financialDetails": {
				"taxable": false,
				"taxCode": {
					"id": 7,
					"code": "T20"
				}
			},
			"salesChannels": [
				{
					"salesChannelName": "Brightpearl",
					"productName": "Gibson Explorer",
					"productCondition": "new",
					"categories": [
						{
							"categoryCode": "276"
						}
					],
					"description": {
						"languageCode": "en",
						"text": "",
						"format": "HTML_FRAGMENT"
					},
					"shortDescription": {
						"languageCode": "en",
						"text": "",
						"format": "HTML_FRAGMENT"
					}
				}
			],
			"composition": {
				"bundle": false
			},
			"customFields": {
				"PCF_COLOR": {
					"id": 6,
					"value": "BK"
				},
				"PCF_FRETS": 24,
				"PCF_SCALE": 23
			},
			"nullCustomFields": [
				"PCF_FLOYDROS",
				"PCF_PICKUPS",
				"PCF_DETAIL",
				"PCF_MODELYEA"
			],
			"warehouses": {
				"2": {
					"defaultLocationId": 5,
					"reorderLevel": 1,
					"reorderQuantity": 0
				},
				"3": {
					"defaultLocationId": 0,
					"reorderLevel": 1,
					"reorderQuantity": 1
				}
			},
			"createdOn": "2015-01-08T17:57:18.000Z",
			"updatedOn": "2015-04-01T13:17:58.000Z",
			"reporting": {
				"categoryId": 631,
				"seasonId": 7
			},
			"status": "LIVE",
			"salesPopupMessage": "Offer the extended warranty"
		}
	]
}

Example 4

Example of the Product GET when the product requested is a bundle

Request URI

/product/1837

Response

{
	"response": [
		{
			"id": 1837,
			"brandId": 75,
			"collectionId": 32,
			"productTypeId": 1,
			"nominalCodeStock": "1200",
			"nominalCodePurchases": "5002",
			"nominalCodeSales": "4000",
			"seasonIds": [
				1,
				2,
				3
			],
			"identity": {
				"sku": "",
				"barcode": ""
			},
			"featured": false,
			"stock": {
				"stockTracked": true,
				"weight": {
					"magnitude": 0.7
				},
				"dimensions": {
					"length": 2,
					"height": 12,
					"width": 5,
					"volume": 120
				}
			},
			"financialDetails": {
				"taxable": false,
				"taxCode": {
					"id": 10,
					"code": "T20"
				}
			},
			"salesChannels": [
				{
					"salesChannelName": "Brightpearl",
					"productName": "bundleProduct2",
					"productCondition": "new",
					"categories": [
						{
							"categoryCode": "276"
						}
					],
					"description": {
						"languageCode": "en",
						"text": "",
						"format": "HTML_FRAGMENT"
					},
					"shortDescription": {
						"languageCode": "en",
						"text": "",
						"format": "HTML_FRAGMENT"
					}
				}
			],
			"composition": {
				"bundle": true,
				"bundleComponents": [
					{
						"productId": 1834,
						"productQuantity": 1
					},
					{
						"productId": 1835,
						"productQuantity": 1
					}
				]
			},
			"warehouses": {
				"2": {
					"defaultLocationId": 5,
					"reorderLevel": 1,
					"reorderQuantity": 0
				},
				"3": {
					"defaultLocationId": 0,
					"reorderLevel": 1,
					"reorderQuantity": 1
				}
			},
			"createdOn": "2015-01-08T17:57:18.000Z",
			"updatedOn": "2015-04-01T13:17:58.000Z",
			"reporting": {
				"subcategoryId": 100,
				"seasonId": 4
			},
			"status": "LIVE",
			"salesPopupMessage": "Offer the extended warranty"
		}
	]
}