Através dessa API será possível fazer a busca de items por loja
Autenticação
Saiba mais sobre a autenticação em Documentação API Autenticação
Endpoint
GET <https://api.newtail.com.br/search/offers/integration/:store_id>
Path Parameters:
| Parâmetro | Descrição | Obrigatório |
|---|---|---|
| store_id | Indica de qual loja está buscando as ofertas. | |
| Deve ser utilizado o id externo da loja (o mesmo id que o supermercado utiliza) | Sim |
Query Parameters:
| Parâmetro | Tipo | Descrição |
|---|---|---|
| code | String | Irá buscar produtos pelo SKU ou Código de Barras (de forma exata) |
| name | String | Irá buscar produtos com deem match com o termo perquisado |
| page | Integer | Indica qual a página atual de paginação. default=1 |
| quantity | Integer | Indica a quantidade de itens por página. default=50 |
Body de Resposta:
| Atributo | Tipo | Descrição |
|---|---|---|
| total | Integer | Indica o total de resultados para os filtros atuais |
| pages | Integer | Indica a quantidade total de páginas |
| currentPage | Integer | Indica a página atual |
| data | List<Object> | Lista de resultados |
| data[].id | String | id interno da oferta |
| data[].account_id | id interno da conta | |
| data[].location_id | id interno da loja | |
| data[].available | Boolean | Indica se o produto está em condições para ser vendido. |
| Mas deve ser ignorado durante a separação. | ||
| data[].active | Boolean | Indica se o produto está ativo. |
| Mas deve ser ignorado durante a separação. | ||
| data[].external_id | String | SKU da oferta |
| data[].name | String | Nome da oferta |
| data[].names | List<String> | Nomes adicionais da oferta |
| data[].description | String | Descrição da oferta |
| data[].current_stock | Float | Estoque atual da oferta |
| Deve ser ignorado durante a separação. | ||
| data[].minimum_stock | Float | Estoque Mínimo da oferta |
| Deve ser ignorado durante a separação. | ||
| data[].price | Float | Preço da oferta |
| data[].promotional_price | Float | Preço promocional da oferta |
| data[].start_promotion | String | Indica a data e hora de início da utilização do promotional_price em detrimento do price. |
| data[].end_promotion | String | Indica a data e hora de término da utilização do promotional_price em detrimento do price. |
| data[].gtin | String | Código de Barras principal |
| data[].additional_gtins | String | Código de Barras adicionais (este campo também incluí o código de barras principal) |
| data[].categories | List<Object> | Lista de categorias da oferta |
| data[].categories[].name | String | Nome da categoria |
| data[].assets | Object | Imagens das ofertas |
| data[].assets.TAMANHO | Indica o formato da imagem. |
- raw: maior formato disponível | | data[].assets.TAMANHO.url | String | Endereço da imagem | | data[].assets.TAMANHO.mime | String | Tipo da imagem | | data[].unit_measurement | String | Unidade de medida.
- KG
- UN | | data[].unit_weight | Float | Peso médio do produto | | asset category product_id weight_per_unit stock status | | Depreciados Não devem ser utilizados |
{
"total": 6624,
"pages": 133,
"currentPage": 1,
"data": [
{
"id": "62d55a33e9e8750009728a4a",
"account_id": "fb1c2460-dd15-11ec-b088-5b7590f42261",
"location_id": "d35b6f20-02be-11ed-9fb2-f9c9985fea9e",
"available": false,
"active": true,
"external_id": "198719",
"name": "7 Graos + Passa Uva Tio Joao 500g",
"names": [
"ARROZ INTEGRAL 7 GRÃOS COM PASSAS TIO JOÃO 500G",
"7 GRAOS + PASSA UVA TIO JOAO 500G"
],
"description": "7 GRAOS + PASSA UVA TIO JOAO 500G",
"current_stock": 0,
"minimum_stock": 0,
"price": 6.79,
"promotional_price": 6.79,
"start_promotion": "2000-02-01T00:00:00.000Z",
"end_promotion": "2100-02-01T00:00:00.000Z",
"gtin": "7893500045458",
"additional_gtins": [
"7893500045458"
],
"categories": [
{
"name": "348"
},
{
"name": "Arroz - Arroces Especiales"
}
],
"assets": {
"raw": [
{
"url": "<https://cdn.newtail.com.br/assets/offers/fb1c2460-dd15-11ec-b088-5b7590f42261/d35b6f20-02be-11ed-9fb2-f9c9985fea9e/62d55a33e9e8750009728a4a/62d56474a65339000940e411/raw.bb70d218ed89d0c67948b4cefd3196a15a2ecb4b4ea90f1ccd87c59796dd6ca2.png>",
"mime": "image/png"
}
],
"large": [
],
"medium": [
],
"small": [
]
},
"attributes": [
],
"package": "UN",
"unit_measurement": "UN",
"indexed_at": "2022-07-21T15:04:58.224Z",
"updated_at": "2022-07-18T13:03:48.300Z",
"created_at": "2022-07-18T13:03:48.300Z",
"boost": 1,
"ranking": 1,
"additional_gtin": [
"7893500045458"
],
"asset": [
{
"type": "image",
"url": "<https://cdn.newtail.com.br/assets/offers/fb1c2460-dd15-11ec-b088-5b7590f42261/d35b6f20-02be-11ed-9fb2-f9c9985fea9e/62d55a33e9e8750009728a4a/62d56474a65339000940e411/raw.bb70d218ed89d0c67948b4cefd3196a15a2ecb4b4ea90f1ccd87c59796dd6ca2.png>"
}
],
"category": [
{
"name": "348",
"external_id": "348"
},
{
"name": "348 > Arroz - Arroces Especiales",
"external_id": "348 > Arroz - Arroces Especiales"
}
],
"product_id": "198719",
"stock": 0,
"status": "stock_out"
},
{
"id": "62d55a2d1062e000097eb636",
"account_id": "fb1c2460-dd15-11ec-b088-5b7590f42261",
"location_id": "d35b6f20-02be-11ed-9fb2-f9c9985fea9e",
"available": false,
"active": true,
"external_id": "267626",
"name": "Abacate Kg",
"names": [
"ABACATE KG"
],
"description": "ABACATE KG",
"current_stock": 0,
"minimum_stock": 0,
"price": 5.98,
"promotional_price": 5.98,
"start_promotion": "2000-02-01T00:00:00.000Z",
"end_promotion": "2100-02-01T00:00:00.000Z",
"gtin": "2406154000008",
"additional_gtins": [
"2406154000008"
],
"categories": [
{
"name": "740"
},
{
"name": "Frutas Exoticas / Tropicales - Aguacate"
}
],
"tags": [
],
"assets": {
"raw": [
{
"url": "<https://cdn.newtail.com.br/assets/offers/fb1c2460-dd15-11ec-b088-5b7590f42261/d35b6f20-02be-11ed-9fb2-f9c9985fea9e/62d55a2d1062e000097eb636/62d55e74df74f10007cd11b1/raw.7bfde6f723b04da3ffdffd411c2cd810abe56b7955034d369aeafdc42b196cd2.png>",
"mime": "image/png"
}
],
"large": [
],
"medium": [
],
"small": [
]
},
"attributes": [
],
"package": "KG",
"unit_weight": 0.1,
"unit_measurement": "KG",
"indexed_at": "2022-07-21T15:04:14.167Z",
"updated_at": "2022-07-18T13:03:42.286Z",
"created_at": "2022-07-18T13:03:42.286Z",
"boost": 1,
"ranking": 1,
"additional_gtin": [
"2406154000008"
],
"asset": [
{
"type": "image",
"url": "<https://cdn.newtail.com.br/assets/offers/fb1c2460-dd15-11ec-b088-5b7590f42261/d35b6f20-02be-11ed-9fb2-f9c9985fea9e/62d55a2d1062e000097eb636/62d55e74df74f10007cd11b1/raw.7bfde6f723b04da3ffdffd411c2cd810abe56b7955034d369aeafdc42b196cd2.png>"
}
],
"category": [
{
"name": "740",
"external_id": "740"
},
{
"name": "740 > Frutas Exoticas / Tropicales - Aguacate",
"external_id": "740 > Frutas Exoticas / Tropicales - Aguacate"
}
],
"product_id": "267626",
"weight_per_unit": 0.1,
"stock": 0,
"status": "stock_out"
}
]
}