Drop-Ship Note GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/order/{ORDER-ID-SET}/goods-note/drop-ship/{DROP-SHIP-NOTE-ID-SET}

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

Description

Returns the details of the drop-ship notes associated with an existing order. The data describes which products and which quantities of those products will be fulfilled by which supplier.

For each supplier that is involved in a drop-ship note, you will need to raise at least one purchase order with that supplier, covering the stock that is to be drop-shipped.

You may query for drop-ship notes in several different ways:

  • By drop-ship note ID: /order/*/goods-note/drop-ship/4
  • By an ID set of drop-ship note IDs: /order/*/goods-note/drop-ship/4-99,1,2
  • By an order ID: /order/55/goods-note/drop-ship/
  • By a combination of order ID and drop-ship note IDs: /order/100-105/goods-note/drop-ship/40-45

Notes:

  • You may supply an asterisk '*' in place of the order ID set. This signifies all orders. If you do this you MUST supply a drop-ship note ID set.
  • Neither the order ID set nor the drop-ship note ID set may exceed 200 IDs.
  • You are not limited to retrieving drop-ship notes for a sales order with this query - you can also fetch the drop-ship notes associated with a purchase if you supply a purchase order ID.

Example 1

Returns the details of the two drop-ship notes associated with order 156

Request URI

/order/156/goods-note/drop-ship

Response

{
	"response": {
		"117": {
			"orderId": 156,
			"purchaseOrderId": 157,
			"supplierId": 235,
			"status": {
				"shippedOn": "2011-08-23T16:10:45.000Z",
				"shipped": true,
				"shippedById": 1
			},
			"orderRows": {
				"486": [
					{
						"productId": 1084,
						"quantity": 1,
						"locationId": 0
					}
				]
			},
			"events": [
				{
					"occured": "2011-08-23T16:10:45.000Z",
					"eventOwnerId": 1,
					"eventCode": "SHS"
				},
				{
					"occured": "2012-07-23T08:21:40.000Z",
					"eventOwnerId": 2,
					"eventCode": "PLA"
				}
			],
			"shipping": {
				"reference": "RM129193-993-H",
				"shippingMethodId": 1
			}
		},
		"118": {
			"orderId": 156,
			"purchaseOrderId": 158,
			"supplierId": 235,
			"status": {
				"shipped": false
			},
			"orderRows": {
				"488": [
					{
						"productId": 1084,
						"quantity": 1,
						"locationId": 0
					}
				]
			},
			"events": [
				{
					"occured": "2012-07-23T08:51:58.000Z",
					"eventOwnerId": 2,
					"eventCode": "PLA"
				}
			]
		}
	}
}

Example 2

Returns the details of drop-ship note ID 118

Request URI

/order/*/goods-note/drop-ship/118

Response

{
	"response": {
		"118": {
			"orderId": 156,
			"purchaseOrderId": 158,
			"supplierId": 235,
			"status": {
				"shipped": false
			},
			"orderRows": {
				"488": [
					{
						"productId": 1084,
						"quantity": 1,
						"locationId": 0
					}
				]
			},
			"events": [
				{
					"occured": "2012-07-23T08:51:58.000Z",
					"eventOwnerId": 2,
					"eventCode": "PLA"
				}
			]
		}
	}
}