Goods-Out Note POST

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/order/{ID}/goods-note/goods-out

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

Description

This messages enables you to create Goods-Out Notes for a given Order.

A Goods-Out Note will be created for each Warehouse you specify in the request i.e. if you use 4 warehouses then 4 Goods-Out Notes will be created.

You can can keep creating new Goods-Out Notes for an Order until all products for that order have been fulfiled. This enables you to part fulfill an Order if required.

Field Specifics:

  • warehouses: Contains information about the stock to be shipped from each warehouse
    • releaseDate: The time when the stock is to be released from your stock control system.
    • warehouseId: The ID of the warehouse
    • transfer: Indicates whether this Goods-Out Note is an External Transfer between Warehouses.
    • products: Indicates which products, and in what quantity, are to be included on the Goods-Out Note
  • priority: Indicates whether this Goods-Out Note should be a priority.
  • shippingMethodId: Specifies the Id for the Shipping Method that will be used to ship the Goods-Out Notes

Example 1

Creating a Goods-Out Note for Order 2 - this order contains two products that we are fulfilling from a single warehouse.

The Goods-Out Note message contain a single entry for 'warehouses' as we are only fulfilling from Warehouse 2. Note that this warehouse entry contains:

  • Two 'products' entries, each specifying the productId, the quantity we are fulfilling and the sales order row that this product relates to.
  • The 'transfer' field set to false, as this is not an external transfer we are creating.
  • The 'priority' field set to false as this Goods-Out Note is not a priority for our Warehouse staff.

The response of this message is the Id of the Goods-Out Note we have just created.

Request URI

/order/2/goods-note/goods-out

Request body

{
	"warehouses": [
		{
			"releaseDate": "2011-07-15T10:39:40.000+01:00",
			"warehouseId": 2,
			"transfer": false,
			"products": [
				{
					"productId": 1008,
					"salesOrderRowId": 4,
					"quantity": 5
				},
				{
					"productId": 1007,
					"salesOrderRowId": 5,
					"quantity": 14
				}
			]
		}
	],
	"priority": false,
	"shippingMethodId": 4,
	"labelUri": "http://somedomain.com/packinglabel/image.jpg"
}

Response

{
	"response": [
		10
	]
}

Example 2

In this example we are creating Goods-Out Notes for Order 5. There will be two Goods-Out Notes created as we are fulfilling stock from two Warehouses. The label url is optional, and in this case we are not using one, so the field is left blank.

Request URI

/order/5/goods-note/goods-out

Request body

{
	"warehouses": [
		{
			"releaseDate": "2011-07-15T10:51:51.000+01:00",
			"warehouseId": 3,
			"transfer": false,
			"products": [
				{
					"productId": 1008,
					"salesOrderRowId": 6,
					"quantity": 5
				},
				{
					"productId": 1009,
					"salesOrderRowId": 8,
					"quantity": 4
				}
			]
		},
		{
			"releaseDate": "2011-07-15T10:51:51.000+01:00",
			"warehouseId": 2,
			"transfer": false,
			"products": [
				{
					"productId": 1007,
					"salesOrderRowId": 7,
					"quantity": 3
				}
			]
		}
	],
	"priority": true,
	"shippingMethodId": 5,
	"labelUri": ""
}

Response

{
	"response": [
		11,
		12
	]
}