> ## Documentation Index
> Fetch the complete documentation index at: https://docs.repediu.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter merchant

> Detalhe de um estabelecimento do escopo da aplicação, com endereço quando cadastrado

Detalha um estabelecimento do escopo da sua aplicação. Além de `id`, `name` e `status`, a resposta traz `basicInfo` com o nome e, quando o estabelecimento tem endereço cadastrado na Repediu, o objeto `address`.

<Note>
  Sem endereço cadastrado, o campo `address` é **omitido** da resposta — nunca vem vazio ou com valores inventados. Trate a ausência do campo no seu lado.
</Note>

<Warning>
  Um merchant que existe mas **não está vinculado à sua aplicação responde `404`**, exatamente igual a um merchant inexistente — a API não revela a existência de estabelecimentos fora do seu escopo. Se um merchant que você acessava passou a responder 404, o motivo mais provável é a desativação da integração pelo estabelecimento.
</Warning>

## Status do merchant

| `status` | Significado                                                  |
| -------- | ------------------------------------------------------------ |
| `OPEN`   | Estabelecimento ativo na Repediu                             |
| `CLOSED` | Estabelecimento inativo                                      |
| `PAUSED` | Faz parte do enum do protocolo, mas não é emitido atualmente |

## Erros

| HTTP  | `code` no corpo | Quando acontece                            | O que fazer                                                            |
| ----- | --------------- | ------------------------------------------ | ---------------------------------------------------------------------- |
| `401` | `UNAUTHORIZED`  | Token ausente, inválido ou expirado        | Gere um novo token em [Obter token](/open-delivery/obter-token)        |
| `403` | `FORBIDDEN`     | Aplicação sem nenhum merchant vinculado    | Aguarde ao menos um estabelecimento ativar a integração                |
| `404` | `NOT_FOUND`     | Merchant inexistente **ou fora do escopo** | Confirme o `id` em [Listar merchants](/open-delivery/listar-merchants) |

<Card title="Listar merchants" icon="store" href="/open-delivery/listar-merchants">
  A lista completa do seu escopo — de onde vem o `merchantId` usado aqui.
</Card>


## OpenAPI

````yaml openapi.yaml GET /od/v2/merchants/{merchantId}
openapi: 3.0.1
info:
  title: Repediu — API de integração
  description: >-
    API de integração da Repediu: rotas Open Delivery 2.0 (capabilities CRM),
    dado bruto do CRM do parceiro (/v1/stores) e métricas agregadas
    (/v1/stores/.../metrics). A autenticação usa o fluxo client_credentials: o
    token identifica a aplicação integradora e dá acesso a todos os
    estabelecimentos (merchants) que ativaram a integração.
  version: v2
servers:
  - url: https://public-api.repediu.com.br
    description: Produção
security:
  - Bearer: []
paths:
  /od/v2/merchants/{merchantId}:
    get:
      tags:
        - Merchants
      summary: Obter merchant
      description: >-
        Detalha um merchant do escopo da aplicação, incluindo `basicInfo` com
        endereço quando o estabelecimento tem endereço cadastrado. Merchants
        fora do escopo respondem 404 — a existência não é revelada.
      operationId: getMerchant
      parameters:
        - name: merchantId
          in: path
          required: true
          description: Identificador (UUID) do merchant.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Merchant encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantResponse'
              example:
                id: 07f3bb0c-927a-4d99-9ea3-c22ecce8721c
                name: Pastelaria do Luiz
                status: OPEN
                basicInfo:
                  name: Pastelaria do Luiz
                  address:
                    street: Avenida João Amadeu
                    number: '1234'
                    district: Centro
                    city: Jales
                    state: SP
                    postalCode: 15700-082
                    country: BR
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Merchant inexistente ou fora do escopo da aplicação.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: NOT_FOUND
                message: Merchant not found.
                details: null
components:
  schemas:
    MerchantResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - OPEN
            - CLOSED
            - PAUSED
        basicInfo:
          $ref: '#/components/schemas/MerchantBasicInfo'
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: >-
            Código do erro (BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND,
            INTERNAL_SERVER_ERROR).
        message:
          type: string
        details:
          type: array
          nullable: true
          description: Lista de mensagens de validação, quando aplicável.
          items:
            type: string
    MerchantBasicInfo:
      type: object
      properties:
        name:
          type: string
        address:
          allOf:
            - $ref: '#/components/schemas/MerchantAddress'
          description: >-
            Endereço do estabelecimento. Omitido quando não há endereço
            cadastrado.
    MerchantAddress:
      type: object
      properties:
        street:
          type: string
          nullable: true
        number:
          type: string
          nullable: true
        district:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
          description: UF (sigla do estado).
        postalCode:
          type: string
          nullable: true
        country:
          type: string
          description: Sempre `BR`.
  responses:
    Unauthorized:
      description: Token ausente, inválido ou expirado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: UNAUTHORIZED
            message: Invalid client credentials.
            details: null
    Forbidden:
      description: Token sem o escopo od.crm ou aplicação sem nenhum merchant vinculado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: FORBIDDEN
            message: Application is not authorized to access any merchant.
            details: null
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Token de acesso emitido por POST /od/v2/oauth/token (fluxo
        client_credentials). Envie no header Authorization como `Bearer
        <token>`.

````