Partner UI Integration API (v1)
Download OpenAPI specification:Download
Wolfe Partner UI Integration Documentation
Related Documentation
Wolfe Partner APIs - Primary suite of API endpoints for back-end integrations.
The Partner UI API exposes endpoints to access Wolfe platform functionality for building front-end components.
The API is organized around REST and has predictable resource-oriented URLs. The API uses standard HTTP response codes and verbs, and authenticates using a publishable API key.
Authentication
To get started working with the API all you need is an API key. A new API key may be generated in the partner portal at any time, and you may have up to 4 active API keys at any given time. These API keys are not secret, and may be published on a webpage. The API key should be included in the header of all requests as follows:
api-key: YOUR_API_KEY
Search Merchants
Search your merchant catalog using the available search parameters. The geolocation and radius parameters are used in conjunction with each other. If either is omitted, both will be ignored, and the search will be conducted without any location-based filtering.
By default, the search results will include all locations matching the search criteria for any merchant in your catalog. When specific location information is not needed, use the group parameter to only return a single result per merchant. When the group parameter is true, the location information will be omitted from the response.
Rate Limiting
The search endpoint is rate-limited to 1000 requests per 5 minutes per API key. If you exceed this limit, you will receive a 429 response code. Requests that fail validation, or return a cached response, do not count against this limit. Responses are cached for 60 seconds.
Authorizations:
path Parameters
| company_id required | string <uuid> Example: 3336e3de-5b54-4788-8927-81cab18291a4 |
query Parameters
| query | string Example: query=Starbucks Search query |
| geolocation | string Example: geolocation=40.7128,-74.0060 Latitude and Longitude around which search should be conducted. |
| radius | integer <int32> [ 1 .. 100 ] Example: radius=5 Radius of search in miles around the geolocation |
| national | boolean Example: national=true Whether search should include only national or local merchants. If parameter is omitted from the request, defaults to both. |
| categories[] | Array of strings Example: categories[]=Restaurants&categories[]=Travel Filter search results by merchant categories. Multiple categories may be provided by repeating this parameter. |
| group | boolean Example: group=true Group search results by merchant. If parameter value is true, only 1 result per merchant will be returned and location information will be omitted from the response. |
| offset | integer <int32> >= 0 Default: 0 Example: offset=20 The offset of the item at which to begin the response. |
| limit | integer <int32> [ 1 .. 100 ] Default: 20 Example: limit=10 The maximum number of items to return per page. |
Responses
Response samples
- 200
- 400
- 403
- 429
{- "code": 200,
- "message": "SUCCESS",
- "pagination": {
- "limit": 20,
- "offset": 0,
- "total_count": 115
}, - "data": [
- {
- "id": "3336e3de-5b54-4788-8927-81cab18291a4",
- "name": "Starbucks",
- "address_line1": "100 Main St",
- "address_line2": "Suite 302",
- "locality": "Pittsburgh",
- "region": "PA",
- "postal_code": "15222",
- "geolocation": {
- "lat": 40.7128,
- "lng": -74.006
}, - "national": true,
- "categories": [
- "Restaurants",
- "Coffee"
]
}
]
}
Get Categories
Get available search categories from your merchant catalog.
Authorizations:
path Parameters
| company_id required | string <uuid> Example: 3336e3de-5b54-4788-8927-81cab18291a4 |
Responses
Response samples
- 200
- 403
{- "code": 200,
- "message": "SUCCESS",
- "data": [
- {
- "name": "Restaurants"
}
]
}