Visão geral

A API VTEX do V4MOS.AI reúne dados de pedidos e itens de pedido das lojas VTEX conectadas à sua organização. Os endpoints compartilham o prefixo /v1/vtex e usam a mesma autenticação, paginação e envelope de metadados das demais integrações do V4MOS.AI.

Endpoints disponíveisCopiar link da seção

• getPedidos/v1/vtex/ordersRetorna pedidos de venda VTEX com status, detalhamento de totais, pagamento, envio e atribuição de marketing (UTMs, cupom).
• getItens de pedido/v1/vtex/orders/itemsRetorna os itens de pedido VTEX com SKU, preços, marca e dados de comissão.

AutenticaçãoCopiar link da seção

Todos os endpoints exigem os headers x-client-id e x-client-secret, além do query parameter organizationId. Veja Autenticação.

Parâmetros comunsCopiar link da seção

• organizationId (obrigatório) – Organização dona da integração VTEX
• userId – Escopo de usuário
• integrationName – Nome da integração
• orderId – Filtra linhas de um único pedido
• dateStart / dateEnd – Filtro por intervalo de datas (creation_date para pedidos, inserted_at para itens)
• page – Número da página (padrão: 1)
• limit – Registros por página (padrão: 500, máx: 5000)

Filtros por recursoCopiar link da seção

Pedidos (/v1/vtex/orders)Copiar link da seção

• status – Status do pedido na VTEX (ex.: invoiced, canceled)

PaginaçãoCopiar link da seção

As respostas retornam meta.page, meta.limit, meta.hasNextPage e meta.hasPreviousPage. Itere enquanto hasNextPage for true.