Introdução

Este guia de referência explica como usar a API para executar todas os seus recursos.

O guia está organizado por tipo de recurso. Para cada tipo de recurso, o guia lista uma ou mais representações de dados no formato de objetos JSON.

Cadastro

Para acessar a API e solicitar o seu token você precisa de uma Conta do Minhas Encomendas.

Se você já possui uma conta, basta acessar a página do token para gerá-lo.

Recursos

A lista abaixo identifica os diferentes tipos de recursos que você pode recuperar usando a API.

Recursos
Encomendas
Lista Retorna uma lista de encomendas que correspondem aos parâmetros de solicitação.
Adiciona Adiciona uma nova encomenda conforme parâmetros de solicitação.
Consulta Retorna os dados cadastrados que podem ser alterados de uma encomenda.
Edita Altera dados cadastrados que podem ser alterados de uma encomenda.
Deleta Exclui uma encomenda.
Arquiva Arquivar uma encomenda.
Módulo Vendas
Consulta Consulta dados do módulo vendas
Edita Edita dados do módulo vendas

Tratamento de Erros

Todos os serviços disponibilizados na API possuem um formato padrão para os erros encontrados.

{
  status: "error",
  msg_error: string
}

Propriedades

A tabela a seguir define as propriedades que aparecem numa resposta de erro:

Propriedade
status string
Status informando que houve um erro
msg_error string
Mensagem de Erro

Bibliotecas Cliente

Bibliotecas cliente disponíveis em várias linguagens de programação podem simplificar sua implementação da API de acesso do Minhas Encomendas.


Comentários