---
title: "Get outlet"
method: GET
path: "/outlets/{id}"
tags: ["Outlets"]
---

# Get outlet

`GET /outlets/{id}`

## Request

- Base URL: `https://api.genie.akahu.io/v1`
- URL: `https://api.genie.akahu.io/v1/outlets/{id}`
- Auth: HTTP bearer

Retrieve details for an outlet.

## Path parameters

- `id` string, required

## Response `200`

Success

- object
  - `success` true, required
  - `item` GenieOutlet, required: An individual outlet (i.e. specific location). An outlet will always be returned in combination with its related "parent" merchant.
    - `_id` string, required: The unique outlet identifier.
    - `name` string, required: The outlet name. This is usually more specific than the merchant name. For example, the merchant name may be "Pak'nSAVE", while the outlet name is "Pak'nSAVE Sylvia Park".
    - `logo` string: A URL referencing the outlet's logo. This field will only be included if the logo for this outlet differs from the merchant's logo.
    - `website` string: The URL for the outlet's website. This field will only be included if the website for this outlet differs from the merchant's website.
    - `phone` string: The outlet's phone number. This field will only be included if the phone number for this outlet differs from the merchant's phone number.
    - `nzbn` string: The outlet's NZBN (New Zealand Business Number). This field will only be included if the NZBN for this outlet differs from the merchant's NZBN.
    - `location` GenieLocation: A physical location.
      - `accuracy` 'country' | 'region' | 'locality' | 'sublocality' | 'establishment', required
      - `formatted` string, required
      - `coordinates` GenieCoordinates, required: Latitude/longitude location coordinates.
        - `lat` number, required
        - `lon` number, required
      - `address` GenieAddress
        - `street` string, required
        - `suburb` string
        - `city` string, required
        - `region` string, required
        - `country` string, required
        - `postal_code` string, required
    - `tags` GenieTag[]: Tags that apply to the outlet. For example, to indicate that the outlet provides a subscription service. Tags are inherited (and potentially extended) from the outlet's "parent" merchant.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Rate Limiting
- `500`: Internal Server Error

---

[API](https://skmtc.dev/akahu/apis/genie-transaction-enrichment-api.md) - [All operations](https://skmtc.dev/akahu/apis/genie-transaction-enrichment-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akahu/apis/genie-transaction-enrichment-api/revisions/b572302ad274?raw)
