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

# Create Affiliate Link

> Cria um link de indicação com código próprio.
<Note>O `ref_code` aceita letras, números, hífen e underline, é gravado em minúsculas e precisa ser único na loja. A loja define o limite de links por afiliado.</Note>



## OpenAPI

````yaml /openapi/storefront-affiliate.yaml post /webstore/affiliate/links
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/links:
    post:
      tags:
        - Afiliados
      summary: Create Affiliate Link
      description: >-
        Cria um link de indicação com código próprio.

        <Note>O `ref_code` aceita letras, números, hífen e underline, é gravado
        em minúsculas e precisa ser único na loja. A loja define o limite de
        links por afiliado.</Note>
      operationId: createWebstoreAffiliateLink
      parameters:
        - $ref: '#/components/parameters/StoreDomain'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - ref_code
              properties:
                name:
                  type: string
                  description: >-
                    Nome do link, para o afiliado se organizar. Até 56
                    caracteres.
                ref_code:
                  type: string
                  description: Código usado em `?ref=`. Até 40 caracteres.
            example:
              name: Campanha do YouTube
              ref_code: joao-yt
      responses:
        '200':
          description: Link criado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffiliateLink'
        '401':
          $ref: '#/components/responses/CustomerUnauthorized'
        '404':
          $ref: '#/components/responses/AffiliateNotFound'
        '422':
          description: Código inválido, já em uso, ou limite de links atingido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                errors:
                  - message: Já existe um link com este código.
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:
    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`.
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              ref:
                type: string
  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
    AffiliateNotFound:
      description: O cliente autenticado não é afiliado desta loja
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            errors:
              - message: Afiliado não encontrado
  securitySchemes:
    customerAuth:
      type: http
      scheme: bearer
      description: '`access_token` do comprador, devolvido por `POST /webstore/auth/verify`.'

````