---
title: "Get locations by store codes"
method: GET
path: "/locations-by-store-codes"
tags: ["Locations"]
---

# Get locations by store codes

`GET /locations-by-store-codes`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations-by-store-codes`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations-by-store-codes/get.ts> (a function with typed inputs; its response is checked against the schema)

This API retrieves location details based on specified store codes. Using unique store codes, allows businesses to fetch location-specific information such as name, address, contact details, business hours, and other relevant attributes.

## Query parameters

- `storeCodes` string, required

## Headers

- `Authorization` string, required

## Response `200`

Successful response

- object
  - `data` object, required
    - `getLocationsByStoreCodes` object[], required
      - `accountId` integer
      - `addOns` string[]
      - `additionalCategoryIds` string[]
      - `additionalCategoryNames` string[]
      - `additionalInfo` unknown
      - `additionalPhones` string[]
      - `approved` string
      - `archivalScheduledAt` unknown
      - `archived` boolean
      - `archivedAt` unknown
      - `bizUrl` string
      - `bizUrlUtm` boolean
      - `bookingUrl` unknown
      - `businessHours` string[]
      - `cancellationScheduledAt` unknown
      - `categoryId` integer
      - `city` string
      - `contentPreferredLanguage` string
      - `countryCode` string
      - `countryIso` string
      - `createErrors` string[]
      - `createdDate` string
      - `customAttributes` object[]
        - `archived` boolean, required
        - `enumValues` string[], required
        - `name` string, required
        - `slug` string, required
        - `type` string, required
        - `value` string[], required
      - `databaseId` integer
      - `description` string
      - `enabledSiteIds` string[]
      - `facebookUrl` unknown
      - `folderId` string
      - `folderName` string
      - `franchise` boolean
      - `googleAdsPhone` unknown
      - `googleVerificationStatus` object
        - `message` unknown, required
        - `status` string, required
      - `googleplusUrl` unknown
      - `hideAddress` boolean
      - `id` string
      - `instagramUrl` unknown
      - `isRestaurant` boolean
      - `lastUpdatedDate` string
      - `latitude` string
      - `linkedinUrl` unknown
      - `locationPhotos` object[]
        - `databaseId` integer, required
        - `fileSize` integer, required
        - `id` string, required
        - `name` string, required
        - `starred` boolean, required
        - `thumbnailUrl` string, required
        - `type` string, required
        - `url` string, required
      - `longitude` string
      - `managedServiceSiteBuckets` string[]
      - `managedServiceSites` string[]
      - `moreHours` string[]
      - `name` string
      - `offeringsUrl` unknown
      - `ownerEmail` unknown
      - `ownerName` unknown
      - `package` string
      - `paymentMethods` string[]
      - `phone` unknown
      - `pinterestUrl` unknown
      - `planId` integer
      - `planName` string
      - `postalCode` string
      - `publisherAttributes` string[]
      - `reservationUrl` unknown
      - `serviceItems` object[]
        - `categoryId` string, required
        - `countryIso` unknown, required
        - `currencyCode` unknown, required
        - `description` unknown, required
        - `id` string, required
        - `languageCode` unknown, required
        - `name` string, required
        - `price` unknown, required
      - `stateIso` string
      - `stateName` string
      - `storeId` string
      - `street` unknown
      - `street1` unknown
      - `subCategoryId` integer
      - `subCategoryName` string
      - `tagline` unknown
      - `tags` string[]
      - `temporarilyClosed` boolean
      - `tiktokUrl` unknown
      - `toplineMessage` unknown
      - `toplineMessageText` unknown
      - `twitterUrl` unknown
      - `uid` string
      - `updatedAt` string
      - `videos` string[]
      - `voiceStatus` integer
      - `yearOfIncorporation` unknown
      - `youtubeUrl` unknown

## Other responses

- `400`: Bad request - Invalid store codes format
- `401`: Unauthorized - Invalid or missing API key
- `404`: One or more store codes not found

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)