> ## 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. # Calcular frete de um carrinho > Calcula o custo de frete de forma pública utilizando o token do carrinho e o CEP de destino ## OpenAPI ````yaml get /{alias}/public/shipping/quotation/cart 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}/public/shipping/quotation/cart: get: tags: - Público - Frete summary: Calcular frete de um carrinho description: >- Calcula o custo de frete de forma pública utilizando o token do carrinho e o CEP de destino operationId: GetPublicShippingQuotationCart parameters: - name: alias in: path description: Alias da loja required: true schema: type: string - name: cart_token in: query description: Token do carrinho required: true schema: type: string example: abc123def456 - name: zipcode in: query description: CEP de destino required: true schema: type: string example: '14940000' responses: '200': description: Cálculo do frete realizado com sucesso content: application/json: schema: properties: data: description: >- Cotação de frete calculada para os itens do carrinho e o CEP de destino informados. properties: id: description: >- ID da opção de frete cotada, gravado como `shipment_service_id` no carrinho e no pedido quando a opção é selecionada. type: integer service_id: description: >- ID do serviço de frete (modalidade de envio) que gerou a cotação. type: integer example: 1 service_name: description: Nome interno do serviço de frete cotado. type: string example: Correios PAC service_display_name: description: >- Nome do serviço de frete exibido ao cliente no checkout. type: string example: Correios PAC service_type_id: description: >- ID do tipo de serviço de frete, que agrupa as modalidades de uma mesma transportadora. type: integer example: 1 service_type_name: description: >- Nome do tipo de serviço de frete, correspondente à transportadora responsável pela entrega. type: string example: Correios price: description: >- Valor do frete cobrado do cliente nesta opção, em reais; fica `0` quando o frete é grátis. type: number format: float example: 0 delivery_time: description: Prazo de entrega estimado da opção, em dias úteis. type: integer example: 18 quote_id: description: >- ID da cotação no gateway de frete, gravado como `shipment_quote_id` no pedido e enviado à transportadora na criação do envio. type: integer example: 3517956284 gateway: description: Alias do gateway de frete que retornou a cotação. type: string example: intelipost same_day_delivery: description: Indica se a opção entrega no mesmo dia da compra. type: boolean example: true same_day_delivery_until_at: description: >- Horário limite para o pedido entrar na entrega no mesmo dia. type: string zipcode: description: >- CEP de destino usado no cálculo do frete, com 8 dígitos e sem máscara. type: string example: '14940000' street: description: >- Logradouro do endereço de destino, quando a consulta do CEP retorna o dado. type: string example: null nullable: true neighborhood: description: >- Bairro do endereço de destino, quando a consulta do CEP retorna o dado. type: string example: null nullable: true city: description: Cidade do endereço de destino. type: string example: Ibitinga uf: description: Sigla da unidade federativa do endereço de destino. type: string example: SP source: description: >- Origem dos dados do CEP: `database` para o cache da Yampi, `frenet` ou `viacep` para consulta no provedor externo. type: string example: database city_id: description: >- ID da cidade de destino no cadastro de cidades da Yampi. type: integer example: 3 formated_delivery_time: description: >- Prazo de entrega já formatado para exibição no checkout. type: string example: até 18 dias úteis formated_price: description: >- Valor do frete já formatado para exibição no checkout, ou `Grátis` quando não há cobrança. type: string example: Grátis free_shipment: description: >- Indica se a opção ficou gratuita por uma regra de frete grátis da loja, definida por valor mínimo, UF e serviço de frete. type: boolean example: true real_price: description: >- Valor do frete calculado pela transportadora, antes das regras da loja que alteram o valor cobrado. type: number format: float example: 0 type: object type: object '400': description: Requisição inválida '422': description: Parâmetros obrigatórios não fornecidos '424': description: Serviço de frete temporariamente indisponível '429': description: Limite de requisições excedido security: [] components: 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.