> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clubfix.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Busca uma loja vinculada pelo identificador
> Este recurso é paginável.
Corresponde ao ID da loja que você deseja obter. Este ID é único para cada loja e pode ser encontrado na listagem de lojas.
Corresponde à página que você deseja exibir os dados.
Altera a quantidade de itens devolvidos em uma requisição.
Permite incluir dados relacionados na resposta. Exemplo: `address,responsible`.
Deve ser definido como `application/json`.
Token de autenticação do tipo Bearer obtido através do endpoint de login.
## OpenAPI
````yaml GET /shopkeepers/{id}
openapi: 3.0.3
info:
title: Clubfix Webservice de Parceiros
description: >-
Bem vido(a) à documentação do **Webservice de Parceiros** da **Clubfix.** Os
recursos aqui dispostos são suplementados com exemplos de respostas
esperadas, para nortear a implementação. Caso haja algum empecilho ou erro
não esperado, fique à vontade para chamar o suporte em TI pelos canais que
você já conhece.
Observação: Utilize sempre os cabeçalhos `Content-Type` e `Accept` como
`application/json`
#### **URL Base**
| **Ambiente** | **URL** |
| --- | --- |
| Homologação | [https://homolog.clubfix.com.br/webservice]() |
| Produção | [https://clubfix.com.br/webservice]() |
> NOTA: Para conseguir utilizar ambos ambientes, faz-se necessário solicitar
pelo nosso time de suporte a geração das chaves de autenticação mencionadas
na seção de **Autenticação**.
#### Paginação
Para navegar nos recursos de listagem através de suas páginas, utilize as
`parâmeros` dispostas na tabela abaixo
| **Parâmetro** | **Descrição** |
| --- | --- |
| page | Corresponde à pagina que você deseja exibir os dados. |
| per_page | Altera a quantidade de itens devolvidos em uma requisição. |
| current_page | Identifica a pagina correspondente àquela requisição. |
### **Conhecendo os erros comuns**
| **Status Code** | **Descrição** |
| --- | --- |
| 422 | Erro em algum parâmetro fornecido. O resultado deste erro será um
objeto, onde a sua chave indicará o campo que não está em conformidade. |
| 401 | Não autorizado. Significa que há ausência de um token válido na
requisição, seja por expiração, não fornecimento, ou, no caso do login, as
suas credenciais não estão corretas. |
| 5** | Erro de servidor no endpoint requisitado. Quando isso ocorrer,
contate o nosso suporte. |
version: 1.0.0
servers: []
security: []
paths:
/shopkeepers/{id}:
get:
summary: Busca uma loja vinculada pelo identificador
description: Este recurso é paginável.
parameters:
- name: Accept
in: header
required: true
schema:
type: string
example: application/json
- name: page
in: query
required: false
schema:
type: string
example: '1'
- name: per_page
in: query
required: false
schema:
type: string
example: '15'
- name: include
in: query
required: false
schema:
type: string
example: address,responsible
responses:
'200':
description: 200 Ok - Busca uma loja vinculada pelo identificador
content:
application/json:
example:
id: 2
trading_name: Exclusiva mobile celulares
registration_number: '97548760000170'
matrix: true
responsible:
name: Eder Andre Kaghofer
registration_number: '03379402907'
identity_card: ''
phone: '46999177399'
email: ederk42@hotmail.com
role: proprietário
address:
street: av julio assis cavalheiro
number: '925'
complement: loja 01
zipcode: '85601000'
neighborhood: null
city: Francisco Beltrão
state: PR
meta:
link: https://homolog.clubfix.com.br/webservice/shopkeepers/2
schema:
type: object
properties:
id:
type: integer
trading_name:
type: string
registration_number:
type: string
matrix:
type: integer
responsible:
type: object
properties:
name:
type: string
registration_number:
type: string
identity_card:
type: string
phone:
type: string
email:
type: string
role:
type: string
address:
type: object
properties:
street:
type: string
number:
type: string
complement:
type: string
zipcode:
type: string
neighborhood:
type: string
city:
type: string
state:
type: string
meta:
type: object
properties:
link:
type: string
````