> ## 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.

# Registro de uma Sub Loja

> Este recurso é paginável.

<ParamField header="Accept" type="string" required>
  Deve ser definido como `application/json`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  Deve ser definido como `application/json`.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Token de autenticação do tipo Bearer obtido através do endpoint de login.
</ParamField>


## OpenAPI

````yaml POST /shopkeepers
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:
    post:
      summary: Registro de uma Sub Loja
      description: Este recurso é paginável.
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
          example: application/json
      requestBody:
        content:
          application/json:
            example:
              trading_name: Resoluto Digital
              registration_number: '81817151000139'
              phone: '41992885586'
              website: https://resolutodigital.com.br
              address:
                zip_code: '81830120'
                street: Rua Santo Bozzi
                number: '770'
                complement: bloco 6. Apto 622
                neighborhood: Xaxim
                city: Curitiba
                state: PR
              responsible:
                registration_number: '47401271052'
                name: Sergio Danilo Jr
                email: sergiodanilojr123@resolutodigital.com.br
                role: Founder
                phone: '41992885586'
              bank:
                account: '0000000'
                account_digit: '01'
                agency: '0001'
                name: Inter
            schema:
              type: object
              properties:
                trading_name:
                  type: string
                registration_number:
                  type: string
                phone:
                  type: string
                website:
                  type: string
                address:
                  type: object
                  properties:
                    zip_code:
                      type: string
                    street:
                      type: string
                    number:
                      type: string
                    complement:
                      type: string
                    neighborhood:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                responsible:
                  type: object
                  properties:
                    registration_number:
                      type: string
                    name:
                      type: string
                    email:
                      type: string
                    role:
                      type: string
                    phone:
                      type: string
                bank:
                  type: object
                  properties:
                    account:
                      type: string
                    account_digit:
                      type: string
                    agency:
                      type: string
                    name:
                      type: string
      responses:
        '201':
          description: Registro de uma Sub Loja
          content:
            application/json:
              example:
                id: 19
                trading_name: Resoluto Digital
                registration_number: '81817151000139'
                matrix: false
                responsible: null
                meta:
                  link: https://homolog.clubfix.com.br/webservice/shopkeepers/19
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  trading_name:
                    type: string
                  registration_number:
                    type: string
                  matrix:
                    type: integer
                  responsible:
                    type: string
                  meta:
                    type: object
                    properties:
                      link:
                        type: string

````