Skip to main content
GET
/
v1
/
retailers
/
locations
/
{id}
/
detail
Get location detail
curl --request GET \
  --url http://localhost:3000/v1/retailers/locations/{id}/detail
{
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "retailer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "store_number": "<string>",
    "address_1": "<string>",
    "address_2": "<string>",
    "city": "<string>",
    "province": "<string>",
    "postal_code": "<string>",
    "latitude": 123,
    "longitude": 123,
    "retailer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "retailer_code": "<string>",
      "display_name": "<string>",
      "brand_logo_url": "<string>"
    }
  },
  "products": [
    {
      "mapping_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "brand": "<string>",
      "image_url": "<string>",
      "barcode": "<string>",
      "selling_price": 123,
      "is_active": true,
      "is_in_stock": true,
      "is_available": true,
      "last_seen_at": "<string>",
      "store_zone": "<string>",
      "store_aisle": "<string>",
      "store_location": "<string>",
      "category_name": "<string>",
      "subcategory_name": "<string>"
    }
  ],
  "stats": {
    "total": 123,
    "in_stock": 123,
    "out_of_stock": 123
  },
  "filters": {
    "categories": [
      "<string>"
    ],
    "storeLocations": [
      "<string>"
    ]
  }
}

Path Parameters

id
string<uuid>
required

Location UUID

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Location detail with products

Get location detail response

location
object
required

Location detail

products
object[]
required
stats
object
required

Location product stats

filters
object
required

Available filters for location products