Skip to main content
GET
/
v1
/
retailers
List retailers with locations
curl --request GET \
  --url http://localhost:3000/v1/retailers
{
  "retailers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "retailer_code": "<string>",
      "display_name": "<string>",
      "brand_logo_url": "<string>"
    }
  ],
  "locations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "retailer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "store_number": "<string>",
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "province": "<string>",
      "postal_code": "<string>",
      "latitude": 123,
      "longitude": 123,
      "product_count": 123
    }
  ],
  "total": 123
}

Query Parameters

limit
integer
default:100

Max items to return

Required range: 1 <= x <= 10000
Example:

100

offset
integer | null
default:0

Items to skip

Required range: x >= 0
Example:

0

Search query

Maximum string length: 200
Example:

"whole foods"

Response

List of retailers and locations

List retailers response

retailers
object[]
required
locations
object[]
required
total
number
required