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

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Criar API de Frete

> Cria uma nova integração com API de Frete



## OpenAPI

````yaml post /{alias}/logistics/apis
openapi: 3.0.0
info:
  title: Yampi API
  description: Documentação oficial da API da Yampi
  version: '2.0'
servers:
  - url: https://api.dooki.com.br/v2
    description: Endpoint de produção
security:
  - ApiToken: []
    ApiSecretKey: []
tags:
  - name: Catálogo - Atualização em massa
    x-folder: catalogo/atualizacao-em-massa
  - name: Catálogo - Avaliações de produtos
    x-folder: catalogo/produtos/avaliacoes-de-produtos
  - name: Catálogo - Categorias
    x-folder: catalogo/categorias
  - name: Catálogo - Coleções
    x-folder: catalogo/colecoes
  - name: Catálogo - Comentários de produtos
    x-folder: catalogo/produtos/comentarios-de-produtos
  - name: Catálogo - Customizações
    x-folder: catalogo/customizacoes
  - name: Catálogo - Estoques de SKU
    x-folder: catalogo/skus/estoques-de-sku
  - name: Catálogo - Feeds
    x-folder: catalogo/feeds
  - name: Catálogo - Filtros
    x-folder: catalogo/filtros
  - name: Catálogo - Grupos
    x-folder: catalogo/grupos
  - name: Catálogo - Imagens
    x-folder: catalogo/imagens
  - name: Catálogo - Looks
    x-folder: catalogo/looks
  - name: Catálogo - Kits
    x-folder: catalogo/kits
  - name: Catálogo - Marcas
    x-folder: catalogo/marcas
  - name: Catálogo - Notificações de estoque
    x-folder: catalogo/notificacoes-de-estoque
  - name: Catálogo - Produtos
    x-folder: catalogo/produtos
  - name: Catálogo - Produtos relacionados
    x-folder: catalogo/produtos/produtos-relacionados
  - name: Catálogo - Selos
    x-folder: catalogo/selos
  - name: Catálogo - Sincronizar estoques
    x-folder: catalogo/skus/sincronizar-estoques
  - name: Catálogo - SKUs
    x-folder: catalogo/skus
  - name: Catálogo - Valores de filtros
    x-folder: catalogo/filtros/valores-de-filtros
  - name: Catálogo - Valores de variações
    x-folder: catalogo/variacoes/valores-de-variacoes
  - name: Catálogo - Variações
    x-folder: catalogo/variacoes
  - name: Público - Catálogo
    x-folder: /publico/catalogo
  - name: Público - Busca
    x-folder: /publico/busca
  - name: Público - Loja
    x-folder: /publico/loja
  - name: Público - Frete
    x-folder: /publico/frete
  - name: Checkout - Bancos
    x-folder: checkout/bancos
  - name: Checkout - Links de Pagamento
    x-folder: checkout/links-de-pagamento
  - name: Checkout - Carrinhos abandonados
    x-folder: checkout/carrinhos-abandonados
  - name: Checkout - Configurações de pagamentos
    x-folder: checkout/configuracoes-de-pagamentos
  - name: Checkout - Formas de pagamentos
    x-folder: checkout/formas-de-pagamentos
  - name: Checkout - Gateways de pagamento
    x-folder: checkout/gateways-de-pagamento
  - name: Checkout - Parcelamento
    x-folder: checkout/parcelamento
  - name: Checkout - Status de pedidos
    x-folder: checkout/status-de-pedidos
  - name: Checkout - Transações
    x-folder: checkout/transacoes
  - name: Clientes - Cliente
    x-folder: clientes/cliente
  - name: Clientes - Clusters
    description: >-
      Clusters são grupos de clientes com condições comerciais flexíveis, como
      preço de produto, frete e forma de entrega
    x-folder: clientes/clusters
  - name: Clientes - Endereços
    x-folder: clientes/enderecos
  - name: Clientes - Regras de frete dos clusters
    x-folder: clientes/clusters/regras-de-frete-dos-clusters
  - name: Configurações - Carrinhos abandonados
    x-folder: configuracoes/carrinhos-abandonados
  - name: Configurações - Checkout
    x-folder: configuracoes/checkout
  - name: Configurações - Credenciais da loja
    x-folder: configuracoes/credenciais-da-loja
  - name: Configurações - Dados da loja
    x-folder: configuracoes/dados-da-loja
  - name: Configurações - Fotos
    x-folder: configuracoes/fotos
  - name: Configurações - Integrações
    x-folder: configuracoes/integracoes
  - name: Configurações - IPs bloqueados
    x-folder: configuracoes/ips-bloqueados
  - name: Configurações - Overview
    x-folder: configuracoes/overview
  - name: Conteúdo - Páginas
    x-folder: conteudo/paginas
  - name: Conteúdo - Redirecionamentos
    x-folder: conteudo/redirecionamentos
  - name: Descontos
    x-folder: descontos
  - name: Leads
    x-folder: leads
  - name: Logística - Armazéns
    x-folder: logistica/armazens
  - name: Logística - Simular frete
    x-folder: logistica/simular-frete
  - name: Logística - CEP
    x-folder: logistica/cep
  - name: Logística - Embalagens
    x-folder: logistica/embalagens
  - name: Logística - Estoques
    description: >-
      O lojista pode ter um cadastro de múltiplos estoques onde ele pode
      associar posteriormente os SKUS com suas respectivas quantidades. Um
      exemplo prático é permitir que ele consiga trabalhar com estoques de
      fornecedores externos com diferentes prazos de entrega.
    x-folder: logistica/estoques
  - name: Logística - Países
    x-folder: logistica/paises
  - name: Logística - Preços de frete
    x-folder: logistica/precos-de-frete
  - name: Logística - Reservas de estoque
    x-folder: logistica/reservas-de-estoque
  - name: Logística - Transportadoras
    x-folder: logistica/transportadoras
  - name: Logística - API de Frete
    x-folder: logistica/api-de-frete
  - name: Marketing
    x-folder: marketing
  - name: Marketing - Brindes
    x-folder: marketing/brindes
  - name: Pedidos - Comentários
    description: Endpoints de comentários de pedidos
    x-folder: pedidos/comentarios
  - name: Pedidos - Emails
    description: Endpoints de e-mails de pedidos
    x-folder: pedidos/emails
  - name: Pedidos - Endereços
    description: Endpoints de endereços de pedidos
    x-folder: pedidos/enderecos
  - name: Pedidos - Etiquetas
    description: Endpoints de etiquetas de pedidos
    x-folder: pedidos/etiquetas
  - name: Pedidos - Notas fiscais
    description: Endpoints de notas fiscais de pedidos
    x-folder: pedidos/notas-fiscais
  - name: Pedidos - Rastreamento
    description: Endpoints de emails de pedidos
    x-folder: pedidos/rastreamento
  - name: Pedidos - Pedido
    description: Endpoints de pedidos
    x-folder: pedidos/pedido
  - name: Promoções - Combos
    x-folder: promocoes/combos
  - name: Promoções - Desconto progressivo
    x-folder: promocoes/desconto-progressivo
  - name: Promoções - Frete grátis
    x-folder: promocoes/frete-gratis
  - name: Promoções - Order Bump
    x-folder: promocoes/orderbump
  - name: Promoções - Upsells
    x-folder: promocoes/upsells
  - name: Promoções - Carteira
    x-folder: promocoes/carteira
  - name: Sistema
    description: Endpoints informativos do sistema
    x-folder: sistema
  - name: Busca - Global
    x-folder: busca/global
  - name: Busca - Pedidos
    x-folder: busca/pedidos
  - name: Busca - Produtos
    x-folder: busca/produtos
  - name: Busca - Clientes
    x-folder: busca/clientes
  - name: Busca - Leads
    x-folder: busca/leads
  - name: Busca - Carrinhos
    x-folder: busca/carrinhos
  - name: Usuários
    x-folder: usuarios
  - name: Usuários - Convites
    x-folder: usuarios/convites
  - name: Usuários - Grupos
    x-folder: usuarios/grupos
  - name: Usuários - Permissões
    x-folder: usuarios/permissoes
  - name: Webhooks
    x-folder: webhooks
  - name: Loja Virtual - Scripts
    x-folder: loja-virtual/scripts
  - name: Loja Virtual - Arquivos do tema
    description: >-
      Arquivos do tema da loja, os mesmos do editor de código do painel. As
      edições ficam no tema em preview até a publicação. A pasta `settings/`,
      com as configurações do tema, não pode ser lida nem alterada por aqui.
      Exige loja com acesso ao editor de código e a permissão
      `manage_open_code`. Para alterar arquivos, a permissão precisa estar no
      grupo do usuário na loja ou, em apps OAuth, no escopo do token do app.
      Usuários internos sem grupo na loja só leem. Limite de 60 requisições por
      minuto por usuário.
    x-folder: loja-virtual/arquivos-do-tema
  - name: Modulo - Recurso
    description: Modulo - Recurso
  - name: Marketplaces - Atributos
    description: Marketplaces - Atributos
  - name: Marketplaces - Anúncios
    description: Marketplaces - Anúncios
  - name: Links de Pagamento
    description: Links de Pagamento
  - name: Checkout - Contas bancárias
    description: Checkout - Contas bancárias
  - name: Checkout - Vendedores
    description: Checkout - Vendedores
  - name: Configurações - E-mails
    description: Configurações - E-mails
  - name: Configurações - Loja
    description: Configurações - Loja
  - name: Marketplaces - Categorias
    description: Marketplaces - Categorias
  - name: Marketplaces - Contas
    description: Marketplaces - Contas
  - name: Marketplaces - Lista de erros
    description: Marketplaces - Lista de erros
  - name: Marketplaces
    description: Marketplaces
  - name: Métricas - Cashback
    description: Métricas - Cashback
  - name: Promoções - Cashbacks
    description: Promoções - Cashbacks
  - name: Promoções - Cashback
    description: Promoções - Cashback
  - name: Promoções - Cupons de desconto
    description: Promoções - Cupons de desconto
  - name: Promoções - Produtos
    description: Promoções - Produtos
  - name: Filas
    description: Filas
paths:
  /{alias}/logistics/apis:
    post:
      tags:
        - Logística - API de Frete
      summary: Criar API de Frete
      description: Cria uma nova integração com API de Frete
      operationId: PostLogisticsApis
      parameters:
        - name: alias
          in: path
          description: Alias da loja
          required: true
          schema:
            type: string
      requestBody:
        description: Dados da API de Frete
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingApiRequest'
      responses:
        '201':
          description: API de Frete criada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingApi'
components:
  schemas:
    ShippingApiRequest:
      title: Criação de API de frete
      description: >-
        Representa os dados necessários para criar ou atualizar uma integração
        com API de frete
      required:
        - name
        - url
        - active
      properties:
        name:
          description: Nome da integração, único na loja.
          type: string
          example: Sua API de Fretes
        url:
          description: URL da sua API de frete consultada nas cotações, única na loja.
          type: string
          format: uri
          example: https://api.sua-api-de-fretes.com.br
        active:
          description: >-
            Indica se a integração está ativa e é consultada nas cotações de
            frete.
          type: boolean
          default: true
        headers:
          description: >-
            Headers HTTP enviados nas requisições à sua API de frete, no máximo
            5.
          type: array
          items:
            properties:
              key:
                description: Nome do header HTTP. Não pode repetir entre os headers.
                type: string
                example: Authorization
              value:
                description: Valor do header HTTP.
                type: string
                example: Bearer TOKEN
            type: object
      type: object
    ShippingApi:
      title: API de Frete
      description: Representa uma integração com API de frete
      properties:
        id:
          description: ID da integração com API de frete.
          type: integer
        active:
          description: >-
            Indica se a integração está ativa e é consultada nas cotações de
            frete.
          type: boolean
        healthy:
          description: Status de saúde da integração
          type: boolean
        name:
          description: Nome da integração, único na loja.
          type: string
          example: Sua API de Fretes
        url:
          description: URL da sua API de frete consultada nas cotações, única na loja.
          type: string
          format: uri
          example: https://api.sua-api-de-fretes.com.br
        hmac_key:
          description: >-
            Chave secreta gerada pela Yampi na criação da integração, usada para
            assinar as requisições enviadas à sua API de frete.
          type: string
          format: password
          writeOnly: true
        created_at:
          $ref: '#/components/schemas/BaseTimestamp'
        updated_at:
          $ref: '#/components/schemas/BaseTimestamp'
        headers:
          description: >-
            Headers HTTP enviados nas requisições à sua API de frete, no máximo
            5.
          type: array
          items:
            $ref: '#/components/schemas/ShippingApiHeader'
      type: object
    BaseTimestamp:
      description: >-
        Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário
        em que foi registrada.
      properties:
        date:
          description: Data e hora no formato YYYY-MM-DD H:MM:SS.
          type: string
          example: '2000-08-17 10:24:24'
        timezone_type:
          description: Número de representação do timezone.
          type: integer
          example: 3
        timezone:
          description: Fuso horário associado.
          type: string
          example: America/Sao_Paulo
      type: object
    ShippingApiHeader:
      title: Header da API de Frete
      description: Representa um header HTTP para a API de frete
      properties:
        key:
          description: Nome do header HTTP
          type: string
          example: Authorization
        value:
          description: Valor do header HTTP
          type: string
          example: Bearer TOKEN123
      type: object
  securitySchemes:
    ApiToken:
      type: apiKey
      name: User-Token
      in: header
    ApiSecretKey:
      type: apiKey
      name: User-Secret-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.