Pegar Catálogos
Método#
/getCatalogs
POST https://e-vendi.com.br/api/getCatalogs
Conceituação#
Pegar Catálogo.
Este método serve para ver quantos e quais catálogos você tem ativo.
Atributos#
note
externalId é o id do seu cliente na sua base de dados, sempre que você for criar um e-commerce para seu cliente, você precisa informar o ID do seu cliente na sua base de dados.
por exemplo, você tem 2 clientes na sua base de dados Cliente 01 : ID: 1001 Cliente 02 : ID: 1002, nesse caso o externalId será 1001 para o cliente 01 e 1002 para o cliente 02.
Atributos que contém external em seu nome são para identificar que os ID's passados serão da sua base de dados, isso facilita futuras buscas, pois você poderá fazer consultas através do seu ID uma vez que este está sob seu controle.
Atributos obrigatórios
São obrigatórios todos atributos marcados com * (asterisco).
| Atributos | Tipo | Descrição |
|---|---|---|
| env* | string | Tipo de envio que será feito. Os tipos de envio são: dev (Para quando for enviado para um ambiente de desenvolvimento) ou prod (Para quando for enviado para um ambiente de produção). ATENÇÃO, caso seja enviado para um ambiente de produção todas as transações serão debitadas ou creditadas |
| integrationToken* | string | Para se conectar com o e-vendi é necessário um token integrador, ele será passado como parâmetro para todos os requisitos |
| externalId* | string | Seu código de identificação no e-vendi |
Request body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| id | string | ID do catálogo no e-vendi |
| banners | array<banners> | Array de banners que serão exibidos ao entrar no catálogo |
| bannersMobile | array<bannersMobile> | Array de banners que serão exibidos ao entrar no catálogo exibidos apenas em mobile |
| cover | boolean | Esse atributo serve para colocar uma capa(Thumbnail) no catálogo |
| createdAt | number | Data de criação do catálogo |
| enableExpiration | boolean | Atributo para informar se o catálogo expira |
| expiredAt | number | Data de expiração do catálogo |
| externalId | string | ID que seu sistema criou para o catálogo |
| friendlyName | string | O nome do catálogo de forma curta |
| ignoreItens | array<string> | Produtos que serão ignorados do catálogo |
| minimalItens | number | Mínimo de itens para o catálogo |
| minimalPrice | string | Atributo para aparecer o preço mínimo |
| minimalPriceNumber | number | Número de preços mínimos |
| name | string | Nome do catálogo |
| postbackPaymentUrl | string | Webhook (Postback) para quando uma compra é realizada na plataforma, um aviso para saber quando pedido foi pago |
| postbackUrl | string | Webhook (Postback) para quando uma compra é realizada na plataforma, um aviso para saber quando algo for vendido |
| products | array<string> | Array com os ID's dos produtos que fazem parte do catálogo |
| published | boolean | Identificada se catálogo está publicado |
| tablePriceId | string | Id da tabela de preço para o catálogo |
| tablePriceWholesaleId | string | Id da tabela de preço de atacado para o catálogo |
| totalItens | number | Quantidade de produtos contidos no catálogo |
| updatedAt | number | Data da última atualização do catálogo |
| wholesale | boolean | Identifica se o catálogo está como atacado |
banners#
| Atributos | Tipo | Descrição |
|---|---|---|
| link | string | Link para onde o usuário será direcionado ao clicar no banner |
| url | string | url da imagem do banner |
bannersMobile#
| Atributos | Tipo | Descrição |
|---|---|---|
| link | string | Link para onde o usuário será direcionado ao clicar no banner |
| url | string | url da imagem do banner |
Exemplo
400#
Essa resposta significa que o servidor não entendeu a requisição pois está com uma sintaxe inválida.
405#
Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico.
415#
Caso você receba um erro 415, certifique-se de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"