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

# Join Affiliate Program

> Cadastra o cliente autenticado como afiliado da loja.
<Note>Devolve o mesmo objeto de `GET /webstore/affiliate/me`, já com o afiliado criado, então não é preciso chamar o painel logo em seguida. Um cliente que já é afiliado recebe o painel dele sem erro. O `ref_code` é escolhido pelo cliente, precisa ter ao menos 3 caracteres e ser único na loja.</Note>



## OpenAPI

````yaml /openapi/storefront-affiliate.yaml post /webstore/affiliate/join
openapi: 3.1.0
info:
  title: CentralCart Storefront API (Afiliados)
  version: 1.0.0
  description: >-
    Programa de afiliados da loja, na visão do comprador que indica. Todas as
    rotas exigem a sessão do cliente, exceto a que resolve um código de
    indicação.
servers:
  - url: https://api.centralcart.io/v1
    description: Produção
security:
  - customerAuth: []
paths:
  /webstore/affiliate/join:
    post:
      tags:
        - Afiliados
      summary: Join Affiliate Program
      description: >-
        Cadastra o cliente autenticado como afiliado da loja.

        <Note>Devolve o mesmo objeto de `GET /webstore/affiliate/me`, já com o
        afiliado criado, então não é preciso chamar o painel logo em seguida. Um
        cliente que já é afiliado recebe o painel dele sem erro. O `ref_code` é
        escolhido pelo cliente, precisa ter ao menos 3 caracteres e ser único na
        loja.</Note>
      operationId: joinWebstoreAffiliateProgram
      parameters:
        - $ref: '#/components/parameters/StoreDomain'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - ref_code
              properties:
                ref_code:
                  type: string
                  description: Código que vai aparecer no link de indicação, em `?ref=`.
            example:
              ref_code: joao
      responses:
        '200':
          description: Painel do afiliado recém-cadastrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffiliatePanel'
        '401':
          $ref: '#/components/responses/CustomerUnauthorized'
        '403':
          description: A loja não aceita cadastro por conta própria
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                errors:
                  - message: O auto cadastro de afiliados está desativado nesta loja.
        '409':
          description: O código escolhido já está em uso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                errors:
                  - message: Este código já está em uso. Escolha outro.
        '422':
          description: Código ausente ou inválido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                errors:
                  - message: O código precisa ter pelo menos 3 caracteres.
components:
  parameters:
    StoreDomain:
      name: x-store-domain
      in: header
      required: true
      description: 'Domínio da sua loja (ex: sualoja.centralcart.ai)'
      schema:
        type: string
  schemas:
    AffiliatePanel:
      type: object
      properties:
        status:
          type: string
          enum:
            - affiliate
        id:
          type: number
        name:
          type: string
        email:
          type: string
        ref_code:
          type: string
          description: Código principal do afiliado, usado em `?ref=`.
        percent_commission:
          type: number
          description: Percentual de comissão padrão deste afiliado.
        balance:
          type: number
          description: Saldo disponível para saque.
        min_withdraw:
          type: number
          nullable: true
          description: Valor mínimo por saque. `null` usa o padrão da loja.
        withdraw_settings:
          $ref: '#/components/schemas/WithdrawSettings'
        stats:
          type: object
          properties:
            total_sales:
              type: number
              description: Pedidos aprovados atribuídos a este afiliado.
            total_amount:
              type: number
              description: Soma dos pedidos aprovados atribuídos a este afiliado.
            d7_visits:
              type: number
              nullable: true
              description: Visitas dos últimos 7 dias. Só vem com `include_visits=true`.
        links:
          type: array
          items:
            $ref: '#/components/schemas/AffiliateLink'
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              ref:
                type: string
    WithdrawSettings:
      type: object
      nullable: true
      required:
        - full_name
        - pix_key
        - pix_key_type
        - cpf_cnpj
      properties:
        full_name:
          type: string
        pix_key:
          type: string
        pix_key_type:
          type: string
          enum:
            - CPF
            - CNPJ
            - EMAIL
            - PHONE
            - RANDOM
        cpf_cnpj:
          type: string
    AffiliateLink:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        ref_code:
          type: string
        url:
          type: string
          description: Link pronto para compartilhar.
        sales:
          type: number
          description: Vendas acumuladas por este link.
        revenue:
          type: number
          description: Receita acumulada por este link.
        d7_visits:
          type: number
          nullable: true
          description: >-
            Visitas dos últimos 7 dias. Só vem preenchido em `GET
            /webstore/affiliate/me` com `include_visits=true`; nos demais casos
            é `null`.
  responses:
    CustomerUnauthorized:
      description: Sessão do cliente ausente, inválida ou expirada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            errors:
              - message: Sessão inválida ou expirada.
                code: CUSTOMER_UNAUTHENTICATED
  securitySchemes:
    customerAuth:
      type: http
      scheme: bearer
      description: '`access_token` do comprador, devolvido por `POST /webstore/auth/verify`.'

````