2RS's Public API Documentation

2RS Loja Virtual API (Beta)

Number of APIs: 34

1. Produtos - 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. Produtos - 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. Produtos - 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. Produtos - 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. Produtos - 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. Produtos - Remover um Produto

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

7. Produtos - 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. Produtos - 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. Produtos - 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. Produtos - 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. Produtos - Produto - Enviar Foto por URL

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

12. Produtos - Produto - Enviar Foto por Base64 encode

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

13. Produtos - Produto - Foto Remover

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

14. Categorias - Listar Categorias

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

15. Categorias - Nova Categoria

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

Para inserir uma nova categoria, o nome dela deve ser passado pelo body com a chave name

16. Categorias - Detalhe de Categoria

GET {{proto}}://{{domain}}/api/categoria/9968/

17. Categorias - Editar uma Categoria

PUT {{proto}}://{{domain}}/api/categoria/9968

18. Categorias - Remover uma categoria

DELETE {{proto}}://{{domain}}/api/categoria/9967

19. Pedidos - Pesquisar Pedidos

GET {{proto}}://{{domain}}/api/pedido/?order=created DESC&limit=20&lastid&data&lastupdate_gte&created_gte&status=4

Segue abaixo os filtros disponíveis para a pesquisa de pedidos:

lastid: Filtra os pedidos realizados após o ID informado.
data: Filtra os pedidos pela data de realização.
lastupdate: Filtra os pedidos pela data da última atualização.
created: Filtra os pedidos pela data de criação do registro.
Os parâmetros data, lastupdate e created funcionam com os modificadores gte (maior ou igual) e lte (menor ou igual). Ex: &lastupdate_gte=2019-08-22 é igual a lastupdate >= 2019-08-22.
pago: Filtra os pedidos pagos pago=S ou não pagos pago=N.
status: Filtra os pedidos pelo status. Segue abaixo a tabela de situações:
Status Descrição
1 Aberto
2 Confirmado
3 Cancelado
4 Pendente
5 Postado
6 Finalizado
7 Carrinho
order: Ordena os resultados pela coluna informada. Aceita as seguintes opções: id, data, created, lastupdate, valor e o modificador ASC/DESC em seguida. Padrão id DESC.

20. Pedidos - Pesquisar Pedidos (Importar Últimos)

GET {{proto}}://{{domain}}/api/pedido?page=1&created_gte=2023-06-01

Segue abaixo os filtros disponíveis para a pesquisa de pedidos:

lastid: Filtra os pedidos realizados após o ID informado.
data: Filtra os pedidos pela data de realização.
lastupdate: Filtra os pedidos pela data da última atualização.
created: Filtra os pedidos pela data de criação do registro.
Os parâmetros data, lastupdate e created funcionam com os modificadores gte (maior ou igual) e lte (menor ou igual). Ex: &lastupdate_gte=2019-08-22 é igual a lastupdate >= 2019-08-22.
pago: Filtra os pedidos pagos pago=S ou não pagos pago=N.
status: Filtra os pedidos pelo status. Segue abaixo a tabela de situações:
Status Descrição
1 Aberto
2 Confirmado
3 Cancelado
4 Pendente
5 Postado
6 Finalizado
7 Carrinho
order: Ordena os resultados pela coluna informada. Aceita as seguintes opções: id, data, created, lastupdate, valor e o modificador ASC/DESC em seguida. Padrão id DESC.

21. Pedidos - Detalhe de um pedido

GET {{proto}}://{{domain}}/api/pedido/2153

22. Pedidos - Editar um pedido

PUT {{proto}}://{{domain}}/api/pedido/130520222011

Campos disponíveis para editar: status, pago, pagtostatus, entregarastreiocodigo, entregarastreiolink, observacao, revisadoloja.

23. Pedidos - Remover um pedido

DELETE {{proto}}://{{domain}}/api/pedido/4716

24. Pedidos - Tabela de Status

GET {{proto}}://{{domain}}/api/pedido/status

25. Clientes - Pesquisar Clientes

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

26. Clientes - Inserir Cliente

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

Para inserir novos clientes, os campos a seguir devem ser passados pelo body

nome: O nome do novo cliente a ser inserido
tipo_pessoa: Nesse campo é especificado se a pessoa é fisica ou juridica, "F" para física e "J" para jurídica
cpfcnpj: O número do documento, sendo cpf ou o cnpj
rgie: Número do RG
fone_ddd: O número do ddd do telefone do cliente
fone: O numero de telefone do cliente
email: O email do cliente