Bem vindo!

Guia da API

Webhook

key

Autenticação

navigate_next

store

Centro de Distribuição

navigate_next

price_change

Cotação

navigate_next

POST

api/v1/cotacao

Método para criar uma nova cotação de frete

navigate_next

GET

api/v1/cotacao/{idCotacao}

Retorna cotação de frete

navigate_next

GET

api/v1/naoentregue

Retorna lista cotações não entregue

navigate_next

GET

api/v1/cep/{cep}

Retorna endereço pelo CEP

navigate_next

GET

api/v1/canais

Retorna lista de canais de
Marketplace integrados

navigate_next

GET

api/v1/logCotacaoFila

Cotações das últimas 12 horas em fila.

navigate_next

view_timeline

Fila de Eventos

navigate_next

local_mall

Pedido

navigate_next

POST

api/v1/pedido/novo

Cria um pedido de envio ou reversa

navigate_next

PUT

api/v1/nfe/{chave nfe}

Insere ou altera uma nota fiscal eletrônica

navigate_next

PUT

api/v1/pedido/altera/{filtro}/{valor}

Altera dados do pedido

navigate_next

PUT

api/v1/situacao/{opção}

Atualiza situação do pedido
para cancelado ou entregue.

navigate_next

POST

api/v1/ocorrencia/{filtro}/{valor}

Insere nova ocorrência
de transporte. (rastreio)

navigate_next

GET

api/v1/pedido/{filtro}/{valor}

Consulta detalhes do pedido
por número, chave de NF etc.

navigate_next

GET

api/v1/rastreio/{filtro}/{valor}

Retorna resumo do pedido e
detalhes do acompanhamento de entrega.

navigate_next

GET

api/v1/pedidos

Consulta lista de pedidos

navigate_next

GET

api/v1/lista/status

Retorna lista de status do pedido

navigate_next

GET

api/v1/lista/ocorrencia

Lista de ocorrência padrão proceda e correios.

navigate_next

GET

api/v1/lista/cobrancacomplementar

Retorna lista de cobranças complementar

navigate_next

GET

api/v1/retornactexml/{filtro}/{valor}

Retorna o xml do CTe

navigate_next

document_scanner

PLP

navigate_next

POST

api/v1/plp/novo

Cria uma pré-lista de postagens (PLP)

navigate_next

PUT

api/v1/plp/inclui/{idPLP}

Inclui Notas Fiscais Eletrônicas (NFes)
em uma PLP pendente

navigate_next

DELETE

api/v1/plp/delete/{filialERP}/{idPLP}

Remova itens de uma PLP
ou exclua a PLP por completo.

navigate_next

PUT

api/v1/plp/fecha/{filialERP}/{idPLP}

Feche uma pré-lista de postagens (PLP)
para impressão.

navigate_next

GET

api/v1/plp/consulta/{filialERP}/{idPLP}

Retorna dados de uma
pré-lista de postagens (PLP)

navigate_next

GET

api/v1/plp/lista

Retorne lista de PLPs por status

navigate_next

GET

api/v1/etiquetas?idPLP={idPLP}

Lista os modelos de etiquetas cadastrados

navigate_next

GET

api/v1/etiqueta/{idModelo}/{filialERP}/{idPLP}

Retorna PDF da etiqueta pelo
modelo selecionado

navigate_next

inventory_2

Produto

navigate_next

token

Token de Navegação

navigate_next

local_shipping

Transportadora

navigate_next