API - INTEGRAÇÃO - Em vigor a partir de: 01/10/2022

  1. URL BASE PRODUCAO:   https://oms.tpl.com.br/api
  2. URL BASE BETA:   https://oms.tpl.com.br/api

DESCRIÇÃO - 1.09.06

Busca a situação do pedido (detalhado com informações de transporte)

                      
                        Composição do JSON para envio:

{
*“auth" : chave obtida no método get/auth
*,"order" : {
“id" : identificação única do pedido retornando por put/order
,“number" : número do pedido (parâmetro opcional se usado id)
,"invoicenumber": podera usar numero da nota mais a serie (ex: 123456-0), obrigatoriamente - [numero
]-[serie
]
}
}

retorno com
{
“code" : inteiro
,"message" : texto
,"order" : {
“code" : inteiro
,"message" : text
,"info" : contem dados básicos do pedido
[
“info" : inteiro (ID único do pedido)
,"number" : text (corresponde ao numero do pedido)
,"date" : data (d/m/a) do pedido
,"prediction" : data (d/m/a) da previsão da entrega (depende do retorno da transportadora)
,"iderp" : permite retornar o id vindo do erp do cliente (quando houver)
,"note" : retorna dados - observacoes - informadas pelo cliente quando subiu o pedido
]
,"deliveryTo" : (conjunto de dados enviados em put/order)
,"shippment" :
{
“nick" : nome/apelido da transportadora
,"method" : método de envio (ex: PAC/SEDEX)
,"vol" : quantidade de volumes
,"tracker": SRO ou código do pedido junto a transportadora
,"trackerurl" : URL Enivix para rastreio do pedido
,"url" : Url da transportadora efetiva (este preenchimento depende de configuração)
}
,"wharehouse" : (informado em put/order)
,"items" : (objeto array de itens)
[
{
"sku" : sku do item
,"item" : sequencial do item
,"name" : descricao
,"amount" : quantidade
,"unity" : unidade
,"part" : identificacao do lote
,"cubedWeight" : peso cubado
,"serial" : vetor de texto com o numeros seriais
}
]
,"internalevents" :
[
{
"created": d/h criacao do registro logico
,"os": d/h insercao do pedido no wms
,"invoice": d/h recepcao da nota
,"startPicking": d/h inicio da separacao dos produtos
,"endPicking": d/h final da separacao dos produtos
,"startCheckout": d/h inicio do checkout
,"endCheckout": d/h final do checkout
,"dispatched": d/h do embarque
,"in_transit": d/h do em transito
,"out_for_delivery": d/h saiu para entrega
,"delivered": d/h entrega
,"fail": d/h falha na entrega
,"cancelled" : d/h do cancelamento do pedido (no OMS)
}
]
,"shippingevents":
[
{
"code" : varchar(20) – codigo do evento na transportadora (ver tabela situação micro)
,"message" : text – informação não tratada recebida pelo transportador
,"detalhe": text – informação não trataada recebida pelo transportador
,"complement": text - complemento da informacao
,"dtshipping" : data/hora da geração do evento na transportadora
,"internalcode" : inteiro – codigo macro do do evento na enivix o micro-status pode ser obervado na tag “code" (ver tabela situação macro)
}
]
,"invoice":
[
{
"number": numero do documento fiscal
,"series": serie do documento
,"emission": d/h da emissao da nota
,"weight": peso bruto
,"volumes": quantidade de volumes
,"value": valor da nota
,"key": chave da nota fiscal
,"document": base64 do xml da NFe
}
]
,"resend": {
"id": id do pedido original
,"order": numero do pedido original
,"inserted": data/hora que o pedido original foi inserido
,"situation": motivo do reenvio
,"by": email do usuario que gerou o reenvio
}
,"wms":{
"weight": peso do pedido,
,"weightm3": peso cubado do pedido,
,"volumes": numero de volumes
}
}

code
200: solicitação atendida, veja a TAG order->code
404: id não encontrado
500: auth invalido

order->code: (tabela situacao macro)
1: pedido recebido
3: aguarndo wms
5: aguardando picking
7: integrado wms
8: aguardando nota
10: picking digital realizado
20: picking fisico realizado
25: nota recebida
28: rastreador recebido (via cliente)
30: pedido separado para checkout
40: checkout realizado
50: despachado
60: coletado pela transportadora
70: em transito
75: saiu para entrega
80: houve alguma ocorrência com o pedido
90: entregue no destinatário
100: houve falha na entrega
110: pedido recusado
200: pedido cancelado
300: pedido devolvido a origem
400: pedido extraviado
411: roubo de carga
500: redespacho
510: registros da transportadora
1010: endereço incorreto
1020: destinatário ausente
1040: objeto aguardando retirada
1100: objeto não procurado