Endpoint:
• www.jadlog.com.br/embarcador/api/pedido/incluir
Método:
• POST
Header:
• Content-Type: application/json
• Authorization:
[{"key":"Authorization","value":"Bearer eyJBNHciOiJIUzI1NiJ9.eyJqdPOPOiI2KzMLACJ9.fC7XN-f2e7QIppp42aE_nuqQY12phUASY3iPMqH6x0Y","description":""}]
| Coluna | Descrição |
Ele (Elemento) | E – Elemento |
| G – Grupo | |
| A – Array | |
| GA – Grupo composto por um Array |
Coluna | Descrição |
Ocorre | 1-1 = Obrigatório |
0-1 = Não obrigatório |
Modalidades | |||
Descrição | Código | Modal | Observações |
EXPRESSO | 0 | Aéreo | |
.PACKAGE | 3 | Rodoviário | |
RODOVIÁRIO | 4 | Rodoviário | |
ECONÔMICO | 5 | Rodoviário | |
DOC | 6 | Rodoviário | |
CORPORATE | 7 | Aéreo | |
.COM | 9 | Aéreo | |
INTERNACIONAL | 10 | Aéreo | |
CARGO | 12 | Aéreo | |
EMERGÊNCIAL | 14 | Rodoviário | |
PICKUP | 40 | Aéreo | Obrigatório informar o CdPickupDes |
PEDIDO INCLUIR | ||||||||
# | Campo | Nível | Descrição | Ele | Tipo | Tam | Ocorr. | Observações |
1 | conteudo | 0 | Descrição do conteúdo da remessa | E | string | 80 | 1-1 | |
2 | pedido | 0 | Número do pedido do cliente | A | array[string] | 1-1 | Deve conter ao menos 1 pedido. ( ex. “pedido”: [“123456”] ) | |
3 | totPeso | 0 | Peso total do envio | E | double | 1-1 | Em KG (ex. “totPeso”: 1.2) | |
4 | totValor | 0 | Valor total das mercadorias do envio | E | double | 1-1 | ||
5 | obs | 0 | Observação | E | string | 200 | 0-1 | |
6 | modalidade | 0 | Modalidade do envio Jadlog | E | integer | 1-1 | Disponibilizado pela Jadlog | |
7 | contaCorrente | 0 | Conta corrente | E | string | 6 | 0-1 | Disponibilizado pela Jadlog (só preencher se for cliente correntista – ex.0123456) |
8 | tpColeta | 0 | Tipo da solicitação | E | string | 1-1 | S=Solicitação eletrônica (Aguardando remessa fisica ); K=Solicitação de coleta no remetente; | |
9 | tipoFrete | 0 | Tipo do Frete | E | integer | 0-1 | 0-Normal; 1-Subcontratação; 2-Redespacho; 3- Redespacho Intermediário; | |
10 | cdUnidadeOri | 0 | Código da unidade de origem | E | string | 9 | 0-1 | |
11 | cdUnidadeDes | 0 | Código da unidade de destino | E | string | 9 | 0-1 | |
12 | cdPickupOri | 0 | Código do Pickup de origem | E | string | 7 | 0-1 | |
13 | cdPickupDes | 0 | Código do Pickup de destino | E | string | 7 | 0-1 | Obrigatório quando remessa for retirada de um Pickup |
14 | nrContrato | 0 | Numero do contrato Jadlog | E | integer | 0-1 | Só preencher se o número de contrato de três digitos for disponibilizado pela Jadlog, caso contrário deixar vazio – ex.123) | |
15 | servico | 0 | Tipo do serviço | E | integer | 0-1 | 0=sem PIN; 1=com PIN; 2=Dropoff | |
16 | shipmentId | 0 | Numero de envio da Jadlog | E | string | 14 | 0-1 | Utlizado somente quando cliente controlar numeração. |
17 | vlColeta | 0 | Valor da coleta | E | double | 0-1 | Somente se houver acordo sobre valor de coleta | |
18 | rem | 0 | Grupo de dados do remetente | G | 1-1 | |||
19 | nome | 1 | Nome do remetente | E | string | 60 | 1-1 | |
20 | cnpjCpf | 1 | CNPJ ou CPF do remetente | E | string | 14 | 1-1 | |
21 | ie | 1 | Inscrição Estadual do remetente | E | string | 20 | 0-1 | |
22 | endereco | 1 | Endereço do remetente | E | string | 80 | 1-1 | |
23 | numero | 1 | Numero do endereço do remetente | E | string | 10 | 0-1 | |
24 | compl | 1 | Complemento do endereço do remetente | E | string | 20 | 0-1 | |
25 | bairro | 1 | Bairro do remetente | E | string | 60 | 1-1 | |
26 | cidade | 1 | Cidade do remetente | E | string | 60 | 1-1 | |
27 | uf | 1 | Estado do remetente | E | string | 2 | 1-1 | |
28 | cep | 1 | Cep do remetente | E | string | 8 | 1-1 | |
29 | fone | 1 | Telefone do remetente | E | string | 20 | 0-1 | Padrão: (11) 999999999 |
30 | cel | 1 | Celular do remetente | E | string | 20 | 0-1 | Padrão: (11) 999999999 |
31 | 1 | Email do remetente | E | string | 100 | 0-1 | ||
32 | contato | 1 | Nome do contato no remetente | E | string | 50 | 0-1 | |
33 | des | 0 | Grupo de dados do destinatário | G | 1-1 | |||
34 | nome | 1 | Nome do destinatário | E | string | 60 | 1-1 | |
35 | cnpjCpf | 1 | CNPJ ou CPF do destinatário | E | string | 14 | 1-1 | |
36 | ie | 1 | Inscrição Estadual do destinatário | E | string | 20 | 0-1 | |
37 | endereco | 1 | Endereço do destinatário | E | string | 80 | 1-1 | |
38 | numero | 1 | Numero do endereço do destinatário | E | string | 10 | 0-1 | |
39 | compl | 1 | Complemento do endereço do destinatário | E | string | 20 | 0-1 | |
40 | bairro | 1 | Bairro do destinatário | E | string | 60 | 1-1 | |
41 | cidade | 1 | Cidade do destinatário | E | string | 60 | 1-1 | |
42 | uf | 1 | Estado do destinatário | E | string | 2 | 1-1 | |
43 | cep | 1 | Cep do destinatário | E | string | 8 | 1-1 | |
44 | fone | 1 | Telefone do destinatário | E | string | 20 | 0-1 | Padrão: (11) 999999999 |
45 | cel | 1 | Celular do destinatário | E | string | 20 | 0-1 | Padrão: (11) 999999999 |
46 | 1 | Email do destinatário | E | string | 100 | 0-1 | ||
47 | contato | 1 | Nome do contato no destinatário | E | string | 50 | 0-1 | |
48 | dfe | 0 | Grupo dos documentos fiscais (Nfe/Cte/Etc) | GA | 1-10 | |||
49 | danfeCte | 1 | Numero da DANFE ou CTE | E | string | 44 | 0-1 | Obrigatório quando for envio com NFE. |
50 | nrDoc | 1 | Numero do documento | E | string | 20 | 0-1 | em casos de declaração, preencher com um número alfanumério – ex.DEC123 |
51 | serie | 1 | Serie do documento | E | string | 3 | 0-1 | Obrigatório quando for envio com NFE. |
52 | valor | 1 | valor declarado | E | double | 0-1 | ||
53 | cfop | 1 | CFOP da Nfe | E | string | 4 | 0-1 | Obrigatório quando for envio com NFE. |
54 | tpDocumento | 1 | Tipo do documento fiscal | E | integer | 1-1 | 0=Declaracao; 1=NF; 2=NFE; 4=CTE; | |
55 | volume | 0 | Grupo de dados dos volumes | GA | 1-10 | |||
56 | altura | 1 | Altura do volume | E | integer | 0-1 | Em centímetros (CM) | |
57 | comprimento | 1 | Comprimento do volume | E | integer | 0-1 | Em centímetros (CM) | |
58 | largura | 1 | Largura do volume | E | integer | 0-1 | Em centímetros (CM) | |
59 | peso | 1 | Peso do volume | E | double | 0-1 | Em kilogramas(KG). Exemplo: “peso” : 1.2 | |
60 | identificador | 1 | Identificador do cliente para o volume | E | string | 40 | 0-1 | |
Código de inclusão de pedido
{
"conteudo":"PENDRIVE E MOUSE", "pedido":[ "123456","654321"],
"totPeso":1, "totValor":25.52, "obs":"OBS XXXXX",
"modalidade":3, "contaCorrente":"000001", "tpColeta":"K", "tipoFrete":0, "cdUnidadeOri":"1", "cdUnidadeDes":null, "cdPickupOri":null, "cdPickupDes":"BR00001", "nrContrato":12345, "servico":1, "shipmentId":null, "vlColeta":null,
"rem":{
"nome":"NOME DO REMETENTE", "cnpjCpf":"00000000000000",
"ie":null,
"endereco":"RUA DO REMETENTE",
"numero":"123", "compl":null, "bairro":"BAIRRO", "cidade":"SAO PAULO", "uf":"SP",
"cep":"01310000", "fone":"11 99999999",
"cel":"11 999999999",
"email":"email@jremetente.com.br", "contato":"NOME CONTATO"
},
"des":{
"nome":"NOME DO DESTINATARIO", "cnpjCpf":"00000000000000",
"ie":null,
"endereco":"RUA DO DESTINATARIO",
"numero":"321", "compl":null, "bairro":"BAIRRO", "cidade":"SAO PAULO", "uf":"SP",
"cep":"01310000", "fone":"11 99999999",
"cel":"11 999999999",
"email":"email@destinatario.com.br", "contato":"NOME CONTATO"
},
"dfe":[
{
"cfop":"6909", "danfeCte":"00000000000000000000000000000000000000000000", "nrDoc":"00000000",
"serie":"0", "tpDocumento":2, "valor":20.2
},
{
"cfop":"6909", "danfeCte":"00000000000000000000000000000000000000000000", "nrDoc":"00000000",
"serie":"0", "tpDocumento":2, "valor":13.1
}
],
"volume":[
{
"altura":10, "comprimento":10, "identificador":"1234567890", "largura":10,
"peso":1.0
},
{
"altura":8, "comprimento":8,
"identificador":"0987654321", "largura":10,
"peso":1.0
}
]
Código de inclusão de pedido
Quer seja bem-sucedido ou não, a API JADLOG enviará um retorno para o embarcador.
PEDIDO INCLUIR – RETORNO | ||||||||
| # | Campo | Nível | Descrição | Ele | Tipo | Tam | Ocorr. | Observações |
| 1 | codigo | 0 | ID da solicitação | E | string | 13 | 0-1 | Preenchido se inclusão ocorreu com sucesso |
| 2 | shipmentId | 0 | Numero Jadlog específico para o cliente | E | string | 14 | 0-1 | Preenchido se inclusão ocorreu com sucesso |
| 3 | status | 0 | Descrição do processamento | E | string | 100 | 1-1 | |
| 4 | erro | 0 | Grupo de erro | G | 0-1 | Preenchido se ocorreu insucesso na inclusão | ||
| 5 | id | 1 | Código identificador do erro | E | integer | 1-1 | ||
| 6 | descricao | 1 | Descrição do erro | E | string | 200 | 1-1 | |
| 7 | detalhe | 1 | Detalhamento do erro | E | string | 1000 | 0-1 | |
| 8 | etiqueta | 0 | Grupo Etiqueta | G | 0-1 | Preenchido se habilitado etiqueta | ||
| 9 | arquivo | 1 | PDF de etiqueta em byte[] | E | byte[] | 0-1 | Se habilitado para gera o PDF com a etiqueta | |
| 10 | erro | 1 | Grupo de erro arquivo PDF | G | 0-1 | Preenchido se ocorreu erro ao gerar PDF ( item 8) | ||
| 11 | id | 2 | Código identificador do erro | E | integer | 1-1 | ||
| 12 | descricao | 2 | Descrição do erro | E | string | 200 | 1-1 | |
| 13 | detalhe | 2 | Detalhamento do erro | E | string | 1000 | 0-1 | |
| 14 | volume | 1 | Dados da etiqueta por volume | GA | 1-10 | Preenchido se habilitado dados da etiqueta | ||
| 15 | seqVolume | 2 | Sequencial do volume | E | integer | 1-1 | ||
| 16 | codbarra | 2 | Informação do codigo de barra | E | string | 29 | 1-1 | |
| 17 | lastMile | 2 | Informação da última milha | E | string | 6 | 1-1 | |
| 18 | rua | 2 | Rua (sorter) | E | string | 1 | 1-1 | |
| 19 | posicao | 2 | Posição (sorter) | E | string | 2 | 1-1 | |
| 20 | prioridade | 2 | Prioridade de entrega | E | integer | 1-1 | ||
| 21 | rota | 2 | Rota de entrega | E | string | 25 | 1-1 | |
| 22 | unidadeDestino | 2 | Unidade de entrega | E | string | 40 | 1-1 | |
| 23 | unidadeDestino | 2 | Unidade de entrega | E | string | 40 | 1-1 | |
Retorno com sucesso
{
"codigo":"123456", "shipmentId":"00000000000000",
"status”: “Solicitação inserida com sucesso."
}
Retorno com erro
{
"status”: “Erro ao inserir solicitação.", "erro":{
"descrição”: “Destino fora da área de cobertura", "id":-2
}
}