Visão Geral

A API do Shopify da V4MOS.AI centraliza informações de clientes, pedidos, itens de pedido e produtos sincronizados das lojas conectadas. Todos os endpoints ficam sob o prefixo /v1/shopify e utilizam os mesmos padrões de paginação, autenticação e resposta do restante da plataforma.

Endpoints DisponíveisCopiar link da seção

• getClientes/v1/shopify/customersRetorna clientes Shopify com consentimento de email marketing e informações agregadas de pedidos
• getPedidos/v1/shopify/ordersRetorna pedidos Shopify com pagamento, totais e timestamps do ciclo de vida
• getItens de pedido/v1/shopify/orders-itemsRetorna os itens de pedido Shopify com SKU, preços e descontos
• getProdutos/v1/shopify/productsRetorna produtos Shopify com informações de catálogo, estoque e preç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 que possui a integração
• integrationId – Id da integração
• integrationName – Nome da integração
• page – Número da página (padrão: 1)
• limit – Registros por página (padrão: 500, máx: 5000)
• orderBy – Campo utilizado na ordenação
• orderDirection – ASC ou DESC
• createdStart / createdEnd – Filtro por data de criação
• lastModifiedStart / lastModifiedEnd – Filtro por data da última modificação

Filtros Específicos por RecursoCopiar link da seção

Clientes (/v1/shopify/customers)Copiar link da seção

• id, email
• Parâmetros de paginação e datas listados acima

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

• customerId – ID do cliente no Shopify
• storeId – Identificador da loja
• name – Nome do pedido (ex: #1001)
• closedDateStart / closedDateEnd
• processedDateStart / processedDateEnd

Itens de Pedido (/v1/shopify/orders-items)Copiar link da seção

• orderId, orderName
• productId
• orderCreatedStart / orderCreatedEnd
• quantity
• name – Nome do item

Produtos (/v1/shopify/products)Copiar link da seção

• productType, status
• title
• publishedStart / publishedEnd
• id

Destaques do Modelo de Dados ShopifyCopiar link da seção

ClientesCopiar link da seção

• Perfil: id, email, state, verified_email
• Ciclo de vida: created_at, updated_at, number_of_orders, state, verified_email
• Consentimentos: email_marketing_consent_*

PedidosCopiar link da seção

• Status e lifecycle: cancelled_at, closed_at, processed_at, confirmed, fully_paid, source_name
• Totais financeiros: total_price_set_*, total_shipping_price_set_*, total_tax_set_*, total_discounts_set_*, total_refunded_set_*, total_received_set_*
• Relacionamentos: customer_id, customer_email, organization_id, integration_id

Itens de PedidoCopiar link da seção

• Identificadores: order_id, order_name, product_id, sku
• Preços: original_total_set_*, original_unit_price_set_*, total_discount_set_*
• Ciclo de vida: order_created_at, current_quantity, is_gift_card

ProdutosCopiar link da seção

• Catálogo: title, status, product_type, category_name
• Estoque: total_inventory, tracks_inventory
• Preços: price_range_v2_min_variant_price_*, price_range_v2_max_variant_price_*
• Publicação: created_at, published_at, integration_id, organization_id

RespostasCopiar link da seção

Todas as respostas seguem o padrão:

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}