Pedidos

Loja Virtual > API Ecommerce
GET /pedidos

Busca todos os pedidos cadastrados no sistema.

URL BASE:
https://xxxxxxxxxx/api/v1/pedidos/

Tipos de operações aceitas (method) GET

Parâmetros aceitos no método.
ParâmetroTipo de dadosDescriçãoObservações
idIntRetorna apenas um pedido através do seu ID.
Exemplo: /api/v1/pedidos/id/2		Não obrigatório
dataString(17)Retorna os pedidos com base no intervalo de sua data de cadastro.
Formato: DDMMYYYY-DDMMYYYY
Exemplo: /api/v1/pedidos/data/01122014-02052015
Exemplo: /api/v1/pedidos/data/01122014-02092015?pagina=2		Não obrigatório
statusString(60)Retorna os pedidos conforme seus status, que podem ser configurados em "Configurações > Status dos pedidos", na plataforma.
Exemplo: /api/v1/pedidos/status/Pagamento Aprovado		Não obrigatório
paginaIntNo caso do retorno ter mais de uma página, pode-se listar uma determinada página.
Exemplo: /api/v1/pedidos?pagina=2		Não obrigatório

Método GET

Exemplo em PHP utilizando cURL.
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://xxxxx/api/v1/pedidos/status/Pagamento Aprovado");
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "87a0-4se9-bt1a-6c1d9fe4ce2e");
$result = curl_exec ($ch);
curl_close ($ch);

Método GET

Exemplo em C# utilizando HttpWebRequest.
private string ConectAPI(string postxml)
{
 try
 {
     HttpWebRequest wq = (HttpWebRequest)WebRequest.Create("https://xxxxx/api/v1/pedidos/status/Pagamento Aprovado");
     wq.ContentType = "application/xml";
     string auth = Convert.ToBase64String(Encoding.UTF8.GetBytes("87a0-4se9-bt1a-6c1d9fe4ce2e"));
     wq.Headers[HttpRequestHeader.Authorization] = "Basic " + auth;
     if (postxml.Length > 0)
     {
         byte[] data = Encoding.UTF8.GetBytes(postxml);
         wq.ContentLength = data.Length;
         Stream POSTstream = wq.GetRequestStream();
         POSTstream.Write(data, 0, data.Length);
     }
     HttpWebResponse wp = (HttpWebResponse)wq.GetResponse();
     StreamReader rd = new StreamReader(wp.GetResponseStream(), Encoding.UTF8);
     return rd.ReadToEnd().ToString();
 }
 catch (Exception ex) { return ex.Message; }
}

Resposta em caso de sucesso.
<Pedidos xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <retorno>
    <Pedido>
      <cliente>
        <id_cliente>1527</id_cliente>
        <tipo_pessoa>f</tipo_pessoa>
        <empresa />
        <cnpj />
        <ie />
        <nome>João Maia</nome>
        <cpf>12345678910</cpf>
        <rg>1234567890</rg>
        <telefone>0000000000</telefone>
        <celular></celular>
      </cliente>
      <endereco_entrega>
        <endereco>Rua João Lucas</endereco>
        <numero>1234</numero>
        <complemento />
        <referencia />
        <bairro>Distrito Industrial</bairro>
        <cidade>Vinhedo</cidade>
        <estado>SP</estado>
        <cep>13280000 </cep>
      </endereco_entrega>
      <forma_entrega>
        <id_frete>2</id_frete>
        <nome_frete>Pac</nome_frete>
        <valor>16.20</valor>
        <peso_bruto>0.7</peso_bruto>
        <codigo_rastreamento />
      </forma_entrega>
      <forma_pagamento>
        <id_pagamento>6</id_pagamento>
        <nome_pagamento>PagSeguro</nome_pagamento>
        <numero_parcela>1</numero_parcela>
        <valor_parcela>1875.10</valor_parcela>
      </forma_pagamento>
      <itens>
        <Item>
          <id_produto>216</id_produto>
          <id_sku>216-88</id_sku>
          <nome>Vestido de festa Carter's-Tamanho : 24M</nome>
          <brinde>false</brinde>
          <qtd>1</qtd>
          <valor_unitario>159.90</valor_unitario>
          <valor_subtotal>159.90</valor_subtotal>
        </Item>
        <Item>
          <id_produto>178</id_produto>
          <id_sku>178</id_sku>
          <nome>Bicicleta Aro 26 SK 21 Marchas - Prata/Preta - Caloi </nome>
          <brinde>false</brinde>
          <qtd>1</qtd>
          <valor_unitario>1699.00</valor_unitario>
          <valor_subtotal>1699.00</valor_subtotal>
        </Item>
      </itens>
      <totais>
        <subtotal>1858.90</subtotal>
        <desconto_quantidade>0.00</desconto_quantidade>
        <desconto_pagamento>0</desconto_pagamento>
        <acrescimo_pagamento>0</acrescimo_pagamento>
        <cupom_desconto>0.00</cupom_desconto>
        <vale_presente>0.00</vale_presente>
        <taxa>0.00</taxa>
        <frete>16.20</frete>
        <total>1875.10</total>
      </totais>
      <id_pedido>1164</id_pedido>
      <data>2016-05-09 14:58:02</data>
      <status>Pagamento Aprovado</status>
      <pedido_processado>false</pedido_processado>
      <pagamento_completo>false</pagamento_completo>
      <email>teste@teste.com.br</email>
      <codigo_cupom />
      <codigo_vale_presente />
    </Pedido>
  </retorno>
  <status_api>OK</status_api>
  <total_registros>1</total_registros>
  <total_paginas>1</total_paginas>
  <pagina_atual>1</pagina_atual>
</Pedidos>

Resposta em caso de erro.
<Pedidos xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <retorno />
  <status_api>Nenhum registro foi encontrado.</status_api>
  <total_registros>0</total_registros>
  <total_paginas>0</total_paginas>
  <pagina_atual>1</pagina_atual>
</Pedidos>
 
 
Article ID: 210, , Modified: 11/13/2020 at 9:39 AM

Share this article