getOrders

GET /tmwxdapi/getOrders

Retorna os pedidos da loja (limite de 50 pedidos), por ordem decrescente de número.

  • id Número(s) do(s) Pedido(s). Poderá definir mais de um, separados por vírgula. Quando informado, a pesquisa ignorará os parâmetros plataforma, status , dataIni e dataFim.

    Exemplos:
    GET /tmwxdapi/getOrders?id=1002,1003
  • plataforma Filtra os pedidos criados pela plataforma determinada (vide setOrder).

    Exemplos:
    GET /tmwxdapi/getOrders?plataforma=meu_erp
  • status Filtra os pedidos pelo seu status (situação). Os status possíveis são:
    Aguardando Pagamento Rejeitado Pela Operadora Pendente Pagamento Parcial Pagamento Confirmado Embalado Enviado Concluído Cancelado

    Obs: Os status marcados aqui nesta cor são personalizados e podem não existir em todas as lojas. Os demais são status de sistema.

    Exemplos:
    GET /tmwxdapi/getOrders?status=Cancelado
  • dataIni Pedidos feitos a partir de... (Y-m-d)
    dataFim Pedidos feitos a até... (Y-m-d)

    Exemplos:
    GET /tmwxdapi/getOrders?dataIni=2017-03-01&dataFim=2017-03-31
  • qtdePedidos Mostra apenas a quantidade de pedidos. Quando informado, ignorará os parâmetros campos, inicio e limite

    Exemplos:
    GET /tmwxdapi/getOrders?dataIni=2017-03-01&dataFim=2017-03-31
  • campos Limitar os campos que serão retornados. Separe os campos desejados por vírgula.
    Campos permitidos: id, plataforma, frete, cliente, compradorNome, compradorCPF, entrega, valorFrete, parcelasQtde, parcelasValor, valorTotalSemFrete, valorTotal, valorDesconto, formaPgto, status, codRastreio, dataPedido, dataPgto, dataEnvio, dataConcluido, obs, nf e/ou produtos.

    Exemplos:
    GET /tmwxdapi/getOrders?campos=id,nome,tel
  • inicio Indica a partir de qual registro deve começar a listagem (registro inicial: 0).
    limite Quantidade de pedidos retornados (máximo permitido: 50).

    Exemplos:
    GET /tmwxdapi/getOrders?inicio=40&limite=20

Quando sua loja tiver integração com a PATTIO e um pedido tiver usado essa integração, o campo frete trará o valor "pattio", e haverá o campo extra pattio com as informações do frete, bem como o ID da ordem gerada na PATTIO.

Para todos os outros casos, o campo frete será númerico com o ID do frete, cujos detalhes podem ser recuperados com calculateShipping.

GET /tmwxdapi/getOrders?campos=id,status,valorTotal&limite=2

Dados vindos da API na  Loja Modelo
Acesse o Teste:  Runscope
Response (JSON):

{
    "status": true,
    "pedidos": [
        {
            "id": "1123",
            "status": "Aguardando Pagamento",
            "valorTotal": 9344.99
        },
        {
            "id": "1122",
            "status": "Cancelado",
            "valorTotal": 22239.78
        }
    ]
}

GET /tmwxdapi/getOrders?dataIni=2016-01-01&dataFim=2017-12-31&qtdePedidos

Dados vindos da API na  Loja Modelo
Acesse o Teste:  Runscope
Response (JSON):

{
    "status": true,
    "pedidos": [
        {
            "qtdePedidos": 104
        }
    ]
}
GET /tmwxdapi/getOrders?id=1117
GET /tmwxdapi/calculateShipping?id=3
GET /tmwxdapi/getClients?id=9
GET /tmwxdapi/getProducts?ref=TESTE01-64GB,TESTE11,TESTE12

Dados vindos da API na  Loja Modelo
Acesse os Testes (Runscope):
    •  Pedido Frete Cliente Produtos do Pedido

Retorno de Pedido

{ "status": true, "pedidos": [ { "id": "1117", "plataforma": "177.67.159.205", "frete": "3", "cliente": "9", "compradorNome": "Daniel da Silva Bispo", "compradorCPF": "308.415.077-66", "entrega": { "cep": "12247750", "logradouro": "Rua dos Acantos", "num": "247", "comp": "", "bairro": "Jardim das Flores", "cidade": "São José dos Campos", "uf": "SP", "ibge": "3549904", "recebedor": "Emilly Santana de Paula", "tel": "(12) 3847-5541" }, "valorFrete": 0, "parcelasQtde": "1", "parcelasValor": "51472.41", "valorTotalSemFrete": 51472.41, "valorTotal": 51472.41, "valorDesconto": 5719.16, "formaPgto": "bradesco", "status": "Pagamento Confirmado", "codRastreio": null, "dataPedido": "2017-03-01 09:07:09", "dataPgto": "2017-03-01 09:09:32", "dataEnvio": null, "dataConcluido": null, "obs": "", "nf": null, "produtos": { "valor": 57191.57, "itens": [ { "id": "1", "ref": "TESTE01-64GB", "nome": "iPhone 5 Apple Branco e Memória Interna | Memoria: 64GB", "conId": "2", "qtde": "2", "valor": 8179.14, "valorTotal": 16358.28 }, { "id": "11", "ref": "TESTE11", "nome": "Surface Windows 8 display Full HD com 1920 x 1080px", "conId": null, "qtde": "1", "valor": 9333.32, "valorTotal": 9333.32 }, { "id": "12", "ref": "TESTE12", "nome": "Xbox One com Kinect e um Controle", "conId": null, "qtde": "3", "valor": 10499.99, "valorTotal": 31499.97 } ] } } ] }

Retorno de Frete

{ "status": true, "fretes": [ { "id": "3", "frete": "Retirar no Local", "codCorreios": null, "faixaIni": "0", "faixaFim": "99999999", "ordem": "99", "ativo": "true" } ] }

Retorno de Cliente

{ "status": true, "clientes": [ { "id": "9", "nome": "Emilly Santana de Paula", "pessoa": "FIS", "finalidade": "Consumidor", "cpfCnpj": "608.249.691-46", "rgIe": "242876663", "sexo": "M", "dataNF": "1981-03-10", "cep": "12247750", "logradouro": "Rua dos Acantos", "num": "247", "comp": "", "bairro": "Jardim das Flores", "cidade": "São José dos Campos", "uf": "SP", "ibge": "3549904", "tel": "(12) 3847-5541", "cel": "", "email": "kkamillepimentinha@gmail.com", "cadastro": "2016-06-14 13:31:58" } ] }

Retorno de Produtos do Pedido

{ "status": true, "produtos": [ { "id": "1", "ref": "TESTE01-64GB", "marca": "Apple", "gtin": "", "secao": "Celulares > iOS", "secao2": null, "secao3": null, "nome": "iPhone 5 Apple Branco e Memória Interna | Memoria: 64GB", "ativo": true, "lancamento": true, "destaque": false, "freteGratis": false, "importado": false, "valor": "8179.14", "valorPromo": "0.00", "peso": "112", "altura": "7", "largura": "7", "comprimento": "16", "estoque": "8", "estoqueFornecedor": null, "qtdeMax": "0", "diasPrazo": "0", "diasPrazoFornecedor": null, "descCurta": "iPhone 5 Apple Branco e Memória Interna 64GB", "descricao": "HTML", "descExtra": [ { "titulo": "Especificações", "descricao": "HTML", }, { "titulo": "Itens Inclusos", "descricao": "HTML", } ], "video": "", "dataCad": "2014-05-20 16:31:17", "variacoes": [ { "conId": "2", "ref": "TESTE01-64GB", "nome": "Memória: 64 GB", "valorAcrescimo": 20, "estoque": 10, "estoqueFornecedor": 0, "detalhes": [ { "gruId": "4", "gruNome": "Memória", "carId": "11", "carNome": "64 GB", "ordem": "1" } ] } ], "imagens": { "principal": [ { "url": "http://www.tmwxd.com.br/img/produtos/TESTE01-01.jpg", "tipo": "principal", "pos": "1", "idVariacao": null } ], "detalhe": [ { "url": "http://www.tmwxd.com.br/img/produtos/TESTE01-11.jpg", "tipo": "detalhe", "pos": "1", "idVariacao": null }, { "url": "http://www.tmwxd.com.br/img/produtos/TESTE01-12.jpg", "tipo": "detalhe", "pos": "2", "idVariacao": null } ], "zoom": [ { "url": "http://www.tmwxd.com.br/img/produtos/TESTE01-21.jpg", "tipo": "zoom", "pos": "1", "idVariacao": null } ] } }, { "id": "11", "ref": "TESTE11", "marca": "Microsoft", "gtin": "", "secao": "Informática > Tablets e iPods > Outros", "secao2": null, "secao3": null, "nome": "Surface Windows 8 display Full HD com 1920 x 1080px", "ativo": true, "lancamento": false, "destaque": false, "freteGratis": false, "importado": true, "valor": "10499.99", "valorPromo": "9333.32", "peso": "700", "altura": "0", "largura": "0", "comprimento": "0", "estoque": "8", "estoqueFornecedor": null, "qtdeMax": "0", "diasPrazo": "0", "diasPrazoFornecedor": null, "descCurta": "O Tablet da Microsoft!", "descricao": "HTML", "descExtra": [ { "titulo": "Especificações", "descricao": "HTML", }, { "titulo": "Itens Inclusos", "descricao": "HTML", } ], "video": "", "dataCad": "2014-05-21 16:20:54", "variacoes": [], "imagens": { "principal": [ { "url": "http://www.tmwxd.com.br/img/produtos/TESTE11-01.jpg", "tipo": "principal", "pos": "1", "idVariacao": null } ], "detalhe": [ { "url": "http://www.tmwxd.com.br/img/produtos/TESTE11-11.jpg", "tipo": "detalhe", "pos": "1", "idVariacao": null }, { "url": "http://www.tmwxd.com.br/img/produtos/TESTE11-12.jpg", "tipo": "detalhe", "pos": "2", "idVariacao": null } ], "zoom": [ { "url": "http://www.tmwxd.com.br/img/produtos/TESTE11-21.jpg", "tipo": "zoom", "pos": "1", "idVariacao": null } ] } }, { "id": "12", "ref": "TESTE12", "marca": "Microsoft", "gtin": null, "secao": "Games", "secao2": null, "secao3": null, "nome": "Xbox One com Kinect e um Controle", "ativo": true, "lancamento": false, "destaque": false, "freteGratis": false, "importado": true, "valor": "10499.99", "valorPromo": "0.00", "peso": "700", "altura": "0", "largura": "0", "comprimento": "0", "estoque": "6", "estoqueFornecedor": null, "qtdeMax": null, "diasPrazo": "0", "diasPrazoFornecedor": null, "descCurta": "Mais real, o Xbox One é o Top de Linha!", "descricao": "HTML", "descExtra": [ { "titulo": "Especificações", "descricao": "HTML", }, { "titulo": "Itens Inclusos", "descricao": "HTML", } ], "video": "", "dataCad": "2014-05-21 16:23:15", "variacoes": [], "imagens": { "principal": [ { "url": "http://www.tmwxd.com.br/img/produtos/TESTE12-01.jpg", "tipo": "principal", "pos": "1", "idVariacao": null } ], "detalhe": [ { "url": "http://www.tmwxd.com.br/img/produtos/TESTE12-11.jpg", "tipo": "detalhe", "pos": "1", "idVariacao": null }, { "url": "http://www.tmwxd.com.br/img/produtos/TESTE12-12.jpg", "tipo": "detalhe", "pos": "2", "idVariacao": null } ], "zoom": [ { "url": "http://www.tmwxd.com.br/img/produtos/TESTE12-21.jpg", "tipo": "zoom", "pos": "1", "idVariacao": null } ] } } ] }