POST stocklocations

Create a new Stock Location

Request Information

URI Parameters

None.

Body Parameters

The Stock Location object that you want to create or update

Collection of StockLocationUpdateModel
NameDescriptionTypeAdditional information
StockLocationIDType The ID for the StockLocation you want to update. Leave null to create new StockLocationIDTypeModel None.
StockLocationReference The reference for the stock location. string Required
WarehouseIDType The warehouse for the stock location WarehouseIDTypeModel None.
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.
Quarantined This is used to mark the Stock Location as Quarantined which means its stock will not be used in calculating the inventory sent to channel boolean None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "StockLocationIDType": {
      "IDType": "ID",
      "Value": "2"
    },
    "StockLocationReference": "A-1",
    "WarehouseIDType": {
      "IDType": "ID",
      "Value": "1"
    },
    "StockLocationAisleIDType": {
      "IDType": "Name",
      "Value": "Aisle A"
    },
    "StockLocationLevelIDType": {
      "IDType": "Name",
      "Value": "Level 1"
    },
    "StockLocationType": "Pickbin",
    "KeepProduct": true,
    "LocationOrder": 1,
    "Quarantined": true
  },
  {
    "StockLocationIDType": {
      "IDType": "StockLocationReference",
      "Value": "SL-1",
      "Warehouse": {
        "IDType": "Name",
        "Value": "Warehouse 1"
      }
    },
    "StockLocationReference": "SL-1 Updated",
    "WarehouseIDType": {
      "IDType": "Name",
      "Value": "Default Warehouse"
    },
    "WarehouseZoneIDType": {
      "IDType": "ID",
      "Value": "1"
    },
    "StockLocationAisleIDType": {
      "IDType": "ID",
      "Value": "1"
    },
    "StockLocationLevelIDType": {
      "IDType": "ID",
      "Value": "1"
    },
    "StockLocationType": "Pickbin",
    "KeepProduct": true,
    "LocationOrder": 4,
    "Quarantined": false
  },
  {
    "StockLocationIDType": {
      "IDType": "ID",
      "Value": "10"
    },
    "StockLocationReference": "A-1",
    "WarehouseIDType": {
      "IDType": "ID",
      "Value": "61"
    },
    "WarehouseZoneIDType": {
      "IDType": "Name",
      "Value": "Wz1"
    },
    "StockLocationAisleIDType": {
      "IDType": "Name",
      "Value": "Aisle B"
    },
    "StockLocationLevelIDType": {
      "IDType": "Name",
      "Value": "Level 2"
    },
    "StockLocationType": "BulkLocation",
    "KeepProduct": false,
    "LocationOrder": 10,
    "Quarantined": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfStockLocationUpdateModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StockLocationUpdateModel>
    <StockLocationIDType>
      <IDType>ID</IDType>
      <Value>2</Value>
    </StockLocationIDType>
    <StockLocationReference>A-1</StockLocationReference>
    <WarehouseIDType>
      <IDType>ID</IDType>
      <Value>1</Value>
    </WarehouseIDType>
    <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>
    <Quarantined>true</Quarantined>
  </StockLocationUpdateModel>
  <StockLocationUpdateModel>
    <StockLocationIDType>
      <IDType>StockLocationReference</IDType>
      <Value>SL-1</Value>
      <Warehouse>
        <IDType>Name</IDType>
        <Value>Warehouse 1</Value>
      </Warehouse>
    </StockLocationIDType>
    <StockLocationReference>SL-1 Updated</StockLocationReference>
    <WarehouseIDType>
      <IDType>Name</IDType>
      <Value>Default Warehouse</Value>
    </WarehouseIDType>
    <WarehouseZoneIDType>
      <IDType>ID</IDType>
      <Value>1</Value>
    </WarehouseZoneIDType>
    <StockLocationAisleIDType>
      <IDType>ID</IDType>
      <Value>1</Value>
    </StockLocationAisleIDType>
    <StockLocationLevelIDType>
      <IDType>ID</IDType>
      <Value>1</Value>
    </StockLocationLevelIDType>
    <StockLocationType>Pickbin</StockLocationType>
    <KeepProduct>true</KeepProduct>
    <LocationOrder>4</LocationOrder>
    <Quarantined>false</Quarantined>
  </StockLocationUpdateModel>
  <StockLocationUpdateModel>
    <StockLocationIDType>
      <IDType>ID</IDType>
      <Value>10</Value>
    </StockLocationIDType>
    <StockLocationReference>A-1</StockLocationReference>
    <WarehouseIDType>
      <IDType>ID</IDType>
      <Value>61</Value>
    </WarehouseIDType>
    <WarehouseZoneIDType>
      <IDType>Name</IDType>
      <Value>Wz1</Value>
    </WarehouseZoneIDType>
    <StockLocationAisleIDType>
      <IDType>Name</IDType>
      <Value>Aisle B</Value>
    </StockLocationAisleIDType>
    <StockLocationLevelIDType>
      <IDType>Name</IDType>
      <Value>Level 2</Value>
    </StockLocationLevelIDType>
    <StockLocationType>BulkLocation</StockLocationType>
    <KeepProduct>false</KeepProduct>
    <LocationOrder>10</LocationOrder>
    <Quarantined>true</Quarantined>
  </StockLocationUpdateModel>
</ArrayOfStockLocationUpdateModel>

Response Information

Resource Description

Create a new Stock Location

StockLocationUpdateModelCollectionResponse
NameDescriptionTypeAdditional information
TotalItemsProcessed integer None.
Successful integer None.
Failed integer None.
Responses Collection of StockLocationUpdateModelResponse None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalItemsProcessed": 2,
  "Successful": 1,
  "Failed": 1,
  "Responses": [
    {
      "Update": {
        "StockLocationIDType": {
          "IDType": "ID",
          "Value": "2"
        },
        "StockLocationReference": "A1",
        "WarehouseIDType": {
          "IDType": "Name",
          "Value": "Default Warehouse"
        },
        "WarehouseZoneIDType": {
          "IDType": "Name",
          "Value": "Wz1"
        },
        "StockLocationAisleIDType": {
          "IDType": "Name",
          "Value": "Aisle A"
        },
        "StockLocationLevelIDType": {
          "IDType": "Name",
          "Value": "Level 1"
        },
        "StockLocationType": "Pickbin",
        "KeepProduct": true,
        "LocationOrder": 1,
        "Quarantined": false
      },
      "Success": false,
      "Error": "Warehouse does not exist or you do not have permission to access it."
    },
    {
      "Update": {
        "StockLocationIDType": {
          "IDType": "ID",
          "Value": "2"
        },
        "StockLocationReference": "A-1",
        "WarehouseIDType": {
          "IDType": "ID",
          "Value": "1"
        },
        "WarehouseZoneIDType": {
          "IDType": "Name",
          "Value": "Wz1"
        },
        "StockLocationAisleIDType": {
          "IDType": "Name",
          "Value": "Aisle A"
        },
        "StockLocationLevelIDType": {
          "IDType": "Name",
          "Value": "Level 1"
        },
        "StockLocationType": "Pickbin",
        "KeepProduct": true,
        "LocationOrder": 1,
        "Quarantined": true
      },
      "StockLocationID": 2,
      "Success": true
    }
  ]
}