Seguir

Descrição dos métodos da API de pedidos

* Em anexo, uma versão deste artigo formatada e em pdf
* Uma collection do Postman com exemplos de requests estão anexadas a este artigo
* Acesse os anexos no rodapé.

 Este documento serve de apoio ao artigo https://eccosys.zendesk.com/hc/pt-br/articles/236138027

    O fluxo padrão para inclusão de pedidos segue o diagrama abaixo. Basicamente é necessário cadastrar o cliente e incluir o pedido com as informações de endereço e itens com o id dos produtos no Eccosys. Após a inclusão, é necessário verificar a situação do pedido até ela ser atendida (situacao = 1). Quando a nota fiscal do pedido estiver gerada, além da situação do pedido ser atendido, o atributo idNotaFiscalRef terá o id da nota fiscal. Uma consulta em /nfes/{id da nota} pode ser realizada para obter informações da nota fiscal.

 

Código de situações dos pedidos

-1

0

1

2

3

4

Aguardando pagamento

Em aberto

Atendido

Cancelado

Pronto para picking

Pagamento em análise

O pagamento não foi informado

O pedido está pago e está sendo manipulado/processado

O pedido já teve picking realizado e o processo está concluído

O pedido foi cancelado (isso libera estoque pendente)

O pedido está pronto para o picking e ser despachado

O pedido está aguardando resposta da plataforma sobre pagamento



Consulta de pedidos

É possível consultar todos os pedidos cadastrados no Eccosys utilizando os filtros de paginação $count e $offset. Também é possível aplicar filtros de data da criação do pedido $fromDate e $toDate.

 

Consulta de pedidos por situação

O integrador pode consultar pedidos de uma determinada situação específica. A API retornará as informações básicas (id, numeroPedido, situacao e data) para a chamada /pedidos/status/{situacao} ou todas as informações do pedido (sem o detalhe) para a chamada /pedidos/situacao/{situacao}

 

Consulta de um pedido

Para consultar detalhes de um pedido como toda a informação do pedido, além do Canal de Venda, informação de coleta, outro endereço, etc basta se fazer a chamada /pedidos/{numeroPedido ou id}. Também é possível consultar o pedido através do número da ordem de compra (número do pedido na plataforma) através de /pedidos/numeroOC={numeroNaPlataforma}

 

Pedido com outro endereço

As informações do endereço de entrega estão na entidade de pedido quando o endereço de entrega selecionado é o mesmo do cadastro do cliente. Se o pedido contiver um endereço de entrega diferente daquele cadastrado para o cliente, então o pedido conterá a flag opcEnderecoDiferente = 'S'. SEMPRE que esta flag estiver ativa, o pedido listado conterá o atributo _OutroEndereco definido com as informações de endereço.

Da mesma forma, quando um pedido for incluído ou editado com a intenção de ter outro endereço de entrega, deve-se passar a flag opcEnderecoDiferente = 'S' e também, as informações do endereço no atributo _OutroEndereco.

 

Consulta da transportadora

    A transportadora definida no pedido está especificada no atributo 'transportador' como uma string contendo o nome da transportadora, conforme cadastrada. Para consultar as transportadoras, é preciso fazer uma chamada para /transportadoras. Para consultar detalhes da transportadora do pedido, deve-se consultar com /pedidos/{numeroPedido ou id}/transportadora.

 

Correios

    Caso a transportadora do pedido for Correios, o atributo 'transportador' terá o nome do serviço utilizado dos correios conforme cadastrado em /transportadoras. Porém, neste caso, terá associado o id do tipo do frete, proveniente do cadastro de transportadoras, no atributo 'formaFrete'.

Exemplo:

 

pedido/{id}

/transportadoras

{

  "numeroPedido":123

  "transportador" : "correios pac",

  "formaFrete: 666

}

{

  "id": 999,

  "nome": "correios pac",

  "_FormasDeEnvio" : [

     "id" : 900,

     "idTransportadora": 999,

     "tipo": "correios",

     "_TipoFrete" : [


          "id" : 666,

          "descricao" : "PAC"

     ]

  ]



Canais de Venda

    Os pedidos podem ter um canal de venda associado que é geralmente, um marketplace. Quando o pedido possuir um canal de venda, este será representado pelo atributo "canalDeVenda" e o id será representado pelo atributo "idMarketplaceIntegrado". Para inserir esta informação a um pedido, basta definir o atributo "idMarketplaceIntegrado". Os ids destes podem ser consultados em https://{empresa}.eccosys.com.br/api/canaisDeVenda.

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 0
Tem mais dúvidas? Envie uma solicitação

0 Comentários

Por favor, entre para comentar.
Powered by Zendesk