---
title: "Get shop"
method: GET
path: "/shops/{SHOP_ID}"
tags: ["Shop"]
---

# Get shop

`GET /shops/{SHOP_ID}`

## Request

- Base URL: `https://pos.pages.fm/api/v1`
- URL: `https://pos.pages.fm/api/v1/shops/{SHOP_ID}`
- Auth: API key in query parameter `api_key`

Get one shop the caller belongs to, in the same shape as an item of the shop list. With a shop API key, the key's account needs the shop configuration permission.

## Path parameters

- `SHOP_ID` integer, required

## Response `200`

Success

- object
  - `shop` Shop: Shop information
    - `avatar_url` string: Avatar image link
    - `name` string: Shop name
    - `currency` string: Shop currency code, for example `VND`
    - `id` integer: Shop ID
    - `preferred_shop` integer, nullable: User-specific preferred shop rank. Lower values have higher priority
    - `pages` object[]: Pages information in shop
      - `id` string: Page ID
      - `name` string: Page name
      - `platform` string: Platform (e.g., facebook)
      - `settings` object: Page settings
        - `auto_create_order` boolean: Auto create order
      - `shop_id` integer: Shop ID
    - `link_post_marketer` object[]: Information of link post / source / AD account with marketer
      - `ad_account_id` string: AD account ID
      - `id` string: Link ID
      - `inserted_at` string, date-time: Inserted at
      - `marketer` string: Marketer ID
      - `multiple_post` string[]: Post ID
      - `multiple_source` object[]: Source information
        - `account` string: Order source account ID
        - `key` string: Key
        - `page_id` string: Facebook page ID
      - `shop_id` integer: Shop ID
      - `type` string: Type of link (post: "Post", source: "Source", ad_account_id: "AD account")
  - `success` boolean: Success status

## Changes

- **2026-10-26** `3df28d1fb5dc`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pancake/apis/pancake-pos-open-api/changes/shops/:SHOP_ID/get.md)

---

[API](https://skmtc.dev/pancake/apis/pancake-pos-open-api.md) - [All operations](https://skmtc.dev/pancake/apis/pancake-pos-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pancake/apis/pancake-pos-open-api/revisions/3df28d1fb5dc?raw)
