Visão geral

A API Nuvemshop da V4MOS.AI entrega os registros brutos sincronizados das contas Nuvemshop conectadas à sua organização: pedidos, itens de pedido, checkouts abandonados, clientes, catálogo, cupons, promoções e estoque. As linhas vêm como foram sincronizadas, com os nomes de coluna do data warehouse (snake_case), prontas para levar ao seu BI. Todos os endpoints usam o prefixo /v1/nuvemshop e seguem a mesma autenticação, paginação e formato de resposta.

Primeiros passosCopiar link da seção

URL base: https://data.v4mos.ai. Toda chamada exige suas credenciais de API e o organizationId — veja Autenticação.

1. Conecte a integração Nuvemshop em app.v4mos.ai (Contas conectadas) e aguarde a primeira sincronização.
2. Chame qualquer endpoint abaixo com o seu organizationId, por exemplo GET /v1/nuvemshop/orders?organizationId=….
3. Toda linha traz integration_id e integration_name: a conta conectada de onde ela veio. Para ler uma conta só, passe esse valor em integrationId.

Endpoints disponíveisCopiar link da seção

• getPedidos/v1/nuvemshop/ordersUma linha por pedido: status do pedido, do pagamento e do envio, totais, descontos, cupons, promoções, frete e atribuição de UTM.
• getItens de pedido/v1/nuvemshop/order-itemsUma linha por item de pedido: produto, variação, SKU, quantidade, preço, custo e promoções, com o status e as datas do pedido.
• getCheckouts abandonados/v1/nuvemshop/abandoned-checkoutsUma linha por checkout que o comprador começou e não concluiu: itens, totais, cupons e opção de frete.
• getClientes/v1/nuvemshop/customersUma linha por cliente da loja, com o consentimento de marketing e o total gasto.
• getProdutos/v1/nuvemshop/productsUma linha por produto do catálogo: marca, publicação, regras de frete, categoria e número de variações.
• getVariações de produto/v1/nuvemshop/variantsUma linha por variação de produto: SKU, preços, custo, estoque e visibilidade.
• getCupons/v1/nuvemshop/couponsUma linha por cupom cadastrado na loja: tipo, valor, validade e limites de uso.
• getPromoções/v1/nuvemshop/promotionsUma linha por promoção configurada na loja: status, tipo de desconto e validade.
• getFotos do estoque/v1/nuvemshop/inventory-snapshotsUma linha por leitura de estoque de uma variação em um local: quantidade disponível em snapshotat.

RecursosCopiar link da seção

Paginação e filtrosCopiar link da seção

• page (padrão 1) e limit (padrão 500, máximo 5000). meta.hasNextPage diz se existe outra página; as linhas vêm sempre na mesma ordem, então avance as páginas até ele ser false.
• dateFrom / dateTo (YYYY-MM-DD, inclusivos) filtram pela coluna de data indicada na tabela acima. Recursos sem coluna de data recusam esses parâmetros.
• integrationId mantém só as linhas de uma conta conectada.
• As respostas ficam em cache por 30 minutos e os dados são sincronizados uma vez por dia — veja Sincronização de dados.

Formato da respostaCopiar link da seção

{
  "data": [{ "...": "um objeto por linha, com as colunas listadas em cada endpoint" }],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Valores monetários e contadores grandes (campos format: decimal e format: int64 no schema de cada endpoint) chegam como texto, por exemplo "125.50", para não perder precisão. Converta para um tipo decimal do seu lado.