Logo
2RS's Public API Documentation

Produtos

Number of APIs: 13


1. Pesquisar Produtos

GET {{proto}}://{{domain}}/api/produto/

Segue abaixo os filtros disponíveis para busca de produtos:

  • marca: Busca o produto pelo ID da marca
  • featured: Busca os produtos em destaque, sendo "Y" para sim e "N"para não
  • code: Busca o produto pelo código (SKU)

    Exemplo de busca por SKU: produto/?code=8394

  • genero: Busca o produto pelo genero, sendo "M" ou "F" para Masculino e Feminino respectivamente
  • promo: Busca os produtos que estejam com preço de promoção maior que 0
  • preco: Busca os produtos dentro de uma faixa de preço

    Um exemplo de faixa de preço é ?preco=100-250 onde os produtos com o valor entre R$ 100,00 e R$ 250,00 são retornados



2. Criar novo produto

POST {{proto}}://{{domain}}/api/produto

Para a criação de novos produtos é necessário que alguns paramêtros sejam passados pelo body da request:

  • name: O nome do produto
  • code: o código do produto
  • category_id O id da categoria ao qual o produto pertence
  • content: A descricão do produto
  • estoque_quantidade: A quantidade de produtos que estão em estoque
  • price: O preço do produto
  • resume: Um resumo sobre o produto

Os campos acimas são os campos obrigatórios, os outros campos estão na response do exemplo da requisição



3. Detalhe de Produto

GET {{proto}}://{{domain}}/api/produto/10008

Para buscar as informações de somente um produto, o id dele deve ser adicionado ao final da url api/produto



4. Editar um Produto Por SKU

PUT {{proto}}://{{domain}}/api/produto/10008

Ao editar um produto é possível passar o id diretamente na URL ou passar nos parâmetros o campo code (SKU).

Exemplo de edição com ID: /api/produto/999/

Exemplo de edição por SKU: /api/produto/?code=999



5. Editar um Sub Produto

PUT {{proto}}://{{domain}}/api/produto/10010

Ao editar um produto é possível passar o id diretamente na URL ou passar nos parâmetros o campo code (SKU).

Exemplo de edição com ID: /api/produto/999/

Exemplo de edição por SKU: /api/produto/?code=999



6. Remover um Produto

DELETE {{proto}}://{{domain}}/api/produto/1/



7. CSV - Ler estoque e preço de todos os produtos

GET {{proto}}://{{domain}}/api/produto/csv

Retorna uma string CSV contendo as colunas code;price;price_promo;estoque_quantidade.

Este mesmo layout poderá ser submitado via POST neste mesmo método para atualizar os dados em lote.

Todos os produtos devem estar com o campo Código/SKU corretamente preenchido.



8. CSV - Atualizar estoque e preço em lote

POST {{proto}}://{{domain}}/api/produto/csv

Processa uma string CSV contendo as colunas code;price;price_promo;estoque_quantidade.

As colunas a serem atualizadas devem estar explicitas na primeira linha do parâmetro csvdata, sendo a coluna "code" obrigatória e as demais opcionais.

Segue abaixo um exemplo visual:

"code";"price";"price_promo";"estoque_quantidade"
"cod-9709";"52.03426139";"41.62740911";"28"
"cod-9710";"119.9868749";"95.98949996";"0"
"cod-9707";"45.57723352";"36.46178682";"9"

  • Request

    + Headers
    
        Authorization: 9a30756ac29ea18ba50fc27a02af463d
        Accept: text/json
        Content-type:application/x-www-form-urlencoded
    



9. Produto - Listagem das Fotos

GET {{proto}}://{{domain}}/api/produto/9707/fotos

Para a listagem das fotos o caminho ˜fotos˜ deve ser adicionado ao final do código do produto

Por exemplo: http://url/api/produto/900/fotos



10. Produto - Foto Detalhe

GET {{proto}}://{{domain}}/api/produto/9707/fotos/13904

Para selecionar somente um foto, deve-se colocar o id da foto ao final da url



11. Produto - Enviar Foto por URL

POST {{proto}}://{{domain}}/api/produto/9707/fotos



12. Produto - Enviar Foto por Base64 encode

POST {{proto}}://{{domain}}/api/produto/9707/fotos/



13. Produto - Foto Remover

DELETE {{proto}}://{{domain}}/api/produto/9707/fotos/14270



ENDPOINTS