Fulfilment Source GET

URI

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

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

Description

The Fulfilment Source resource gives you a breakdown for the requested Product Id Set of Product's which are on hand in your various Warehouse's. It will also provide you with a breakdown of Supplier's of the Product with price breaks.

The one and only argument for this request is a Id Set of Product Id's you wish to obtain Fulfilment Source's for. This Id set is required.

The response of the message split into two parts:

  • availableProducts - Products which either have Supplier information or have some on hand.
  • unavailableProducts - Products with no Supplier information and none on hand.

On Hand: Quantity in stock minus any allocations. So its all stock which you have available to sell.

unavailableProducts is simply a list of Product Id's which are not available for fulfilment.

availableProducts consists of two sections:

  • Suppliers - a map of Supplier Id to the Supplier SKU and the Supplier cost price which consists of:
    • The currency code for the prices.
    • An array of cost points which are the price breaks as defined on the Product for the price list. These consist of
      • Minimum order quantity
      • Price
  • Warehouse's - a map of Warehouse Id to number on hand.

Example

Requesting the Fulfilment Source for Products 1005 to 1010.

Request URI

/fulfilment-source/1005-1010

Response

{
	"response": {
		"availableProducts": {
			"1007": {
				"suppliers": {
					"200": {
						"costPoints": {
							"currencyCode": "GBP",
							"costPoints": [
								{
									"minimum": 1,
									"cost": "19.0000"
								}
							]
						},
						"sku": "gfsd"
					}
				},
				"warehouses": {
					"2": {
						"onHand": 20
					}
				}
			},
			"1008": {
				"suppliers": {
				},
				"warehouses": {
					"2": {
						"onHand": 189
					}
				}
			},
			"1009": {
				"suppliers": {
				},
				"warehouses": {
					"2": {
						"onHand": 6
					}
				}
			},
			"1010": {
				"suppliers": {
					"205": {
						"costPoints": {
							"currencyCode": "GBP",
							"costPoints": [
								{
									"minimum": 500,
									"cost": "21.2100"
								},
								{
									"minimum": 5000,
									"cost": "21.1200"
								}
							]
						},
						"sku": "fgl2132"
					},
					"204": {
						"costPoints": {
							"currencyCode": "GBP",
							"costPoints": [
								{
									"minimum": 1,
									"cost": "45.0000"
								},
								{
									"minimum": 10,
									"cost": "42.0000"
								},
								{
									"minimum": 50,
									"cost": "40.0000"
								}
							]
						},
						"sku": ""
					}
				},
				"warehouses": {
					"2": {
						"onHand": 5
					}
				}
			}
		},
		"unavailableProducts": [
			1005,
			1006
		]
	}
}