WS204 - Consultar status do pedido (REST)

Obter Status do Documento

Autenticação

  • As chamadas terão autenticação a nível de transporte (Basic Authentication).
  • Solicite o user / password ao administrador da conta.

Características

Título Obter status de um documento no sistema.
URL http://api.comprovei.com.br/api/1.1/documents/getStatus?cnpj&cpf&orderNumber
Exemplos de chamada http://api.comprovei.com.br/api/1.1/documents/getStatus?cpf=55411434467
http://api.comprovei.com.br/api/1.1/documents/getStatus?
cnpj=00007075000102
http://api.comprovei.com.br/api/1.1/documents/getStatus?orderNumber=1905880818
Método GET
Parâmetro URL cnpj CNPJ do cliente
cpf CPF do cliente

orderNumber Número do pedido
Parâmetro Data Sem parâmetros
Sucesso Code: 200
Content:
{
 "user_message": "Documento não encontrado.",
 "internal_message": "",
 "response_data": [],
 "code": 0,
 "more_info": "http://dev.comprovei.com.br/api"
}


Code: 200
Content:

{
 "user_message": "6 Documento(s) encontrado(s).",
 "internal_message": "",
 "response_data": [{
  "Documento": {
   "NumeroNF": "1586887",
   "NumeroPedido": "1905221534",
   "Nome": "MARC. NICLA LTDA ME",
   "Logradouro": "R. ANTONIO DE SIQUEIRA, 663,",
   "Bairro": "PQ. CRUZEIRO DO",
   "Cidade": "SAO PAULO",
   "Estado": "SP",
   "DataHora": null,
   "Foto": null,
   "CodigoStatus": "12",
   "Status": "Disponível",
   "Motorista": null,
   "Placa": null,
   "Itens": [{
    "Codigo": "000000000005044315",
    "Descricao": "MDF TOKAI 1F 2750X1850X6MM",
    "Quantidade": "7"
   }]
  }
 },{
  "Documento": {
   "NumeroNF": "1589045",
   "NumeroPedido": "1905233793",
   "Nome": "MARC. NICLA LTDA ME",
   "Logradouro": "R. ANTONIO DE SIQUEIRA, 663,",
   "Bairro": "PQ. CRUZEIRO DO",
   "Cidade": "SAO PAULO",
   "Estado": "SP",
   "DataHora": null,
   "Foto": null,
   "CodigoStatus": "12",
   "Status": "Disponível",
   "Motorista": null,
   "Placa": null,
   "Itens": [{
    "Codigo": "000000000005044315",
    "Descricao": "MDF TOKAI 1F 2750X1850X6MM",
    "Quantidade": "1"
   }]
  }
 },{
  "Documento": {
   "NumeroNF": "1591458",
   "NumeroPedido": "1905248776",
   "Nome": "MARC. NICLA LTDA ME",
   "Logradouro": "R. ANTONIO DE SIQUEIRA, 663,",
   "Bairro": "PQ. CRUZEIRO DO",
   "Cidade": "SAO PAULO",
   "Estado": "SP",
   "DataHora": null,
   "Foto": null,
   "CodigoStatus": "12",
   "Status": "Disponível",
   "Motorista": null,
   "Placa": null,
   "Itens": [{
    "Codigo": "000000000005044315",
    "Descricao": "MDF TOKAI 1F 2750X1850X6MM",
    "Quantidade": "1"
   },
   {
    "Codigo": "000000000005005284",
    "Descricao": "TUBO CABIDEIRO OVAL CURVO CR 1,5M",
    "Quantidade": "1"
   }]
  }
 },{
  "Documento": {
   "NumeroNF": "1592570",
   "NumeroPedido": "1905256080",
   "Nome": "MARC. NICLA LTDA ME",
   "Logradouro": "R. ANTONIO DE SIQUEIRA, 663,",
   "Bairro": "PQ. CRUZEIRO DO",
   "Cidade": "SAO PAULO",
   "Estado": "SP",
   "DataHora": null,
   "Foto": null,
   "CodigoStatus": "12",
   "Status": "Disponível",
   "Motorista": null,
   "Placa": null,
   "Itens": [{
    "Codigo": "000000000005051947",
    "Descricao": "MDF TRUFA TRAMA 2F 2750X1840X18MM",
    "Quantidade": "1"
   },
   {
    "Codigo": "000000000005052137",
    "Descricao": "FITA 22X0,45 TRUFA TRAMA 20M R",
    "Quantidade": "2"
   }]
  }
 },{
  "Documento": {
   "NumeroNF": "1605661",
   "NumeroPedido": "1905330249",
   "Nome": "MARC. NICLA LTDA ME",
   "Logradouro": "AVENIDA SAO MIGUEL 7710",
   "Bairro": null,
   "Cidade": "S. PAULO",
   "Estado": "SP",
   "DataHora": "13/08/2016",
   "Foto": null,
   "CodigoStatus": "6",
   "Status": "Não entregue",
   "Motorista": "Paulo",
   "Placa": "EFU7711",
   "Itens": [{
    "Codigo": "000000000005056929",
    "Descricao": "DOBR PIVOT INOX 100KG",
    "Quantidade": "2"
   }]
  }
 },{
  "Documento":
   "NumeroNF": "1617192",
   "NumeroPedido": "1905391896",
   "Nome": "MARC. NICLA LTDA ME",
   "Logradouro": "AVENIDA SAO MIGUEL 7710",
   "Bairro": null,
   "Cidade": "SAO PAULO",
   "Estado": "SP",
   "DataHora": null,
   "Foto": null,
   "CodigoStatus": "12",
   "Status": "Disponível",
   "Motorista": null,
   "Placa": null,
   "Itens": [{
    "Codigo": "000000000005056171",
    "Descricao": "SERRA TICOTICO DW300 220V DEWALT",
    "Quantidade": "1"
   }]
  }
 }],
 "code": 200,
 "more_info": "http://dev.comprovei.com.br/api"
}


Code: 200
Content:
{
 "user_message": "1 Documento(s) encontrado(s).",
 "internal_message": "",
 "response_data": [{
  "Documento": {
   "NumeroNF": "1704955",
   "NumeroPedido": "1905880818",
   "Nome": "TPS DIVIS. E REMANEJA",
   "Logradouro": "ESTRADA DA BALSA 860",
   "Bairro": null,
   "Cidade": "BARUERI",
   "Estado": "SP",
   "DataHora": "08/12/2016 11:13",
   "Foto": "https://comprovei.s3.amazonaws.com/producao/uploads/36/photo_36_5922_107174_62729.jpg?AWSAccessKeyId=AKIAJC52XTTZ7Q5QGLBQ&Expires=1481310193&Signature=X%2BlekVH0R0BasS6rRatuAMndFt0%3D",
   "CodigoStatus": "3",
   "Status": "Entregue",
   "Motorista": "Vasconcelos",
   "Placa": "BSF0758",
   "Itens": [{
    "Codigo": "000000000005056171",
    "Descricao": "SERRA TICOTICO DW300 220V DEWALT",
    "Quantidade": "1"
   }]
  }
 }],
 "code": 200,
 "more_info": "http://dev.comprovei.com.br/api"
}



Erro Code: 400
Content:
{
 "user_message": "Dados não foram preenchidos para busca.",
 "internal_message": "",
 "response_data": "",
 "code": 400,
 "more_info": "http://dev.comprovei.com.br"
}



Code: 401
Content:
{
 "user_message": "",
 "internal_message": "Usuário e/ou senha do desenvolvedor inválidos",
 "response_data": "",
 "code": 401,
 "more_info": "http://dev.comprovei.com.br"
}


Code: 402
Content:
{
 "user_message": "",
 "internal_message": "Sem dados de autenticação do desenvolvedor",
 "response_data": Tipo da conta,
 "code": 402,
 "more_info": "http://dev.comprovei.com.br"
}