Search for Locations

This service retrieves locations applicable for a purchase order. Locations can be searched by either 'S'tore or 'W'arehouse. Provide a location number, a partial location number, a location name, or a partial location name in the search string.

Returned locations must meet the following criteria:

• Only stockholding locations are returned.

• When search type is Warehouse then:

  • Only virtual warehouses are returned.

  • Internal finishers are filtered out.

• When search location type is Store, only the following stores are returned:

  • Company stores.

  • Open stores.

• When org units are used in the system (System Options - Organizational Units is set to 'Y') then:

  • When supplier is sent as input, only locations with same org unit identifier are returned.

  • When Org Unit ID is sent as input, only locations with same org unit identifier are returned .

Example URL

Here is an example of the resource URL:

GET

/PurchaseOrders/location?locationType={locationType}&searchString={searchString}&supplier={supplier}&orgUnitId={orgUnitId}&pageSize={pageSize}&pageNumber={pageNumber}

Example Response

Here is an example of the response body in JSON format:

{
   ""links"": [
      {
         ""href"": ""/PurchaseOrders/location?searchString=e&pageSize=1&pageNumber=2"",
         ""rel"": ""next"",
         ""type"": ""GET"",
         ""methodType"": null
      }
   ],
   ""totalRecordCount"": 100,
   ""results"": [
      {
         ""links"": [],
         ""location"": 292919862,
         ""locType"": ""S"",
         ""locName"": ""Springfield Mall"",
         ""locationCurrency"": ""USD"",
         ""orgUnitId"": 1111111111,
         ""hyperMediaContent"": {
            ""linkRDO"": []
         }
      }
   ],
   ""hyperMediaContent"": {
      ""linkRDO"": [
         {
            ""href"": ""/PurchaseOrders/location?searchString=e&pageSize=1&pageNumber=2"",
            ""rel"": ""next"",
            ""type"": ""GET"",
            ""methodType"": null
         }
      ]
   }
}