A API V3 JÁ ESTÁ DISPONÍVEL
As integrações API v2 que já estão configuradas, seguirão funcionando temporariamente. |
Busca todos os pedidos
Recupera todos os pedidos cadastrados no sistema. Caso uma nota esteja vinculado com um pedido, serão retornados alguns dados sobre a mesma. Para mais informações, vide exemplo de retorno abaixo.
curl |
curl -X GET "https://bling.com.br/Api/v2/pedidos/json/" |
PHP |
$apikey = "{apikey}"; $outputType = "json"; $url = 'https://bling.com.br/Api/v2/pedidos/' . $outputType; $retorno = executeGetOrder($url, $apikey); echo $retorno; function executeGetOrder($url, $apikey){ $curl_handle = curl_init(); curl_setopt($curl_handle, CURLOPT_URL, $url . '&apikey=' . $apikey); curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER, TRUE); $response = curl_exec($curl_handle); curl_close($curl_handle); return $response; } |
C# |
public static void ExecuteGetOrder() { var request = HttpWebRequest.Create(@"https://bling.com.br/Api/v2/pedidos/json&apikey={apikey}"); request.ContentType = "application/json"; request.Method = "GET"; using (HttpWebResponse response = request.GetResponse() as HttpWebResponse) { if (response.StatusCode != HttpStatusCode.OK) Console.Out.WriteLine("Error. Server returned status code: {0}", response.StatusCode); using (StreamReader reader = new StreamReader(response.GetResponseStream())) { var content = reader.ReadToEnd(); if(string.IsNullOrWhiteSpace(content)) Console.Out.WriteLine("Empty Response"); else Console.Out.WriteLine("Response Body: \r\n {0}", content); } } } |
Parâmetro | Descrição | Tipo |
apikey |
apikey gerada no sistema | string |
historico |
Histórico de ocorrências | string (true/false) |
Filtros
Pode-se utilizar filtros para restringir o retorno de dados. Observe a tabela de possíveis filtros abaixo.
Filtro | Descrição | Tipo | Predicate |
dataEmissao |
Filtra por data de emissão do pedido no intervalo especificado | date (dd/mm/YYYY) | TO |
dataAlteracao |
Filtra por data de alteração do pedido no intervalo especificado | date (dd/mm/YYYY HH:ii:ss) | TO |
dataPrevista |
Filtra por data prevista do pedido no intervalo especificado | date (dd/mm/YYYY) | TO |
idSituacao |
Filtra pelos id's das situações dos pedidos | integer (segundo API de situações) | |
idContato |
Filtra pelo id do contato | integer |
curl -X GET "https://bling.com.br/Api/v2/pedidos/json/"
-G
-d "filters=dataEmissao[12/12/2013 TO 05/02/2014]; idSituacao[6,9]"
-d "apikey={apikey}"
Retorno
Em caso de sucesso, retornará todos os pedidos registrados, no mesmo modelo do exemplo a seguir. Caso contrário, retornará um erro.
A resposta será no formato especificado na URL (XML ou JSON).
Destino da parcela
O destino da parcela identifica qual objeto do sistema foi gerado no lançamento de contas. Esse objeto pode ser identificado pelo idLancamento
.
1 |
Conta a receber |
2 |
Ficha financeira |
3 |
Caixa |
Paginação
O limite do retorno do GET produtos é de 100 pedidos, para acessar as demais vendas, utilize a paginação seguindo o exemplo abaixo.
curl -X GET "https://bling.com.br/Api/v2/pedidos/page=2/json/"
-G
-d "apikey={apikey}"
Exemplo de retorno
{ "retorno":{ "pedidos":[ { "pedido":{ "desconto":"10,00", "observacoes":"Testando o campo observações do pedido", "observacaointerna":"Testando o campo observações internas do pedido", "data":"2017-07-28", "numero":"1", "numeroPedidoLoja":"100000001", "vendedor":"João da Silva", "valorfrete":"39.30", "totalprodutos":"399.60", "totalvenda":"428.90", "situacao":"Em Aberto", "loja": "123456789", "dataPrevista":"2017-07-28", "tipoIntegracao":"Magento", "cliente":{ "nome":"Organisys Software", "cnpj":"00.000.000/0000-1", "ie":"0000000000", "rg":"162788484", "endereco":"Rua Visconde de São Gabriel", "numero":"000", "complemento":"Sala 000", "cidade":"Bento Gonçalves", "bairro":"Cidade Alta", "cep":"95.700-000", "uf":"RS", "email":"teste@organisys.com.br", "celular":"", "fone":"(54) 2222-2222" }, "itens":[ { "item":{ "codigo":"CN01", "descricao":"Caneta 001", "quantidade":"120.00", "valorunidade":"1.68", "precocusto":"0.68", "descontoItem":"0.00", "un":"Pç", "pesoBruto": "0.520", "largura": "20", "altura": "18", "profundidade": "15", "unidadeMedida": "cm", "descricaoDetalhada": "" } }, { "item":{ "codigo":"23541", "descricao":"Caderno Capa 102", "quantidade":"20.00", "valorunidade":"9.90", "precocusto":"5.50", "descontoItem":"0.00", "un":"UN", "pesoBruto": null, "largura": null, "altura": null, "profundidade": null, "unidadeMedida": "cm" "descricaoDetalhada": "Caderno Avengers Infinity War" } } ], "parcelas":[ { "parcela":{ "idLancamento": "123456", "valor":"214.45", "dataVencimento":"2017-08-27 00:00:00", "obs":"Teste obs 1", "destino": "1", "forma_pagamento":{ "id":"1", "descricao":"Boleto bancário", "codigoFiscal":"15" } } }, { "parcela":{ "idLancamento": "123457", "valor":"214.45", "dataVencimento":"2017-09-27 00:00:00", "obs":"Teste obs 2", "destino": "1", "forma_pagamento":{ "id":"1", "descricao":"Boleto bancário", "codigoFiscal":"15" } } } ], "nota":{ "serie":"1", "numero":"012346", "dataEmissao":"2017-07-28 00:00:00", "situacao":"1", "chaveAcesso":"43140401056417000139550010000123461496923524", "valorNota": "428.90" }, "transporte":{ "transportadora":"Transportadora", "cnpj":"00.000.000/0000-1", "tipo_frete":"R",
"qtde_volumes": "2",
"peso_bruto": "1.500", "volumes":[ { "volume":{
"id": "6423805580", "idServico":"4523213", "servico":"PAC",
"codigoServico":"04669", "codigoRastreamento":"EC272330554BR", "dataSaida":"2017-07-28", "prazoEntregaPrevisto":"5", "valorFretePrevisto":"12.00", "valorDeclarado": "0.00", "remessa":{ "numero":"12345AAA", "dataCriacao":"2017-10-17" }, "dimensoes":{ "peso":"3.553", "altura":"20", "largura":"15", "comprimento":"20", "diametro":"0" }, "urlRastreamento":"https://www.exemplo.com.br/rastreio?q=EC272330554BR" } }, { "volume":{
"id": "6423805635", "idServico":"1231293", "servico":"SEDEX 10",
"codigoServico":"03158", "codigoRastreamento":"SX052413651BR", "dataSaida":"2017-07-28", "prazoEntregaPrevisto":"1", "valorFretePrevisto":"27.30", "remessa":null, "valorDeclarado": "80.52", "dimensoes":{ "peso":"9.958", "altura":"35", "largura":"30", "comprimento":"30", "diametro":"0" } } } ], "enderecoEntrega":{ "nome":"Organisys Software Entrega", "endereco":"Rua Assis Brasil", "numero":"222", "complemento":"", "cidade":"Bento Gonçalves", "bairro":"Centro", "cep":"95.700-00054", "uf":"RS" } } } } ] } }