Stock Transfer POST

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/warehouse/{warehouseId}/stock-transfer

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

Description

This method enables you to create stock transfers between your warehouses.

Products can be added and the transfer processed using either the Brightpearl admin interface or the external transfer POST API message, but not both.

URI Parameters

There is one URI parameter:

  • Source Warehouse ID - The ID of the warehouse from which the transfer originates.
Body Parameters

There are two body parameters:

Field Description Required
targetWarehouseId The ID of the Warehouse to which the transfer is to go. Yes
reference A reference for the transfer. Not required but if specified, must be unique. No

The response will be the ID of the Stock Transfer created.

Example

Request URI

/warehouse/2/stock-transfer

Request body

{
	"targetWarehouseId": 3,
	"reference": "unique-reference"
}

Response

{
	"response": 60
}