Skip to content

Documentação de Filas de Integração

Visão Geral

O módulo de Filas de Integração é um componente essencial para sistemas que precisam manter a sincronia de dados com a plataforma Uappi de forma eficiente e performática. 🚀

Em vez de realizar consultas exaustivas em todo o catálogo de produtos ou na base de pedidos para identificar alterações, as filas funcionam como um registro incremental de eventos.

Sempre que uma entidade (Produto, Cliente ou Pedido) sofre uma modificação relevante, um identificador é inserido na fila do usuário que está realizando a integração.

Este modelo permite que o integrador consuma apenas o que realmente mudou, reduzindo drasticamente o tráfego de dados e o processamento tanto na API quanto no sistema externo. 🛠️

As filas são organizadas por entidade e são individuais por usuário de API.

Isso garante que cada integração tenha seu próprio controle de ponteiro, sem interferir no fluxo de outros parceiros ou aplicativos conectados à mesma loja.

O ciclo de vida de um item na fila segue um fluxo de Consumo e Confirmação:

1. Listagem: O integrador consulta os itens pendentes na fila.

2. Processamento: O sistema externo processa as informações recebidas.

3. Confirmação (Remoção): Após o processamento bem-sucedido, o integrador envia os IDs de volta para a API para removê-los da fila. ✅

O acesso a este módulo é controlado por permissões vinculadas à entidade da fila. Por exemplo, acessar a fila de pedidos exige ORDER_READ, enquanto a de produtos exige PRODUCT_READ. 🔒

Entidades Envolvidas

  • Fila de Produtos: Registra alterações em preços, estoque, descrições e status de produtos. Essencial para ERPs e Marketplaces. 📦
  • Fila de Pedidos: Notifica sobre novos pedidos ou mudanças de status (Aprovação, Envio, Cancelamento). Ideal para sistemas de faturamento e logística. 🛒
  • Fila de Clientes: Captura novos cadastros ou atualizações de dados cadastrais de clientes. 👥

Notas e Considerações

A Confirmação de Leitura é um passo obrigatório. ⚠️

Se um item não for removido da fila após o consumo, ele continuará aparecendo nas próximas listagens.

Isso pode causar processamento duplicado no sistema externo. É responsabilidade do integrador garantir que o DELETE seja enviado após cada lote processado.

Listagem da Fila de Produtos

GET /queue/products

Recupera os dados dos produtos que estão na fila de integração do usuário.

Descrição

Este endpoint é o ponto de entrada para a sincronização incremental de produtos. 📋

Sempre que um produto tem seu preço alterado, o estoque atualizado ou qualquer outra modificação de cadastro, seu ID é inserido nesta fila.

Ao consultar este endpoint, a API identifica quais itens pertencem à sua fila e retorna os dados completos desses produtos.

Uma característica importante é que este endpoint funciona como um proxy para a listagem principal de produtos.

Isso significa que você pode utilizar o parâmetro fields para escolher exatamente quais informações deseja receber (ex: apenas preço e estoque, ou o cadastro completo). 🔍

Diferente da listagem geral de produtos, aqui você não define filtros de busca complexos, pois o sistema já filtra automaticamente os itens que estão pendentes na sua fila pessoal.

O resultado é ordenado por data de inserção, garantindo que as alterações mais antigas sejam processadas primeiro.

O acesso a este recurso requer o escopo de permissão PRODUCT_READ. 🔒

---

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Campos Disponíveis (fields)

CampoDescrição
brandInformações completas da marca do produto
flagsFlags do produto (showInSite, saleWithoutStock, minimumStock)
mainUrlURL principal do produto
secondaryUrlsURLs secundárias do produto
descriptionDescrições (short, full, searchDescription)
parentProductProduto pai do produto atual
indicatedProductsProdutos indicados relacionados
relatedProductsProdutos relacionados
taxInformações de impostos e taxas
filtersFiltros e atributos aplicáveis
stockByStorageEstoque por armazém
stockInformações consolidadas de estoque
sealsSelos e certificações do produto
mainCategoryCategoria principal
categoriesTodas as categorias do produto
categoryBreadcrumbBreadcrumb de navegação de categorias
dimensionDimensões físicas (peso, altura, largura, comprimento)
variationVariações do produto (cores, tamanhos, etc)
mediaMídias (imagens, vídeos, arquivos)
pricePreço, promoções e parcelamento
priceRulesRegras de preço aplicadas
bannerGroupsGrupos de banners associados
reviewAvaliações e reviews
statusStatus do produto
haveChildrenVerifica se tem produtos filhos

Exemplo de Requisição

1curl --request GET \
2 --url {{MAIN_URL}}/queue/products \
3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4 --data '{
5 "fields": [
6 "prices",
7 "balance"
8 ],
9 "limit": 50
10 }'

✅ Resposta de Sucesso

1{
2 "id": 1234,
3 "type": "product",
4 "sku": "SMPH001",
5 "name": "Smartphone XYZ Pro 128GB",
6 "priority": 100,
7 "basePrice": 1199.90,
8 "active": true,
9 "review": {
10 "productId": 1234,
11 "averageRating": 4.67,
12 "quantityRating": 328
13 },
14 "isGiftCard": false,
15 "stock": {
16 "productId": 1234,
17 "productStorageId": 1,
18 "availableStock": 15,
19 "reservedStock": 2,
20 "updatedAt": "2024-10-01 14:30:00"
21 },
22 "stocks": [
23 {
24 "productId": 1234,
25 "productStorageId": 1,
26 "availableStock": 15,
27 "reservedStock": 2,
28 "updatedAt": "2024-10-01 14:30:00"
29 },
30 {
31 "productId": 1234,
32 "productStorageId": 2,
33 "availableStock": 8,
34 "reservedStock": 1,
35 "updatedAt": "2024-10-01 14:30:00"
36 }
37 ],
38 "originalPrice": {
39 "comparisonPrice": 0,
40 "salePrice": 0,
41 "markup": 0,
42 "ruleId": 0,
43 "ruleTrigger": "original",
44 "ruleName": "Original",
45 "availableForSale": true,
46 "basePrice": false,
47 "priceWithDiscount": 0,
48 "installments": [],
49 "scheduling": null
50 },
51 "price": {
52 "comparisonPrice": 1499.90,
53 "salePrice": 1199.90,
54 "markup": 25.02,
55 "ruleId": 15,
56 "ruleTrigger": "original",
57 "ruleName": "Original",
58 "availableForSale": true,
59 "basePrice": false,
60 "priceWithDiscount": 1199.90,
61 "installments": [
62 {
63 "installment": 1,
64 "installmentValue": 1199.90,
65 "totalValue": 1199.90,
66 "fee": null,
67 "feeTotalValue": 0
68 },
69 {
70 "installment": 2,
71 "installmentValue": 599.95,
72 "totalValue": 1199.90,
73 "fee": null,
74 "feeTotalValue": 0
75 },
76 {
77 "installment": 12,
78 "installmentValue": 99.99,
79 "totalValue": 1199.88,
80 "fee": null,
81 "feeTotalValue": 0
82 }
83 ],
84 "scheduling": {
85 "id": 46,
86 "startDate": "2026-02-07 09:00:00",
87 "endDate": "2026-10-30 23:59:59"
88 }
89 },
90 "priceRules": null,
91 "brand": {
92 "id": 45,
93 "code": "TECH",
94 "name": "TechBrand",
95 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",
96 "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",
97 "productOrdering": "name_asc",
98 "active": true,
99 "bannerGroups": [],
100 "createdAt": "2023-10-04 19:11:08",
101 "updatedAt": "2025-08-20 12:41:03",
102 "url": "/marca/techbrand"
103 },
104 "flags": {
105 "subscription": false,
106 "service": false,
107 "showInSite": true,
108 "saleWithoutStock": false,
109 "minimumStock": 5
110 },
111 "tax": {
112 "mpn": "MPN123456",
113 "ean": "7891234567890",
114 "ncm": "85171231",
115 "exclusive": false
116 },
117 "indicatedProducts": [
118 {
119 "id": 1234,
120 "brandId": 1234,
121 "brandName": "TopPhone",
122 "mainCategoryId": 1,
123 "mainCategoryName": "smartphone",
124 "type": "product",
125 "name": "Smartphone XYZ Pro 128GB",
126 "sku": "SMPH001",
127 "url": "/smartphone-xyz-pro-128gb",
128 "comparisonPrice":2199.99,
129 "stock":20,
130 "medias":[
131 {
132 "id": 123,
133 "type": "image",
134 "title": "",
135 "alternativeText": null,
136 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
137 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
138 "size": null,
139 "originalSize": null,
140 "width": null,
141 "height": null,
142 "url": null
143 }
144 ],
145 "combination":[1, 2, 3],
146 "currentAttributes":[
147 {
148 "id":123,
149 "name":"cor",
150 "value":{
151 "id":123,
152 "label":"azul-escuro",
153 "image":null,
154 "originalImage":null,
155 "color":"#00008B",
156 "order":1
157 }
158 }
159 ],
160 "active": true
161 }
162 ],
163 "relatedProducts": [
164 {
165 "id": 1234,
166 "brandId": 1234,
167 "brandName": "TopPhone",
168 "mainCategoryId": 1,
169 "mainCategoryName": "smartphone",
170 "type": "product",
171 "name": "Smartphone XYZ Pro 128GB",
172 "sku": "SMPH001",
173 "url": "/smartphone-xyz-pro-128gb",
174 "comparisonPrice":2199.99,
175 "stock":20,
176 "medias":[
177 {
178 "id": 123,
179 "type": "image",
180 "title": "",
181 "alternativeText": null,
182 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
183 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
184 "size": null,
185 "originalSize": null,
186 "width": null,
187 "height": null,
188 "url": null
189 }
190 ],
191 "combination":[1, 2, 3],
192 "currentAttributes":[
193 {
194 "id":123,
195 "name":"cor",
196 "value":{
197 "id":123,
198 "label":"azul-escuro",
199 "image":null,
200 "originalImage":null,
201 "color":"#00008B",
202 "order":1
203 }
204 }
205 ],
206 "active": true
207 }
208 ],
209 "filters": [
210 {
211 "id": 123,
212 "productCategoryId": 1234,
213 "name": "Marca",
214 "active": true,
215 "showInListing": true,
216 "showInSpecificationTable": false,
217 "type": "enum",
218 "createdAt": "2025-01-14 10:31:00",
219 "values": [
220 {
221 "id": 123,
222 "name": "TechPhone",
223 "image": null,
224 "originalImage": null,
225 "color": null,
226 "order": 1,
227 "value": null
228 },
229 {
230 "id": 124,
231 "name": "SmartScreen",
232 "image": null,
233 "originalImage": null,
234 "color": null,
235 "order": 1,
236 "value": null
237 }
238 ]
239 }
240 ],
241 "seals": [
242 {
243 "id": 5,
244 "name": "Frete Grátis",
245 "active": true,
246 "textColor": "#FFFFFF",
247 "sealColor": "#00A650",
248 "image": "https://cdn.loja.com.br/seals/frete-gratis.png",
249 "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",
250 "setting":{
251 "id": 1234,
252 "horizontalPosition": "left",
253 "verticalPosition": "top",
254 "proportionInProductDetail": 300,
255 "proportionInProductShowcase": 300,
256 "scheduling": {
257 "id": 1234,
258 "startDate": "2024-01-15 10:30:00",
259 "endDate": "2024-01-30 10:30:00"
260 }
261 },
262 "promotionLinkId":15,
263 "createdAt":"2024-01-15 10:30:00",
264 "updatedAt":"2024-01-15 10:30:00"
265 }
266 ],
267 "mainCategory": {
268 "id": 123,
269 "name": "Smartphones",
270 "url": "/smartphones"
271 },
272 "categories": [
273 {
274 "id": 100,
275 "name": "Eletrônicos",
276 "url": "/eletronicos"
277 },
278 {
279 "id": 110,
280 "name": "Telefonia",
281 "url": "/eletronicos/telefonia"
282 },
283 {
284 "id": 123,
285 "name": "Smartphones",
286 "url": "/eletronicos/telefonia/smartphones"
287 }
288 ],
289 "categoryBreadcrumb": [
290 {
291 "id": 100,
292 "name": "Eletrônicos",
293 "url": "/eletronicos"
294 },
295 {
296 "id": 110,
297 "name": "Telefonia",
298 "url": "/eletronicos/telefonia"
299 },
300 {
301 "id": 123,
302 "name": "Smartphones",
303 "url": "/eletronicos/telefonia/smartphones"
304 }
305 ],
306 "dimensions": {
307 "shippingCargoTypeId": 1,
308 "additionalTime": 0,
309 "width": 7.5,
310 "height": 15.2,
311 "length": 0.8,
312 "weight": 185
313 },
314 "parentProductId": null,
315 "combination": [1234],
316 "currentAttributes": [
317 {
318 "id": 1,
319 "name": "Cor",
320 "value": {
321 "id": 123,
322 "label": "Azul",
323 "image": null,
324 "originalImage": null,
325 "color": "007BFF",
326 "order": 1
327 }
328 }
329 ],
330 "variations": {
331 "valueList": [
332 1234
333 ],
334 "combinations": [
335 {
336 "productId": 1234,
337 "brandId": 1,
338 "brandName": "TechPhone",
339 "mainCategoryId": 123,
340 "mainCategoryName": "Tecnologia",
341 "type": "variation",
342 "sku": "ABC123",
343 "name": "Variation Phone",
344 "active": true,
345 "url": "nice-phone-url",
346 "comparisonPrice": 1800,
347 "stock": 21,
348 "medias": [
349 {
350 "id": 123,
351 "type": "image",
352 "title": "Variation Phone Image",
353 "alternativeText": null,
354 "file": "https://cdn.loja.com.br/upload/media.webp",
355 "originalFile": "https://cdn.loja.com.br/upload/media.png",
356 "size": null,
357 "originalSize": null,
358 "width": null,
359 "height": null,
360 "url": null
361 }
362 ],
363 "combination": [
364 1, 2
365 ],
366 "currentAttributes": [
367 {
368 "id": 1,
369 "name": "Cor",
370 "value": {
371 "id": 1,
372 "label": "Azul",
373 "image": null,
374 "originalImage": null,
375 "color": "007BFF",
376 "order": 1
377 }
378 }
379 ]
380 }
381 ],
382 "attributes": [
383 {
384 "id": 1,
385 "name": "Cor",
386 "displayName": "Cor",
387 "includeSample": false,
388 "values": [
389 {
390 "id": 1,
391 "label": "Azul",
392 "image": null,
393 "originalImage": null,
394 "color": "007BFF",
395 "order": 1
396 }
397 ],
398 "createdAt": "2025-07-23 22:50:28",
399 "updatedAt": "2025-08-06 16:03:59"
400 }
401 ]
402 },
403 "medias": [
404 {
405 "id": 1234,
406 "type": "image",
407 "title": "Imagem Principal",
408 "alternativeText": "Smartphone XYZ Pro vista frontal",
409 "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",
410 "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",
411 "size": 245680,
412 "originalSize": 1567890,
413 "width": 800,
414 "height": 800,
415 "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"
416 }
417 ],
418 "bannerGroups": [
419 "banner 1",
420 "banner 2",
421 "banner 3"
422 ],
423 "status": "available",
424 "createdAt": "2024-01-15 10:30:00",
425 "updatedAt": "2024-10-01 15:45:00",
426 "url": "/smartphone-xyz-pro-128gb",
427 "urls": [
428 {
429 "tradePolicyId": 1,
430 "url": "/smartphone-xyz-pro-128gb",
431 "redirect": false,
432 "redirectCode": null,
433 "target": null,
434 "createdAt": "2024-01-15 10:30:00",
435 "updatedAt": "2024-01-15 10:30:00"
436 }
437 ],
438 "linkedTradePolicies": [1, 2, 3],
439 "description": {
440 "id": 1234,
441 "productId": 1234,
442 "tradePolicyId": 1,
443 "name": "Smartphone XYZ Pro 128GB",
444 "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",
445 "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",
446 "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",
447 "videoUrl": "https://youtube.com/watch?v=example",
448 "customDescription1": null,
449 "customDescription2": null,
450 "customDescription3": null,
451 "measureTable": null,
452 "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",
453 "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",
454 "seoKeywords": "smartphone, xyz pro, 128gb, android",
455 "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",
456 "seoSocialTitle": "Smartphone XYZ Pro 128GB",
457 "seoSocialDescription": "O melhor smartphone do mercado",
458 "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",
459 "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",
460 "seoGoogleCategoryId": 2895,
461 "seoIndexOnGoogle": true,
462 "seoGoogleCondition": "new",
463 "seoGoogleAgeGroup": "adult",
464 "seoGoogleGender": "unisex",
465 "seoStructuredData": null
466 }
467}

Listagem da Fila de Pedidos

GET /queue/orders

Recupera os dados dos pedidos que estão na fila de integração do usuário.

Descrição

Este endpoint é a base para a automação de faturamento e fluxo logístico. 📋

Sempre que um novo pedido é realizado ou quando um pedido existente muda de status (ex: pagamento aprovado, pedido enviado ou cancelado), seu ID entra na fila.

Isso permite que sistemas externos, como ERPs e WMS, sejam notificados sobre as ações necessárias sem a necessidade de realizar polling em toda a base histórica.

O endpoint funciona como um proxy para o módulo de Pedidos.

Através do parâmetro fields, você pode extrair desde o resumo financeiro até os detalhes dos itens comprados, dados de entrega e informações de pagamento. 🔍

A utilização correta desta fila garante que sua operação logística e financeira ocorra em sintonia fina com a plataforma, reduzindo o tempo de resposta entre a venda e a entrega.

Não esqueça de confirmar o processamento enviando o DELETE com os IDs consumidos.

O acesso a este recurso requer o escopo de permissão ORDER_READ. 🔒

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Campos Disponíveis (fields)

Você pode solicitar qualquer campo disponível no módulo de Pedidos. Exemplos comuns:

CampoDescrição
orderGroupDados gerais do agrupador de pedidos.
productStorageInformações do estoque de origem.
statusDetalhes do status atual do pedido.
customerDados completos do comprador.
addressesEndereços de entrega e faturamento.
valuesComposição de valores (subtotal, frete, descontos, total).
shippingDados logísticos e de rastreio.
itemsLista detalhada de produtos no pedido.
paymentsTransações financeiras vinculadas.
paymentLogsHistórico de comunicações de pagamento.
reservesInformações de reservas de estoque.
invoiceDados das notas fiscais emitidas.
discountsDetalhamento de descontos.
additionsDetalhamento de acréscimos.
historiesRegistro de auditoria do pedido.

Exemplo de Requisição

1curl --request GET \
2 --url {{MAIN_URL}}/queue/orders \
3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4 --data '{
5 "fields": [
6 "items",
7 "shipping"
8 ],
9 "limit": 20
10 }'

✅ Resposta de Sucesso

1{
2 "status": true,
3 "data": [
4 {
5 "id": 1,
6 "orderGroupId": 1,
7 "productStorageId": 1,
8 "orderStatusId": 1,
9 "marketplaceOrderId": null,
10 "masked": false,
11 "orderGroup": {
12 "id": 1,
13 "cartId": "",
14 "tradePolicyId": 1,
15 "userId": null,
16 "userEmail": null,
17 "userName": null,
18 "code": "2",
19 "salesChannelDomain": "minha-loja.uappi.store",
20 "marketplaceId": null,
21 "marketplaceName": null,
22 "marketplaceStoreCredentialId": null,
23 "marketplaceOrderGroupId": null,
24 "currency": "BRL",
25 "createdAt": "2025-09-17 14:10:55",
26 "issuedAt": "2022-09-30 19:40:52"
27 },
28 "productStorage": {
29 "id": 1,
30 "code": "0001",
31 "corporateName": "Sua Loja.",
32 "email": "suporte@sualoja.com",
33 "phone": "+55123451234",
34 "tradeName": "Armazém Principal",
35 "stateCode": "BR-SP",
36 "countryCode": "BRA",
37 "document": "12345678912",
38 "zipCode": "123456789",
39 "city": "Birigui",
40 "address": "Rua das flores",
41 "district": "centro",
42 "number": "123",
43 "complement": null,
44 "latitude": "",
45 "longitude": "",
46 "active": true,
47 "observation": null,
48 "tradePolicyExceptions": []
49 },
50 "status": {
51 "id": 1,
52 "orderStatusParentId": null,
53 "code": "paid",
54 "name": "Paid",
55 "icon": "monetization",
56 "children": []
57 },
58 "customer": null,
59 "addresses": [],
60 "values": null,
61 "shipping": null,
62 "discounts": null,
63 "additions": null,
64 "items": [],
65 "payments": [],
66 "reserves": [],
67 "invoice": null,
68 "histories": null
69 }
70 ]
71}

Listagem da Fila de Clientes

GET /queue/customers

Recupera os dados dos clientes que estão na fila de integração do usuário.

Descrição

Este endpoint permite a sincronização de novos clientes e atualizações cadastrais de forma incremental. 📋

Sempre que um cliente se cadastra na loja ou altera suas informações (como endereço ou telefone), seu identificador é inserido na sua fila de integração.

Este recurso é vital para manter sistemas de CRM ou ERPs sincronizados com a base de usuários da loja em tempo real.

O endpoint atua como um proxy para o módulo de Clientes.

Através do parâmetro fields, você pode definir quais dados deseja extrair, desde informações básicas de contato até a lista completa de endereços e documentos. 🔍

A ordem de retorno respeita a cronologia dos eventos, permitindo que você processe a jornada do cliente na plataforma de forma sequencial.

Lembre-se que, após o processamento bem-sucedido no seu sistema, é mandatório confirmar a leitura para limpar a fila.

O acesso a este recurso requer o escopo de permissão CUSTOMER_READ. 🔒

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Campos Disponíveis (fields)

Você pode solicitar qualquer campo disponível no módulo de Clientes. Exemplos úteis:

CampoDescrição
addressesLista de endereços
documentsDocumentos cadastrados
flagsPreferências de notificação
totalOrderQuantityQuantidade de pedidos
cancelledOrderQuantityQuantidade de pedidos cancelados
totalOrderValueValor total de pedidos
lastOrderDados do último pedido
pointSystemAmountSaldo de pontos
additionalFieldsCampos adicionais preenchidos pelo cliente

Exemplo de Requisição

1curl --request GET \
2 --url {{MAIN_URL}}/queue/customers \
3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4 --data '{
5 "fields": [
6 "addresses",
7 "documents"
8 ],
9 "limit": 50
10 }'

✅ Resposta de Sucesso

1{
2 "status": true,
3 "data": [
4 {
5 "id": 1,
6 "salesChannelId": 1,
7 "tradePolicyId": 1,
8 "email": "uappi@email.com",
9 "dealerGroupId": 0,
10 "nameCorporateName": "Lucas Andrade",
11 "tradeName": "",
12 "isCorporate": false,
13 "gender": "male",
14 "nationality": "BRA",
15 "birthdate": "2000-01-01",
16 "phone": "+5512123451234",
17 "walletAmount": 0,
18 "pointSystemAmount": 0,
19 "orderQuantity": 0,
20 "cancelledOrderQuantity": 0,
21 "orderValue": 0,
22 "lastOrder": null,
23 "origin": "frontend",
24 "createdAt": "2022-09-14 00:04:12",
25 "active": true,
26 "deleted": false,
27 "masked": false,
28 "addresses": [
29 {
30 "id": 2,
31 "main": false,
32 "zipCode": "123456789",
33 "identification": "casa",
34 "street": "Rua das flores",
35 "number": "123",
36 "city": "Birigui",
37 "complement": "",
38 "district": "Centro",
39 "state": "São Paulo",
40 "recipient": "Lucas Andrade",
41 "stateCode": "BR-SP",
42 "countryCode": "BRA",
43 "createdAt": "2022-09-14 00:04:36",
44 "updatedAt": "2025-08-22 14:17:14"
45 }
46 ],
47 "documents": [
48 {
49 "type": "cpf",
50 "document": "12345678912"
51 }
52 ],
53 "flags": {
54 "sendPromotionalEmail": false,
55 "sendPromotionalSms": false,
56 "sendOrderEmail": true,
57 "sendOrderSms": false
58 },
59 "additionalFields": null
60 }
61 ]
62}

Remoção de Itens da Fila

DELETE /queue/products

Confirma o processamento de um lote de itens, removendo-os da fila.

Descrição

Este endpoint é o passo final e obrigatório do ciclo de sincronização. 🛡️

Após o seu sistema consumir os dados da fila de produtos e processá-los com sucesso (ex: atualizar o preço no seu banco de dados local), você deve informar à API que esses itens já foram lidos.

Ao enviar os IDs dos produtos para este endpoint, eles são removidos da sua fila de integração.

A confirmação é o que mantém a fila "limpa" e performática.

Se você não remover os itens processados, eles continuarão aparecendo em todas as consultas subsequentes de listagem, gerando retrabalho e consumo desnecessário de recursos. ✅

O sistema permite a confirmação em lote, aceitando até 100 identificadores por requisição.

Recomenda-se que o processo de confirmação ocorra imediatamente após o sucesso da operação no sistema de destino.

O acesso a este recurso requer o escopo de permissão PRODUCT_READ. 🔒

---

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Parâmetros do Corpo (Body)

ParâmetroTipoObrigatórioDescrição
idsarraySimLista de IDs de produtos a serem removidos da fila
ids.*integerSimIdentificador único do produto

Exemplo de Requisição

1curl --request DELETE \
2 --url {{MAIN_URL}}/queue/products \
3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4 --data '{
5 "ids": [
6 123,
7 124,
8 125
9 ]
10 }'

✅ Resposta de Sucesso

1{
2 "status": true,
3 "data": true
4}

Remoção de Itens da Fila

DELETE /queue/orders

Confirma o processamento de um lote de itens, removendo-os da fila.

Descrição

Este endpoint encerra o fluxo de sincronização de pedidos. 🛡️

Após o seu ERP ou sistema de faturamento processar o pedido recebido via fila (ex: gerar a nota fiscal ou iniciar a separação logística), você deve enviar o ID deste pedido para este endpoint.

A remoção do item da fila é o sinal para a plataforma Uappi de que o integrador já está ciente daquele evento.

Mantenha seu fluxo de confirmação o mais próximo possível do tempo real do processamento.

Isso evita que pedidos "voltem" para a listagem em consultas futuras, o que poderia gerar faturamentos ou envios em duplicidade. ✅

O endpoint aceita um lote de até 100 IDs por requisição. Utilize esta capacidade para otimizar suas chamadas de rede e manter a fila sempre atualizada.

O acesso a este recurso requer o escopo de permissão ORDER_READ. 🔒

---

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Parâmetros do Corpo (Body)

ParâmetroTipoObrigatórioDescrição
idsarraySimLista de IDs de pedidos a serem removidos da fila
ids.*integerSimIdentificador único do pedido

Exemplo de Requisição

1curl --request DELETE \
2 --url {{MAIN_URL}}/queue/orders \
3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4 --data '{
5 "ids": [
6 1,
7 2
8 ]
9 }'

✅ Resposta de Sucesso

1{
2 "status": true,
3 "data": true
4}

Remoção de Itens da Fila

DELETE /queue/customers

Confirma o processamento de um lote de itens, removendo-os da fila.

Descrição

Este endpoint é utilizado para confirmar a leitura de novos clientes ou atualizações cadastrais. 🛡️

Assim que o integrador termina de salvar os dados do cliente em seu sistema externo (como um CRM), ele deve enviar os IDs dos clientes processados para este endpoint.

Isso garante que esses registros não sejam entregues novamente na próxima consulta de listagem.

O uso correto da confirmação evita a criação de duplicados e garante a integridade da sincronização.

O endpoint é otimizado para processamento em lote, permitindo confirmar até 100 registros em uma única chamada HTTP. 🚀

A falha em confirmar a leitura pode levar ao acúmulo de dados na fila, o que prejudica a performance e pode causar bloqueios preventivos por excesso de tráfego pendente.

O acesso a este recurso requer o escopo de permissão CUSTOMER_READ. 🔒

---

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Parâmetros do Corpo (Body)

ParâmetroTipoObrigatórioDescrição
idsarraySimLista de IDs de clientes a serem removidos da fila
ids.*integerSimIdentificador único do cliente

Exemplo de Requisição

1curl --request DELETE \
2 --url {{MAIN_URL}}/queue/customers \
3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4 --data '{
5 "ids": [
6 456,
7 457
8 ]
9 }'

✅ Resposta de Sucesso

1{
2 "status": true,
3 "data": true
4}

Uappi é a melhor opção para o crescimento da sua loja!

;