VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa

Métodos de frete

Visão geral do cadastro de métodos de frete da loja na API compatível com a Venddor 1.0.

Um método de frete é uma forma de entrega que a loja oferece no checkout: "Motoboy", "Sedex", "Retirada na loja". O cadastro guarda o nome, a transportadora, o prazo, a faixa de peso e as tabelas de preço de cada método. Esta seção documenta as rotas que um sistema escrito para a Venddor 1.0 usa para ler e manter esse cadastro.

Pontos-chave
  • Todas as rotas exigem um usuário administrador (HTTP Basic e-mail:chave_de_api ou Bearer). Veja Autenticação.
  • A rota existe em /api/v1.0/shippings e em /api/shippings. Em /api/v1.0 os ids são UUID; na forma sem versão saem como números decimais em texto, como na Venddor 1.0 (veja Convenções).
  • O status do método é uma letra: A ativo, D desativado.
  • Valores de sobretaxa (a_surcharge) são decimais na moeda da loja; p_surcharge é percentual.
  • Erros têm o formato {"message":"...","status":4xx}.

Como funciona

  1. Cadastre o método

    Crie o método com POST /shippings, informando nome, transportadora e prazo. Ele nasce ativo se você não mandar o status.

  2. Ajuste as tabelas de preço

    Envie rates e service_params na criação ou na alteração. Os campos são objetos livres, que a plataforma devolve como foram gravados.

  3. Use no pedido

    O id do método é o shipping_id que o pedido e o envio (Envios do pedido) referenciam.

Conceitos

Status

LetraSignificado
AAtivo: aparece no checkout
DDesativado

Na escrita, qualquer valor diferente de A (sem diferenciar maiúscula) desativa o método.

Peso

min_weight e max_weight definem a faixa de peso atendida pelo método. 0 significa sem limite.

Rotas

MétodoCaminhoPara que servePágina
GET/api/v1.0/shippingsListar os métodosMétodos de frete
GET/api/v1.0/shippings/{id}Consultar um métodoMétodos de frete
POST/api/v1.0/shippingsCriar um métodoMétodos de frete
PUT/api/v1.0/shippings/{id}Alterar um métodoMétodos de frete
DELETE/api/v1.0/shippings/{id}Remover um métodoMétodos de frete

Erros comuns

  • Tratar a lista como filtrada no banco. A lista é montada inteira e a plataforma devolve só a janela pedida; o máximo por página é 250.
  • Mandar position ou company_id e esperar que gravem. Esses campos são aceitos no corpo, mas a criação e a alteração os ignoram.
  • Zerar o peso com 0 na alteração. Na alteração, pesos iguais a 0 são tratados como "não enviado".
  • Achar que inactive e disabled são status diferentes. Qualquer valor diferente de A desativa; na leitura o valor volta sempre como A ou D.

Próximos passos

Métodos de frete
Todas as rotas de /shippings.
Envios do pedido
Registrar o que foi despachado.
Anterior
Regras de imposto
Próxima
Rotas de métodos de frete
Nesta página
  • Como funciona
  • Conceitos
  • Status
  • Peso
  • Rotas
  • Erros comuns
  • Próximos passos