getProducts

GET /tmwxdapi/getProducts

Retorna todos os produtos ativos e com estoque de sua loja (limite de 50 produtos). Porém, podem ser informados parâmetros que irão alterar o comportamento.

  • busca Termos de busca. Será pesquisado nos campos Nome e Referência.

    Exemplos:
    GET /tmwxdapi/getProducts?busca=iphone
  • ref Referência(s) (SKU) do(s) produto(s) e/ou de uma variação (característica). Poderá definir mais de uma, separadas por vírgula. Quando informado, a pesquisa ignorará o parâmetro busca.

    Obs.: Quando informada uma referência pertencente a uma variação (característica), os estoques e valores serão referentes a essa variação, e não o total, e o nome do produto conterá o detalhe da variação.

    Exemplos:
    GET /tmwxdapi/getProducts?ref=REF1234,REF5678
  • id ID(s) do(s) produto(s). Poderá definir mais de um, separados por vírgula. Quando informado, a pesquisa ignorará os parâmetros busca e ref.

    Exemplos:
    GET /tmwxdapi/getProducts?id=5,23,44
  • incluir Usar quando desejar incluir produtos inativos e/ou sem estoque. Parâmetros possíveis: inativos e/ou semEstoque (separados por vírgula quando ambos forem declarados).

    Exemplos:
    GET /tmwxdapi/getProducts?incluir=inativos,semEstoque
  • inicio Indica a partir de qual registro deve começar a listagem (registro inicial: 0).
    limite Quantidade de produtos retornados (máximo permitido: 50).

    Exemplos:
    GET /tmwxdapi/getProducts?inicio=40&limite=20
  • campos Limitar os campos que serão retornados. Separe os campos desejados por vírgula.
    Campos permitidos: id, ref, marca, gtin, secao, secao2, secao3, nome, ativo, lancamento, destaque, freteGratis, importado, valor, valorPromo, peso, altura, largura, comprimento, estoque, estoqueFornecedor, qtdeMax, diasPrazo, diasPrazoFornecedor, descCurta, descricao, descExtra, video, dataCad, variacoes e/ou imagens.

    Exemplos:
    GET /tmwxdapi/getProducts?campos=ref,nome,valor
  • qtdeProdutos Retorna apenas o total de produtos da pesquisa. Quando informado, a pesquisa ignorará os parâmetros campos, inicio e limite.

    Exemplos:
    GET /tmwxdapi/getProducts?qtdeProdutos
GET /tmwxdapi/getProducts?campos=ref,nome,valor,variacoes&limite=2

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

{
    "status": true,
    "produtos": [
        {
            "ref": "CANONMARKIII",
            "nome": "Câmera Digital Canon EOS 5D Mark III 22.3",
            "valor": 10056.67,
            "variacoes": [
                {
                    "conId": 1,
                    "ref": "CANONMARKIII-EF",
                    "nome": "Lente: EF",
                    "valorAcrescimo": 0,
                    "estoque": 10,
                    "estoqueFornecedor": 0,
                    "detalhes": [
                        {
                            "gruId": 3
                            "gruNome": "Lente"
                            "carId": 9
                            "carNome": "EF"
                            "ordem": 0
                        }
                    ]
                },
                {
                    "conId": 2,
                    "ref": "CANONMARKIII-EF-S",
                    "nome": "Lente: EF-S",
                    "valorAcrescimo": 0,
                    "estoque": 5,
                    "estoqueFornecedor": 0,
                    "detalhes": [
                        {
                            "gruId": 3
                            "gruNome": "Lente"
                            "carId": 10
                            "carNome": "EF-S"
                            "ordem": 1
                        }
                    ]
                }
            ]
        },
        {
            "ref": "TESTE10",
            "nome": "Celular Desbloqueado LG Optimus L5 Branco E615 com Dual Chip",
            "valor": 10499.99
        }
    ]
}

Quando houverem variações em um produto, os estoques representarão o total dos estoques das característcas. Neste caso, o SKU (referência) válido será o de cada variação, e não o do produto.

A menos que tenha sido solicitado uma referência de variação. Nessa situação, o estoque será o real. (veja mais acima, nas observações do campo ref)


GET /tmwxdapi/getProducts?incluir=inativos,semEstoque&qtdeProdutos

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

{
    "status": true,
    "produtos": [
        {
            "qtdeProdutos": 29
        }
    ]
}