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:
Autenticação
Seja mais sobre a autenticação em Documentação API Autenticação
Para a integração do catálogo, existe dois endpoints: ofertas e inventários.
Campo | Descrição | Tipo | Obrigatório |
---|---|---|---|
sku | Identificador único do produto | String | Obrigatório |
name | Nome do produto | String | Obrigatório |
active | Indica se o produto está disponível para venda | Boolean | Obrigatório |
unit_measurement | Unidade de medida do produto. KG ou UN | String | Obrigatório |
image_url | URL da imagem do produto | String | Recomendado |
gtins | Lista de códigos de barras de um produto | Array<String> | Recomendado |
categories | Lista de categorias do produto | Array<String> | Recomendado |
brand_name | Nome da marca do produto | String | Recomendado |
unit_weight | Peso médio do produto | Float | Recomendado |
ranking | A quantidade de vendas que esse item deve no último mês. super relevante! | Integer | Recomendado |
boost | Indica se esse produto deve ser priorizado no resultado da busca. | ||
valor precisa ser > 0. | |||
Valores menores que 1 reduzem a relevância. | |||
Valores maiores que 1 aumentam a relevância | Float | Recomendado |
Exemplo de requisição para upsert de ofertas (atualizando produtos já existentes ou cadastrando os novos):
POST - <https://api.newtail.com.br/api/catalog/v3/offers/bulk>
content-type: application/json
x-app-id: xxxx
x-api-key: yyyy
[
{
"sku": "allan-1",
"name": "Abacate Kg",
"gtins": [
"2445121000000"
],
"categories": [
"Frutas exóticas e tropicais",
"Frutas exóticas e tropicais > Abacate"
],
"unit_measurement": "KG",
"active": false,
"brand_name": "Frutas & CIA",
"unit_weight": 0.8,
"ranking": null,
"boost": null,
"image_url": "<https://comper.vteximg.com.br/arquivos/ids/158625-1000-1000/654434.jpg>"
}
]
Campo | Descrição | Tipo | Obrigatório |
---|---|---|---|
sku | Identificador único do produto | String | Obrigatório |
store_id | Identificador da loja | String | Obrigatório |
active | Indica se esse produto está ativo para essa loja | Boolean | Obrigatório |
price | Indica o preço do produto "de” | Float | Obrigatório |
promotional_price | Indica o preço promocional do produto. (quando o produto não tiver preço promocional passar null) | Float | Obrigatório |
stock | Indica o stock atual do produto | Float | Obrigatório |
Exemplo de requisição para upsert de inventários (atualizando os inventários já existentes ou cadastrando os novos):