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.
Como funciona
- 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. - Ajuste as tabelas de preço
Envie
rateseservice_paramsna criação ou na alteração. Os campos são objetos livres, que a plataforma devolve como foram gravados. - Use no pedido
O id do método é o
shipping_idque o pedido e o envio (Envios do pedido) referenciam.
Conceitos
Status
| Letra | Significado |
|---|---|
A | Ativo: aparece no checkout |
D | Desativado |
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étodo | Caminho | Para que serve | Página |
|---|---|---|---|
| GET | /api/v1.0/shippings | Listar os métodos | Métodos de frete |
| GET | /api/v1.0/shippings/{id} | Consultar um método | Métodos de frete |
| POST | /api/v1.0/shippings | Criar um método | Métodos de frete |
| PUT | /api/v1.0/shippings/{id} | Alterar um método | Métodos de frete |
| DELETE | /api/v1.0/shippings/{id} | Remover um método | Mé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
positionoucompany_ide esperar que gravem. Esses campos são aceitos no corpo, mas a criação e a alteração os ignoram. - Zerar o peso com
0na alteração. Na alteração, pesos iguais a 0 são tratados como "não enviado". - Achar que
inactiveedisabledsão status diferentes. Qualquer valor diferente deAdesativa; na leitura o valor volta sempre comoAouD.