# Get outlet > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/outlets/outlet-id/llms.txt. > For full documentation content, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/outlets/outlet-id/llms-full.txt. GET http://localhost:8080/api/v1/outlets/{outletId} Retrieve outlet information by ID Reference: https://apidocs.cata.sg/pos-integration-service-api/api/v-1/outlets/outlet-id/get-outlet ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/v1/outlets/{outletId}: get: operationId: get-outlet summary: Get outlet description: Retrieve outlet information by ID tags: - >- subpackage_api.subpackage_api/v1.subpackage_api/v1/outlets.subpackage_api/v1/outlets/outletId parameters: - name: outletId in: path required: true schema: type: string - name: X-Api-Key in: header required: true schema: type: string - name: X-Tenant-ID in: header description: Tenant identifier required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/api_v1_outlets_{outletId}_Get outlet_Response_200 '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/GetApiV1OutletsOutletidRequestNotFoundError servers: - url: http://localhost:8080 components: schemas: ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaAddress: type: object properties: street1: type: string street2: type: string city: type: string state: type: string postalCode: type: string country: type: string latitude: type: number format: double longitude: type: number format: double required: - street1 - street2 - city - state - postalCode - country - latitude - longitude title: ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaAddress ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaContact: type: object properties: email: type: string format: email phone: type: string website: type: string contactName: type: string required: - email - phone - website - contactName title: ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaContact ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaOpeningHoursItems: type: object properties: dayOfWeek: type: integer openTime: type: string closeTime: type: string isClosed: type: boolean required: - dayOfWeek - openTime - closeTime - isClosed title: >- ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaOpeningHoursItems ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaCapabilities: type: object properties: acceptsDelivery: type: boolean acceptsPickup: type: boolean acceptsDineIn: type: boolean required: - acceptsDelivery - acceptsPickup - acceptsDineIn title: ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaCapabilities api_v1_outlets_{outletId}_Get outlet_Response_200: type: object properties: id: type: string name: type: string status: type: string externalId: type: string internalName: type: string slug: type: string refCode: type: string imageUrl: type: string format: uri address: $ref: >- #/components/schemas/ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaAddress contact: $ref: >- #/components/schemas/ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaContact isOpen: type: boolean isBusy: type: boolean visible: type: boolean timezone: type: string openingHours: type: array items: $ref: >- #/components/schemas/ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaOpeningHoursItems capabilities: $ref: >- #/components/schemas/ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaCapabilities locationId: type: string channelLinkId: type: string showStartDatetime: type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - status - externalId - internalName - slug - refCode - imageUrl - address - contact - isOpen - isBusy - visible - timezone - openingHours - capabilities - locationId - channelLinkId - showStartDatetime - createdAt - updatedAt title: api_v1_outlets_{outletId}_Get outlet_Response_200 ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaError: type: object properties: code: type: integer message: type: string details: type: string field: type: string required: - code - message - details - field title: ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaError GetApiV1OutletsOutletidRequestNotFoundError: type: object properties: error: $ref: >- #/components/schemas/ApiV1OutletsOutletIdGetResponsesContentApplicationJsonSchemaError required: - error title: GetApiV1OutletsOutletidRequestNotFoundError securitySchemes: apiKeyAuth: type: apiKey in: header name: X-Api-Key ``` ## SDK Code Examples ```python api_v1_outlets_{outletId}_Get outlet_example import requests url = "http://localhost:8080/api/v1/outlets/string" headers = { "X-Tenant-ID": "string", "X-Api-Key": "" } response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript api_v1_outlets_{outletId}_Get outlet_example const url = 'http://localhost:8080/api/v1/outlets/string'; const options = {method: 'GET', headers: {'X-Tenant-ID': 'string', 'X-Api-Key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go api_v1_outlets_{outletId}_Get outlet_example package main import ( "fmt" "net/http" "io" ) func main() { url := "http://localhost:8080/api/v1/outlets/string" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Tenant-ID", "string") req.Header.Add("X-Api-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby api_v1_outlets_{outletId}_Get outlet_example require 'uri' require 'net/http' url = URI("http://localhost:8080/api/v1/outlets/string") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["X-Tenant-ID"] = 'string' request["X-Api-Key"] = '' response = http.request(request) puts response.read_body ``` ```java api_v1_outlets_{outletId}_Get outlet_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("http://localhost:8080/api/v1/outlets/string") .header("X-Tenant-ID", "string") .header("X-Api-Key", "") .asString(); ``` ```php api_v1_outlets_{outletId}_Get outlet_example request('GET', 'http://localhost:8080/api/v1/outlets/string', [ 'headers' => [ 'X-Api-Key' => '', 'X-Tenant-ID' => 'string', ], ]); echo $response->getBody(); ``` ```csharp api_v1_outlets_{outletId}_Get outlet_example using RestSharp; var client = new RestClient("http://localhost:8080/api/v1/outlets/string"); var request = new RestRequest(Method.GET); request.AddHeader("X-Tenant-ID", "string"); request.AddHeader("X-Api-Key", ""); IRestResponse response = client.Execute(request); ``` ```swift api_v1_outlets_{outletId}_Get outlet_example import Foundation let headers = [ "X-Tenant-ID": "string", "X-Api-Key": "" ] let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/outlets/string")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```