Store Lookup
Discover how the Store Lookup API facilitates finding stores accepting BOPIS orders near the customer's location using the POST method.
The API allows to look up the stores accepting BOPIS orders near the customer’s location using the POST method.
Request
Endpoint
https://< host >/api/storeLookup
Example: Host: https://demo-oms.hotwax.io/api/storeLookup
Header
Content-Type: application/json
Body
Parameters
Parameter | Description | Required (Y/N) |
---|---|---|
| The total number of results in the API response | N |
| Filter records based on the passed parameters | N |
| The latitude-longitude of a specific location to find nearby stores | N |
| The distance from the passed latitude-longitude | N |
| Sort data based on the attribute, for example: "storeDistance asc" sorts results by distance | N |
| Keyword search (only on storeName, storeCode, and externalId) | N |
| The list of fields to select, all the fields can be filtered in response | N |
Response
Status Code
HTTP/1.1 200 OK
Headers
Content-Type: application/json
Body
Parameters | Description |
---|---|
| The number of results found |
| The array of results found |
| Reference index |
| The ID of the facility (store) in HotWax |
| DocType-Identifier |
| Country |
| The type of the store |
| Store Name |
| The Id of the store in the external reference source |
| The Id of the primary facility group |
| |
| The Id of the primary Shopify Shop |
| The address of the store |
| City |
| Postal Code |
| Country |
| Country Code |
| State Code |
| The latitude and longitude of the facility |
| The opening time of the store on the day of a week |
| The closing time of the store on the day of a week |
Note:
Filters
Filter is a parameter that allows you to narrow down the results of a query or search to only include items that meet specific criteria. For storeLookup API, users can filter results for each parameter given in the response:
Parameter Name | Description |
---|---|
| Country |
| The type of the store |
| Store Name |
| The Id of the store in the external reference source |
| The Id of the primary facility group |
| The name of the primary facility group |
| The Id of the primary Shopify Shop |
| City |
| Postal Code |
| Country Code |
| State Code |
| The latitude and longitude of the facility |
Valid values of storeType
RETAIL
WAREHOUSE
RETAIL_STORE
OUTLET_WAREHOUSE
OUTLET_STORE
DISTRIBUTION_CENTER
Last updated