A criação e atualização de ofertas na Newtail, ocorre de forma assincronia, permitindo uma melhor vazão e escalabilidade na integração de ofertas. O ideal é sempre enviar lotes com 500 ofertas por requisição (com limite de 10mb por request).
Existe ainda um Limite de Requisições:
- 1 requisição por segundo, com possíveis picos de 10 por segundos
- limite de 86400 requisições por dia
POST https://api.newtail.com.br/api/catalog/v1/offers/bulk/{store_id}
Principais Atributos do Catálogo
Abaixo as informações necessárias para que possamos integrar os dados de catálogo de uma loja no Newtail:
Campo | Descrição | Tipo | Obrigatório | Padrão |
external_id | ID do Produto | String | Obrigatório | |
additional_gtins | Código de Barras Adicionais | List<String> | Recomendado | [] |
unit_measurement | Unidade de medida do produto. KG, UN | String | Obrigatório | |
name | Nome do Produto | String | Obrigatório | |
description | Descrição do Produto | String | Recomendado | |
brand | Marca do produto | String | Recomendado | |
manufacturer | Fabricante do Produto | String | Recomendado | |
active | Se o produto está ativo ou não | Bool | Opcional | true |
categories | Lista de categorias do produto | Lista de categorias do produto | Recomendado | |
assets | Lista de Imagens do produto. Deve conter uma URL válida | List<String> | List<String> | |
current_stock | Estoque Atual | Float | Obrigatório | |
minimum_stock | Estoque Mínimo | Float | Recomendado | 0.0 |
minimum_quantity | Quantidade Mínima de Venda de um produto | Float | Opcional | |
price | Preço padrão do Produto | Float | Obrigatório | |
promotional_price | Preço promocional do Produto | Float | Opcional | 0.0 |
start_promotion | Quando a promoção começa. - CSV: DD/MM/YYYY - API: ISO8601 |
String | Opcional | null |
end_promotion | Quando a promoção termina. - CSV: DD/MM/YYYY - API: ISO8601 |
String | Opcional | null |
boost | Implementa uma forma de aumentar a relevância da oferta em detrimento de outras ofertas. de 0.0 à 1.0 | Float | Opcional | 1.0 |
width | indica a largura do produto em cm | Float | Opcional | null |
height | indica a altura do produto em cm | Float | Opcional | null |
depth |
indica o comprimento do produto em cm | Float | Opcional | null |
unit_weight | India a quantidade média do peso para itens pesáveis | Float | Opcional | 0.0 |
API
Para visualizar melhores detalhes sobre a interface da API, consulte a nossa documentação do Swagger: https://app.swaggerhub.com/apis/newtail/NewtailPublicAPI/1.0.0
Autenticação
Seja mais sobre a autenticação em 🔐Documentação API Autenticação
Exemplo de Corpo de requisição
Abaixo a descrição dos campos que devem ser enviados na API de atualização de ofertas.
E deve ser enviado uma lista de ofertas que deseja ser criado ou atualizado.
[
{
"external_id": "string",
"name": "string",
"price": 0,
"cost_price": 0,
"promotional_price": 1,
"start_promotion": "string",
"end_promotion": "string",
"current_stock": 0,
"minimum_stock": 0,
"description": "string",
"brand": "string",
"manufacturer": "string",
"categories": [
"string"
],
"gtin": "string",
"additional_gtins": [
"string"
],
"active": true,
"minimum_quantity": 0,
"package": "UN",
"package_quantity": 1,
"package_weight": 1,
"unit_quantity": 1,
"unit_weight": 1,
"unit_measurement": "G",
"height": 1,
"weight": 1,
"depth": 1,
"attributes": [
{
"key": "string",
"value": "string",
"type": "generic"
}
],
"assets": [ "https://dominio.com/endereço/da/imagem.jpg" ],
"boost": 1.0
}
]
Integração por CSV
A integração via CSV, agiliza a integração dos supermercados, evitando a utilização da API. Porem essa forma adiciona um grande atraso nas atualizações das informações e resulta sempre em um processo manual.
Configurações do CSV
- todo decimal deve ser separado por "," (no padrão brasileiro)
- separação do valores por ";" (ponto e vírgula)
- todos os valores devem ter "quoting".
- atributos que podem ser mais de um valor, devem ser separados por "," (additional_gtins, assets e categories)
- nem todos os atributos disponíveis na API estão disponíveis na integração via CSV.
- todos os campos que não obrigatórios, não precisam estar presentes no CSV (envie somente os campos que realmente possam ter algum valor)
- deve ser gerado um CSV por Loja.
Os campos seguem os mesmos definidos na sessão Principais Atributos do Catálogo.
Exemplo:
example.csv
external_id;additional_gtins;name;description;brand;manufacturer;active;ncm;cest;categories;assets;current_stock;minimum_stock;price;cost_price;promotional_price;start_promotion;end_promotion;package;package_quantity;package_weight;unit_quantity;unit_weight;unit_measurement;minimum_quantity;tags
external-1;gtin-1,gtin-1b;"product name 1";"my desc 1";Samsung;Samsung;true;ncm-1;cest-1;category-1,category-2;https://via.placeholder.com/1000,https://via.placeholder.com/500;10;0;90,0;;80,33;01-01-2020;01/01/2020;;;;;;;;tag1,tag2
external-2;gtin-2;"product name 2";;Samsung;;true;ncm-2;cest-2;category-2,category-2;https://via.placeholder.com/2000,https://via.placeholder.com/500;20;0;90,0;;80,33;02-02-2020;02/02/2020;;;;;;;;tag5
external-3;gtin-3b,gtin-3a,gtin-3c;"product name 3";"my desc 3";;;true;ncm-3;cest-3;category-3,category-3;https://via.placeholder.com/3000,https://via.placeholder.com/500;30;0;90,0;;80,33;03-03-2020;03/03/2020;;;;;;;;tag6,tag8
Utilizando FTP com CSV
A utilização do FTP sempre será conveniente em alguns casos, mas nunca é o ideal.
Informações de Acesso
As informações de acesso incluindo IP, Porta e Usuário e Senha, serão informados pela nossa equipe de Customer Success.
Formato
O formato do arquivo deve ser escrito seguindo o formato de Integração por CSV descrito acima e salvo em padrão de diretório dentro do FTP como descrito abaixo.
Atributo | Descrição | Exemplo |
yyyy | ano no formado de 4 dígitos | 2021 |
mm | mês no formato de 2 dígitos | 09 |
dd | dia no formato de 2 dígitos | 01 |
nome |
Não utilizar caracteres acentuados ou “ç”. Para integrações automatizadas, poderia ser utilizado o timestamp em segundos. Para integrações manuais, pode ser utilizado valores incrementais. |
- 1.csv - 1645785691.csv |
~/offers/yyyy/mm/dd/nome.csv
Como se conectar
Filezilla
https://download.filezilla-project.org/client/FileZilla_3.58.0_win64_sponsored2-setup.exe
Após a instalação do programa, basta configurar uma nova conexão seguindo o exemplo.
Comentários
0 comentário
Por favor, entre para comentar.