Search for Location


This documentation is for translated APIs and intended only for some implementations who have upgraded from a previous version of Order Management. Verify whether your implementation uses translated APIs before making this call, as you will experience errors if your tenant is not configured to use these. If your implementation is not configured to do so, then refer to the standard API documentation instead.

The Search Location API allows the user to find a particular location based on a number of variables.

Note that the parameter schemas outlined in this guide are the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.

Production URLhttps://{tenantId}
Sandbox URLhttps://{tenantId}
Supported FormatsJSON

The request itself is built within the URL by adding a “/?” to the call followed by specific parameters joined by the “&” symbol. For instance, searching for locations from a particular retailer and manufacturer combination would use the following format:

  • https://{tenantId}[Retailer ID]&manufacturerID=[Manufacturer ID]

In the case of performing a search with multiple terms of the same parameter, such as retrieving multiple retailer IDs at once, use a comma-separated list as shown below.

  • https://{tenantId}[Retailer ID One],[Retailer ID Two],[Retailer ID Three]

GET calls that support pagination for numerous results, such as when searching, also accept a perPage parameter that defines how many results can be returned on each page. The default is 1. Switch between pages of results by appending the page parameter to the call. For example:

  • https://{tenantId}[Retailer ID]&perPage=2&page=2


In this example, the location being searched for includes these particular properties:

  • Manufacturer ID 55555
  • Exclude inactive locations (only search for active locations)

Required Parameters

A variety of possible properties can be used to locate an existing location. The API call always requires at least one of these data points to reference as a search term:

manufacturerIDintegerA unique identifier for the location’s manufacturer. The minimum value is “1”.
retailerIDintegerA unique identifier for the location’s retailer. The minimum value is “1”.
locationIDstringOne or multiple (comma-separated) unique location identifiers to retrieve.
pageintegerThe page number to begin listing the results from. The default and minimum value is “1”. While this parameter is technically required, this default means that it does not have to be provided in the request unless a different page is specifically desired. Also, note that the page cannot be the sole parameter in the search query – if provided, there must be at least one of the other parameters in this table.

Optional Parameters

The API can also search for any of these additional elements:

catalogIDintegerA unique identifier for a catalog.
catalogIDsstringA single or list of catalogIDs. They must be positive integers. The minimum value is “1”.
externalStoreIDstringA unique external identifier for the store, also known as Dealer ID. Requires a single manufacturerID and an optional single catalogID.
lastUpdatedStartstringThe start of the date range the location was last updated (date-time).
lastUpdatedEndstringThe end of the date range the location was last updated (date-time).
searchTermstringA string to search locations by: name, address, externalStoreID, or locationID. The minimum length is 3 and the maximum length is 300.
includeExternalFulfillersbooleanWhether to include locations for fulfillers with external associations in the network. The default is “false”.
excludeInactiveLocationsbooleanIf true, locations that are currently inactive will be filtered out. The default is “false”.
includeHoursbooleanWhether to include store hours or not.
perPageintegerThe (max) number of items to return per results page. The minimum value is “1” and the maximum value is “100”. The default is “10”.

The Full Request

Using the URL format as outlined above, the entire call is fairly simple to put together. This sample will search for customers matching the example’s parameters. Any amount of additional parameters could be appended if desired.


The Full Response

This is the full response returned by the API.

 "collection": [
   "locationID": 010101,
   "manufacturerID": 55555,
   "fulfillerID": 44444,
   "name": "Example Location Three",
   "addressLine1": "9999 Example Rd",
   "city": "Dallas",
   "state": "TX",
   "countryCode": "US",
   "postalCode": "75201",
   "latitude": 39.5755,
   "longitude": -104.862,
   "contact": "John Smith",
   "contactPhone": "000-000-0000",
   "phone": "000-000-0000",
   "fax": "111-111-1111",
   "email": "",
   "localSalesTax": 0.06075,
   "active": true,
   "shippingLocation": true,
   "restockEnabled": false,
   "pickupEnabled": false,
   "showInAggregateReport": true,
   "taxableLocation": true,
   "hasStorefront": true,
   "mainLocation": false,
   "express": true,
   "lastUpdated": "2016-09-08T19:40:30+0000"