PUT stocklocations/{stockLocationID}
Update a Stock Location by ID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
stockLocationID | The ID of the Stock Location to update | integer | Required |
Body Parameters
The Stock Location object
StockLocationBasicUpdateModel
Name | Description | Type | Additional information |
---|---|---|---|
StockLocationReference | The Stock Location Reference | string | Required |
WarehouseZoneIDType | The warehouse Zone for the stock location | WarehouseZoneIDTypeModel | None. |
StockLocationAisleIDType | The aisle for the stock location | StockLocationAisleIDTypeModel | None. |
StockLocationLevelIDType | The level for the stock location | StockLocationLevelIDTypeModel | None. |
StockLocationType | The type of the stock location. I.e. Pickbin, Bulk Location.. | StockLocationType | None. |
KeepProduct | Keep product determines whether when the stock location inventory for a product reaches 0 whether the stock location will retain the product or it will be removed. | boolean | None. |
LocationOrder | This is the priority of the stock location. A location order of 1 will be picked before 10. | integer | None. |
Request Formats
application/json, text/json
Sample:
{ "StockLocationReference": "A-1", "StockLocationAisleIDType": { "IDType": "Name", "Value": "Aisle A" }, "StockLocationLevelIDType": { "IDType": "Name", "Value": "Level 1" }, "StockLocationType": "Pickbin", "KeepProduct": true, "LocationOrder": 1 }
application/xml, text/xml
Sample:
<StockLocationBasicUpdateModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <StockLocationReference>A-1</StockLocationReference> <StockLocationAisleIDType> <IDType>Name</IDType> <Value>Aisle A</Value> </StockLocationAisleIDType> <StockLocationLevelIDType> <IDType>Name</IDType> <Value>Level 1</Value> </StockLocationLevelIDType> <StockLocationType>Pickbin</StockLocationType> <KeepProduct>true</KeepProduct> <LocationOrder>1</LocationOrder> </StockLocationBasicUpdateModel>
Response Information
Resource Description
Update a Stock Location by ID
StockLocationModelName | Description | Type | Additional information |
---|---|---|---|
StockLocationID | The ID for the StockLocation | integer | Required |
StockLocationReference | The reference for the stock location. | string | None. |
Warehouse | The warehouse for the stocklocation | WarehouseBaseModel | None. |
StockLocationType | The type of the stock location. I.e. Pickbin, Bulk Location.. | StockLocationType | None. |
KeepProduct | Keep product determines whether when the stock location inventory for a product reaches 0 whether the stock location will retain the product or it will be removed. This is unavailable for accounts without multiple stock locations. | boolean | None. |
LocationOrder | This is the priority of the stock location. A location order of 1 will be picked before 10. | integer | None. |
IsEmpty | This is whether the stock locations contains any products. | boolean | None. |
HasProducts | This is whether the stock location has products associated to it. | boolean | None. |
IsSystem | This indicates if the stock location has been created automatically by StoreFeeder rather than by the user | boolean | None. |
IsQuarantined | This indicates if the stock location's stock is used when calculating the sellable stock that is sent to channel | boolean | None. |
WarehouseZone | The warehouse zone for the stocklocation | WarehouseZoneBaseModel | None. |
Aisle | The warehouse aisle that the location is located | StockLocationAisleModel | None. |
Level | The level | StockLocationLevelModel | None. |
Response Formats
application/json, text/json
Sample:
{ "StockLocationID": 1, "StockLocationReference": "A-1", "Warehouse": { "WarehouseName": "My Warehouse", "WarehouseGuid": "030b3375-cd78-4803-a097-58f86cb16fcd", "WarehouseID": 1 }, "StockLocationType": "Pickbin", "KeepProduct": true, "LocationOrder": 1, "IsEmpty": false, "HasProducts": false, "IsSystem": false, "IsQuarantined": false }
application/xml, text/xml
Sample:
<StockLocationModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <StockLocationID>1</StockLocationID> <StockLocationReference>A-1</StockLocationReference> <LocationOrder>1</LocationOrder> <Warehouse> <WarehouseName>My Warehouse</WarehouseName> <WarehouseGuid>030b3375-cd78-4803-a097-58f86cb16fcd</WarehouseGuid> <WarehouseID>1</WarehouseID> </Warehouse> <StockLocationType>Pickbin</StockLocationType> <IsQuarantined>false</IsQuarantined> <KeepProduct>true</KeepProduct> <IsEmpty>false</IsEmpty> <HasProducts>false</HasProducts> <IsSystem>false</IsSystem> </StockLocationModel>