GetLocationsByQuery

This function is used to get warehouse locations. You can specify a filter so that, for instance, only locations in a certain aisle are returned. A possible use of this function is to display a map of the warehouse in your own system.

For more information about how locations work in Ongoing WMS, see our manual.

Tags: GetLocationsByQuery, GetLocationsQuery, AdvancedGetLocationsAutomation, GetLocationsByQueryResponse, GetLocationsResult, Location_GetLocations, Aisle_GetLocations, LocationType_GetLocations, Dimensions_GetLocations, Zone_GetLocations

Request XML

POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/GetLocationsByQuery"

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLocationsByQuery xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Query>
        <AisleName>string</AisleName>
        <AisleId>int</AisleId>
        <LocationTypeId>int</LocationTypeId>
        <OnlyFreeLocations>boolean</OnlyFreeLocations>
        <LocationId>int</LocationId>
        <LocationName>string</LocationName>
        <LocationIds>
          <int>int</int>
          <int>int</int>
        </LocationIds>
        <MaxLocationsToGet>int</MaxLocationsToGet>
        <LocationIdFrom>int</LocationIdFrom>
        <WarehouseId>int</WarehouseId>
        <ZoneId>int</ZoneId>
        <ZoneName>string</ZoneName>
        <Advanced>
          <SortType>Standard or LocationPickingPriorityAscending</SortType>
        </Advanced>
      </Query>
    </GetLocationsByQuery>
  </soap:Body>
</soap:Envelope>

Request specification

Response XML

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLocationsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
      <GetLocationsByQueryResult>
        <Locations>
          <Location_GetLocations>
            <LocationId>int</LocationId>
            <LocationName>string</LocationName>
            <PositionX>int</PositionX>
            <PositionY>int</PositionY>
            <Aisle>
              <AisleId>int</AisleId>
              <AisleName>string</AisleName>
              <Zone>
                <ZoneId>int</ZoneId>
                <ZoneName>string</ZoneName>
                <WarehouseId>int</WarehouseId>
              </Zone>
            </Aisle>
            <LocationType>
              <Name>string</Name>
              <Id>int</Id>
              <Code>string</Code>
            </LocationType>
            <Dimensions>
              <Length>decimal</Length>
              <Width>decimal</Width>
              <Height>decimal</Height>
            </Dimensions>
            <IsLocked>boolean</IsLocked>
            <IsLockedForSale>boolean</IsLockedForSale>
            <LocationPickingPriority>int</LocationPickingPriority>
          </Location_GetLocations>
          <Location_GetLocations>
            <LocationId>int</LocationId>
            <LocationName>string</LocationName>
            <PositionX>int</PositionX>
            <PositionY>int</PositionY>
            <Aisle>
              <AisleId>int</AisleId>
              <AisleName>string</AisleName>
              <Zone>
                <ZoneId>int</ZoneId>
                <ZoneName>string</ZoneName>
                <WarehouseId>int</WarehouseId>
              </Zone>
            </Aisle>
            <LocationType>
              <Name>string</Name>
              <Id>int</Id>
              <Code>string</Code>
            </LocationType>
            <Dimensions>
              <Length>decimal</Length>
              <Width>decimal</Width>
              <Height>decimal</Height>
            </Dimensions>
            <IsLocked>boolean</IsLocked>
            <IsLockedForSale>boolean</IsLockedForSale>
            <LocationPickingPriority>int</LocationPickingPriority>
          </Location_GetLocations>
        </Locations>
        <Success>boolean</Success>
        <Message>string</Message>
      </GetLocationsByQueryResult>
    </GetLocationsByQueryResponse>
  </soap:Body>
</soap:Envelope>

Response specification