> ## 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. # Campanhas > O cadastro das campanhas da loja — a origem do campaignId usado em conversões e estatísticas Lista as campanhas de relacionamento da loja: nome, tipo, canal de envio, status, vigência (`startDate`/`endDate`), segmentos de público (`audienceSegments`) e custo por envio (`costPerSend`). É o **cadastro** — os resultados de cada campanha vêm de outras rotas. O `campaignId` retornado aqui é a chave para as outras rotas: aparece em [Conversões](/crm-parceiro/conversoes) (nas vendas atribuídas à campanha) e em [Estatísticas de campanha](/crm-parceiro/estatisticas-de-campanha) (no funil diário de envio). Comece por aqui para saber **quais** campanhas existem, depois busque os números. `costPerSend` combinado com `sent` das estatísticas dá o custo total — mas [Estatísticas de campanha](/crm-parceiro/estatisticas-de-campanha) já traz `totalCost` calculado por dia, e as [métricas por campanha](/metricas/receita-por-campanha) já trazem a receita. Prefira os valores prontos. Paginada por `cursor`/`nextCursor`, como as demais rotas de dado bruto. `type`, `channel` e `status` são **textos livres**, refletindo o valor cadastrado na Repediu — não trate como enum fechado. `audienceSegments` é uma lista de objetos `{ segmentId, name }` com os segmentos de público da campanha (por exemplo `Campeões`, `Em risco`). `costPerSend` pode vir `null` quando o canal não tem preço cadastrado. ## Erros | HTTP | `code` no corpo | Quando acontece | O que fazer | | ----- | --------------- | ------------------------------------------ | ---------------------------------------------------------------------- | | `400` | `BAD_REQUEST` | `cursor` inválido | Corrija o parâmetro indicado em `details` | | `401` | `UNAUTHORIZED` | Token ausente, inválido ou expirado | Gere um novo token em [Obter token](/open-delivery/obter-token) | | `403` | `FORBIDDEN` | Token sem o escopo exigido pela rota | Confirme as permissões da credencial com a Repediu | | `404` | `NOT_FOUND` | Merchant inexistente **ou fora do escopo** | Confirme o `id` em [Listar merchants](/open-delivery/listar-merchants) | O funil de envio (enviadas, entregues, lidas…) por campanha e por dia. As vendas atribuídas a cada campanha, uma a uma. ## OpenAPI ````yaml openapi.yaml GET /v1/stores/{merchantId}/campaigns 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: /v1/stores/{merchantId}/campaigns: get: tags: - CRM do parceiro summary: Campanhas description: >- Cadastro das campanhas da loja — nome, tipo, canal, status, vigência, segmentos de público e custo por envio. O campaignId liga a campanha às conversões e às estatísticas de envio. operationId: listStoreCampaigns parameters: - $ref: '#/components/parameters/MerchantIdPath' - $ref: '#/components/parameters/CrmCursor' - $ref: '#/components/parameters/CrmLimit' responses: '200': description: Página de campanhas da loja. content: application/json: schema: $ref: '#/components/schemas/CampaignListResponse' example: items: - campaignId: 12 name: Volte a pedir! type: Reativação channel: WhatsApp status: Ativa startDate: '2026-08-01T00:00:00' endDate: null audienceSegments: - segmentId: 4 name: Em risco costPerSend: 0.35 updatedAt: '2026-08-10T15:20:00+00:00' nextCursor: null '400': description: Cursor inválido. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: BAD_REQUEST message: One or more validation errors occurred details: - cursor is invalid '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/InsufficientScope' '404': $ref: '#/components/responses/MerchantNotFound' components: parameters: MerchantIdPath: name: merchantId in: path required: true description: Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants. schema: type: string format: uuid CrmCursor: name: cursor in: query description: >- Cursor opaco da próxima página, retornado em nextCursor. Omita na primeira chamada. schema: type: string CrmLimit: name: limit in: query description: Itens por página. Valores acima de 500 são limitados a 500. schema: type: integer format: int32 default: 100 maximum: 500 schemas: CampaignListResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CampaignItem' nextCursor: type: string nullable: true description: Cursor da próxima página. Null quando não há próxima página. 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 CampaignItem: type: object properties: campaignId: type: integer format: int32 name: type: string type: type: string description: Tipo da campanha, como cadastrado na Repediu (texto livre). channel: type: string description: Canal de envio, como cadastrado na Repediu (texto livre). status: type: string description: Status da campanha, como cadastrado na Repediu (texto livre). startDate: type: string format: date-time endDate: type: string format: date-time nullable: true audienceSegments: type: array items: type: object properties: segmentId: type: integer format: int32 name: type: string costPerSend: type: number nullable: true description: >- Custo por envio no canal da campanha, em reais. Null quando não há preço cadastrado. updatedAt: type: string format: date-time 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 InsufficientScope: description: Token sem o escopo exigido pela rota. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: FORBIDDEN message: The access token does not have the required scope. details: null MerchantNotFound: 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 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 `. ````