Overview

A API do Shopify do V4 Marketing 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íveis

Clientes

GET /v1/shopify/customers – Clientes com dados de perfil, consentimentos de marketing, informações de contato e contagem agregada de pedidos.

Pedidos e Itens

GET /v1/shopify/orders – Pedidos com status de pagamento, totais financeiros e carimbos de tempo do ciclo de vida.

GET /v1/shopify/orders-items – Itens individuais com SKU, preços, descontos e referências ao produto.

Catálogo de Produtos

GET /v1/shopify/products – Produtos com status, rastreamento de estoque, faixas de preço, categorias e datas de publicação.

Autenticação

Todos os endpoints exigem autenticação via Bearer token no header Authorization.

Parâmetros Comuns

workspaceId (obrigatório) – Workspace que possui a integração

organizationId – Escopo de organização

integrationId – Conexão/loja específica

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 Recurso

Clientes (`/v1/shopify/customers`)

firstName, lastName, email

id, orderId

codeState, codeCountry (estado e país do endereço padrão)

Parâmetros de paginação e datas listados acima

Pedidos (`/v1/shopify/orders`)

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`)

orderId, orderName

productId

orderCreatedStart / orderCreatedEnd

quantity

name – Nome do item

Produtos (`/v1/shopify/products`)

productType, status

title

publishedStart / publishedEnd

id

Destaques do Modelo de Dados Shopify

Clientes

Perfil: first_name, last_name, email, phone, tags

Ciclo de vida: created_at, updated_at, number_of_orders, state, verified_email

Endereço padrão consolidado (default_address_*: nome, endereço, cidade, CEP, estado, país, telefone)

Consentimentos: email_marketing_consent_* e sms_marketing_consent_*

Pedidos

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, workspace_id, integration_id

Itens de Pedido

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

Produtos

Catálogo: title, description, 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, workspace_id

Respostas

Todas as respostas seguem o padrão:

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

Endpoints Disponíveis#

Clientes#

Pedidos e Itens#

Catálogo de Produtos#

Autenticação#

Parâmetros Comuns#

Filtros Específicos por Recurso#

Clientes (/v1/shopify/customers)#

Pedidos (/v1/shopify/orders)#

Itens de Pedido (/v1/shopify/orders-items)#

Produtos (/v1/shopify/products)#

Destaques do Modelo de Dados Shopify#

Clientes#

Pedidos#

Itens de Pedido#

Produtos#

Respostas#

Endpoints Disponíveis

Clientes

Pedidos e Itens

Catálogo de Produtos

Autenticação

Parâmetros Comuns

Filtros Específicos por Recurso

Clientes (`/v1/shopify/customers`)

Pedidos (`/v1/shopify/orders`)

Itens de Pedido (`/v1/shopify/orders-items`)

Produtos (`/v1/shopify/products`)

Destaques do Modelo de Dados Shopify

Clientes

Pedidos

Itens de Pedido

Produtos

Respostas