Apresentação
API REST da ANDCommerce, que permite o acesso a todas as tabelas do banco de dados incluindo as que não são nativas da ANDCommerce.
O controle de acesso a API REST é feito através da chave da API que é cadastrada na administração da ANDCommerce.
Testes de execução
Para executar testes, execute o seguinte comando.
Endpoints de API para categoria
Obter Categoria
| Parâmetro | Tipo | Descrição |
|---|---|---|
category_id | string | Obtenha os detalhes da categoria com o ID da categoria especificada. |
Obter Categorias
| Parâmetro | Tipo | Descrição |
|---|---|---|
status | orderby | sort | limit | string | Obtenha uma lista de todas as categorias na loja. |
Excluir Categoria
| Parâmetro | Tipo | Descrição |
|---|---|---|
category_id | string | Exclua uma categoria com o ID de categoria especificada. |
Endpoints de API para categoria
Os seguintes endpoints de API estão disponíveis para gerenciar dados relacionados ao cliente:
Obter Cliente
| Parâmetro | Tipo | Descrição |
|---|---|---|
customer_id | string | Obtenha os detalhes do cliente com o ID do cliente especificado. |
Obter cliente por e-mail
| Parâmetro | Tipo | Descrição |
|---|---|---|
email | string | Obtenha os detalhes do cliente com o endereço de e-mail especificado. |
Obter Clientes
| Parâmetro | Tipo | Descrição |
|---|---|---|
status | orderby | sort | limit | string | Obtenha uma lista de todos os clientes da loja. |
Excluir Cliente
| Parâmetro | Tipo | Descrição |
|---|---|---|
customer_id | string | Exclua o cliente com o ID de cliente especificado. |
Obter grupo de Clientes
| Parâmetro | Tipo | Descrição |
|---|---|---|
customer_group_id | string | Obtenha os detalhes do grupo de clientes com o ID do grupo de clientes especificado. |
Obter grupos de Clientes
| Parâmetro | Tipo | Descrição |
|---|---|---|
orderby | sort | limit | string | Obtenha uma lista de todos os grupos de clientes na loja. |
Endpoints de API para localização
Os seguintes endpoints de API estão disponíveis para gerenciar dados relacionados à localização:
Obter País
| Parâmetro | Tipo | Descrição |
|---|---|---|
country_id | string | Obtenha os detalhes do país com o ID do país especificado. |
Obter Região
| Parâmetro | Tipo | Descrição |
|---|---|---|
zone_id | string | Obtenha os detalhes da região com o ID de região especificado. |
Obter zonas por ID do País
| Parâmetro | Tipo | Descrição |
|---|---|---|
country_id | string | Obtenha a lista de todas as regiões no ID do país especificado. |
Obter moeda por Código
| Parâmetro | Tipo | Descrição |
|---|---|---|
code | string | Obtenha os detalhes da moeda com o código de moeda especificado. |
Obter Moedas
| Parâmetro | Tipo | Descrição |
|---|---|---|
status | orderby | sort | limit | string | Obtenha a lista de todas as moedas na loja. |
Obter Idioma
| Parâmetro | Tipo | Descrição |
|---|---|---|
status | orderby | sort | limit | string | Obtenha a lista de todos os idiomas na loja. |
Obter status do Pedido
| Parâmetro | Tipo | Descrição |
|---|---|---|
order_status_id | string | Obtenha os detalhes do status do pedido com o ID de status do pedido especificado. |
Obter status de Pedidos
| Parâmetro | Tipo | Descrição |
|---|---|---|
language_id | orderby | sort | limit | string | Obtenha a lista de todos os status de pedidos na loja. |
Endpoints de API para Fabricantes
Os seguintes endpoints de API estão disponíveis para gerenciar dados relacionados ao fabricante:
Obter Fabricante
| Parâmetro | Tipo | Descrição |
|---|---|---|
status | orderby | sort | limit | string | Obtenha a lista de todos os fabricantes na loja. |
Obtenha fabricantes Totais
Obtenha o número total de fabricantes na loja.
Excluir Fabricante
| Parâmetro | Tipo | Descrição |
|---|---|---|
manufacturer_id | string | Exclua o fabricante com o ID do fabricante especificado. |
Endpoints de API para Pedidos
Os seguintes endpoints de API estão disponíveis para gerenciar dados relacionados a pedidos:
Obter Pedido
| Parâmetro | Tipo | Descrição |
|---|---|---|
order_id | string | Recupera os detalhes do pedido especificado. |
Obter Pedidos
| Parâmetro | Tipo | Descrição |
|---|---|---|
order_status | orderby | sort | limit | start_date | end_date | string | Recupera uma lista de todos os pedidos na loja. |
Obter produtos do Pedido
| Parâmetro | Tipo | Descrição |
|---|---|---|
order_id | string | Recupera os produtos associados ao pedido especificado. |
Obter opções de Pedido
| Parâmetro | Tipo | Descrição |
|---|---|---|
order_id | order_product_id | string | Recupera as opções associadas ao pedido especificado. |
Obter totais do Pedido
| Parâmetro | Tipo | Descrição |
|---|---|---|
order_id | string | Recupera os totais associados ao pedido especificado. |
Excluir Pedido
| Parâmetro | Tipo | Descrição |
|---|---|---|
order_id | string | Exclui a ordem especificada. |
Endpoints de API para Produtos
Os seguintes endpoints de API estão disponíveis para gerenciar dados relacionados ao produto:
Obter Produto
| Parâmetro | Tipo | Descrição |
|---|---|---|
product_id | string | Obtenha detalhes do produto com o ID especificado. |
Obter Produtos
| Parâmetro | Tipo | Descrição |
|---|---|---|
status | orderby | sort | limit | string | Obtenha uma lista de todos os produtos da loja. |
Obter imagens do Produto
| Parâmetro | Tipo | Descrição |
|---|---|---|
product_id | string | Obtenha uma lista de imagens para o produto com o ID especificado. |
Obter atributos do Produto
| Parâmetro | Tipo | Descrição |
|---|---|---|
product_id | string | Obtenha uma lista de atributos para o produto com o ID especificado. |
Obter opções de Produtos
| Parâmetro | Tipo | Descrição |
|---|---|---|
order_id | string | Obtenha uma lista de opções para o produto com o ID especificado. |
Obtenha produtos em Destaques
| Parâmetro | Tipo | Descrição |
|---|---|---|
limit | string | Obtenha uma lista dos produtos mais populares da loja. |
Obter produtos por ID de Categoria
| Parâmetro | Tipo | Descrição |
|---|---|---|
category_id | status | limit | sort | orderby | string | Obtenha uma lista de produtos na categoria especificada. |
Excluir Produto
| Parâmetro | Tipo | Descrição |
|---|---|---|
product_id | string | Exclua o produto com o ID especificado. |
Pontos de extremidade da API para relatório
Os seguintes endpoints de API estão disponíveis para gerenciar dados relacionados a relatórios:
Obter Estatísticas
Recupera as estatísticas da loja.
Endpoints da API para comentários
Os seguintes endpoints de API estão disponíveis para gerenciar dados relacionados à comentários:
Obter avaliações por ID do Produto
| Parâmetro | Tipo | Descrição |
|---|---|---|
product_id | string | Recupera todos os comentários com o ID do produto especificado. |
Obter avaliações totais por ID do Produto
| Parâmetro | Tipo | Descrição |
|---|---|---|
product_id | string | Retorna o número total de avaliações com o ID do produto especificado. |
Endpoints da API para lista de desejos
Os seguintes endpoints de API estão disponíveis para gerenciar dados relacionados à lista de permissões:
Obter lista de Desejos
| Parâmetro | Tipo | Descrição |
|---|---|---|
customer_id | string | Recupera a lista de desejos do cliente com o ID de cliente especificado. |
Obter lista de desejos Total
| Parâmetro | Tipo | Descrição |
|---|---|---|
customer_id | string | Retorna o número total de listas de desejos para o cliente com o ID de cliente especificado. |