GET stocklocations/{stockLocationID}

Returns information about a single Stock Location

Request Information

URI Parameters

NameDescriptionTypeAdditional information
stockLocationID ID of the Stock Location integer Required

Body Parameters

None.

Response Information

Resource Description

Returns information about a single Stock Location

StockLocationModel
NameDescriptionTypeAdditional 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.
WarehouseZone The warehouse zone for the stocklocation WarehouseZoneBaseModel None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 2,
  "PagingInfo": {
    "PageSize": 1,
    "Page": 1
  },
  "TotalPages": 1,
  "Data": [
    {
      "StockLocationID": 1,
      "StockLocationReference": "A-1",
      "Warehouse": {
        "WarehouseName": "My Warehouse",
        "WarehouseGuid": "55b95594-f27c-4f81-b17f-db7fdee298dd",
        "WarehouseID": 1
      },
      "StockLocationType": "Pickbin",
      "KeepProduct": false,
      "LocationOrder": 1,
      "IsEmpty": false,
      "HasProducts": false
    },
    {
      "StockLocationID": 2,
      "StockLocationReference": "Bulk1",
      "Warehouse": {
        "WarehouseName": "My Warehouse",
        "WarehouseGuid": "ec89d5e4-fac9-4013-8b5e-c5ae09a361b3",
        "WarehouseID": 1
      },
      "StockLocationType": "BulkLocation",
      "KeepProduct": true,
      "LocationOrder": 199,
      "IsEmpty": false,
      "HasProducts": false
    }
  ]
}

application/xml, text/xml

Sample:
<PagedStockLocationModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TotalItems>2</TotalItems>
  <PagingInfo>
    <PageSize>1</PageSize>
    <Page>1</Page>
  </PagingInfo>
  <TotalPages>1</TotalPages>
  <Data>
    <StockLocationModel>
      <StockLocationID>1</StockLocationID>
      <StockLocationReference>A-1</StockLocationReference>
      <LocationOrder>1</LocationOrder>
      <Warehouse>
        <WarehouseName>My Warehouse</WarehouseName>
        <WarehouseGuid>55b95594-f27c-4f81-b17f-db7fdee298dd</WarehouseGuid>
        <WarehouseID>1</WarehouseID>
      </Warehouse>
      <StockLocationType>Pickbin</StockLocationType>
      <KeepProduct>false</KeepProduct>
      <IsEmpty>false</IsEmpty>
      <HasProducts>false</HasProducts>
    </StockLocationModel>
    <StockLocationModel>
      <StockLocationID>2</StockLocationID>
      <StockLocationReference>Bulk1</StockLocationReference>
      <LocationOrder>199</LocationOrder>
      <Warehouse>
        <WarehouseName>My Warehouse</WarehouseName>
        <WarehouseGuid>ec89d5e4-fac9-4013-8b5e-c5ae09a361b3</WarehouseGuid>
        <WarehouseID>1</WarehouseID>
      </Warehouse>
      <StockLocationType>BulkLocation</StockLocationType>
      <KeepProduct>true</KeepProduct>
      <IsEmpty>false</IsEmpty>
      <HasProducts>false</HasProducts>
    </StockLocationModel>
  </Data>
</PagedStockLocationModel>