Integrações com lojas

Os endpoints que suportam a aplicação LLM Pulse para Shopify: associar uma loja ao respetivo projeto, enviar as encomendas que os assistentes de IA encaminharam para a loja e consultá-las depois, e transformar produtos do catálogo em prompts de compradores para monitorizar. Requerem uma chave de API, ou seja, o plano Scale ou superior, e não estão disponíveis para contas com um portal de marca branca ou um embed, que recebem ERR_INTEGRATION_UNAVAILABLE (403).

GET`/store_connection`

Indica a uma aplicação de loja se a conta da chave de API a pode utilizar e a que projeto pertence a loja. project é o projeto ativo cujo domínio é igual ao domínio da loja; na falta deste, um projeto cujo domínio seja um domínio pai ou um subdomínio do domínio da loja; caso contrário, null. Quando vários projetos ativos correspondem da mesma forma, project é null e ambiguous é true. candidates lista todos os projetos ativos da conta, para que a aplicação possa apresentar um seletor. Não aceita project_id.

Parâmetros:

platformobrigatório, shopify
domainobrigatório, o domínio da loja, com ou sem esquema

GET`/ai_orders`

Devolve as encomendas encaminhadas por IA que uma aplicação de loja enviou para um projeto: totais, uma linha por assistente de IA e uma série diária. Cada revenue é uma string decimal expressa na moeda de currency, campo que é null quando o intervalo não contém nenhuma encomenda armazenada. Os membros da equipa precisam de acesso de leitura a Tráfego de IA.

Parâmetros: project_id (obrigatório), platform (predefinição: shopify), from / to (YYYY-MM-DD; predefinição: os 90 dias que terminam hoje; no máximo 400 dias).

GET`/catalog_prompt_suggestions`

Lista os prompts de compradores sugeridos a partir do catálogo de uma loja, do mais antigo para o mais recente, com o respetivo estado e o produto que deu origem a cada um. Os membros da equipa precisam de acesso de leitura a Prompts.

Parâmetros:

project_idobrigatório
statuspending|accepted|rejected
product_external_id
page
per_pagepredefinição 50, máximo 100

PUT`/ai_orders`

Substitui, para um intervalo, as encomendas diárias encaminhadas por IA e a respetiva receita. Envie como referrer o host de referência em bruto ou o utm_source da primeira visita de cada encomenda: o LLM Pulse classifica-o e ignora tudo o que não seja um assistente de IA, e a resposta indica o número de linhas armazenadas (stored) e de entradas ignoradas (ignored). Todas as linhas armazenadas desse projeto e dessa plataforma entre from e to são substituídas, pelo que voltar a enviar o mesmo intervalo converge para o mesmo resultado em vez de contar duas vezes. Requer uma chave de API com âmbito de escrita; os membros da equipa precisam de acesso de atualização a Tráfego de IA.

Corpo (JSON): project_id (obrigatório), platform (obrigatório, shopify), currency (obrigatório, ISO 4217), from e to (obrigatórios, YYYY-MM-DD, no máximo 400 dias), days (obrigatório, até 400 entradas com day, referrer, orders e revenue).

POST`/catalog_prompt_suggestions`

Escreve prompts de compradores para até 20 produtos do catálogo e guarda-os como sugestões pendentes na fila Prompts sugeridos do projeto. data contém apenas as novas sugestões e skipped conta os prompts que o projeto já tinha como sugestão. Utiliza a mesma quota horária de sugestões de prompts que a aplicação (ERR_QUOTA_EXCEEDED quando estiver esgotada); uma geração falhada devolve ERR_GENERATION_FAILED (502) e pode ser repetida. Requer uma chave de API com âmbito de escrita; os membros da equipa precisam de acesso de criação a Prompts.

Corpo (JSON): project_id (obrigatório), platform (obrigatório, shopify), products (obrigatório, de 1 a 20 objetos; external_id e title obrigatórios, handle, product_type, vendor, tags, collections e url opcionais), country_code e language_code (predefinição: os do projeto).

POST`/catalog_prompt_suggestions/accept`

Inicia a monitorização das sugestões pendentes: cada uma passa a ser um prompt, associado a uma coleção com o nome do respetivo produto. As sugestões que já não estejam pendentes são devolvidas em skipped, com o respetivo estado como motivo. Se os novos prompts excederem o limite do plano, o pedido devolve ERR_LIMIT_REACHED e não aceita nenhuma sugestão. Requer uma chave de API com âmbito de escrita; os membros da equipa precisam de acesso de criação a Prompts.

Corpo (JSON):

project_idobrigatório
idsobrigatório, até 100 IDs de sugestões, todas do mesmo país e idioma

POST`/catalog_prompt_suggestions/reject`

Marca as sugestões pendentes como rejeitadas. As sugestões que já não estejam pendentes mantêm-se inalteradas, e rejected indica quantas foram alteradas. Requer uma chave de API com âmbito de escrita; os membros da equipa precisam de acesso de atualização a Prompts.

Corpo (JSON):

project_idobrigatório
idsobrigatório, até 100 IDs de sugestões

Exemplos de código

Download: OpenAPI Swagger Postman

Perguntar à IA: Abrir no ChatGPT Abrir no Claude Ver como Markdown

Linguagem

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/store_connection?platform=shopify&domain=acme-store.com"

const response = await fetch("https://api.llmpulse.ai/api/v1/store_connection?platform=shopify&domain=acme-store.com", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/store_connection?platform=shopify&domain=acme-store.com",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/store_connection?platform=shopify&domain=acme-store.com",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/store_connection?platform=shopify&domain=acme-store.com", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/store_connection?platform=shopify&domain=acme-store.com', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/store_connection?platform=shopify&domain=acme-store.com"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/ai_orders?project_id=PROJECT_ID&platform=shopify&from=2026-07-06&to=2026-10-03"

const response = await fetch("https://api.llmpulse.ai/api/v1/ai_orders?project_id=PROJECT_ID&platform=shopify&from=2026-07-06&to=2026-10-03", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/ai_orders?project_id=PROJECT_ID&platform=shopify&from=2026-07-06&to=2026-10-03",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/ai_orders?project_id=PROJECT_ID&platform=shopify&from=2026-07-06&to=2026-10-03",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/ai_orders?project_id=PROJECT_ID&platform=shopify&from=2026-07-06&to=2026-10-03", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/ai_orders?project_id=PROJECT_ID&platform=shopify&from=2026-07-06&to=2026-10-03', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/ai_orders?project_id=PROJECT_ID&platform=shopify&from=2026-07-06&to=2026-10-03"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions?project_id=PROJECT_ID&status=pending"

const response = await fetch("https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions?project_id=PROJECT_ID&status=pending", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions?project_id=PROJECT_ID&status=pending",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions?project_id=PROJECT_ID&status=pending",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions?project_id=PROJECT_ID&status=pending", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions?project_id=PROJECT_ID&status=pending', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions?project_id=PROJECT_ID&status=pending"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X PUT -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID","platform":"shopify","currency":"EUR","from":"2026-09-04","to":"2026-10-03","days":[{"day":"2026-10-01","referrer":"chatgpt.com","orders":3,"revenue":"120.50"}]}' \
  "https://api.llmpulse.ai/api/v1/ai_orders"

const response = await fetch("https://api.llmpulse.ai/api/v1/ai_orders", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID","platform":"shopify","currency":"EUR","from":"2026-09-04","to":"2026-10-03","days":[{"day":"2026-10-01","referrer":"chatgpt.com","orders":3,"revenue":"120.50"}]})
});
const data = await response.json();

import requests

response = requests.put(
    "https://api.llmpulse.ai/api/v1/ai_orders",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id":"PROJECT_ID","platform":"shopify","currency":"EUR","from":"2026-09-04","to":"2026-10-03","days":[{"day":"2026-10-01","referrer":"chatgpt.com","orders":3,"revenue":"120.50"}]}
)
data = response.json()

require 'httparty'

response = HTTParty.put(
  "https://api.llmpulse.ai/api/v1/ai_orders",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" },
  body: {"project_id":"PROJECT_ID","platform":"shopify","currency":"EUR","from":"2026-09-04","to":"2026-10-03","days":[{"day":"2026-10-01","referrer":"chatgpt.com","orders":3,"revenue":"120.50"}]}
)
data = response.parsed_response

req, _ := http.NewRequest("PUT", "https://api.llmpulse.ai/api/v1/ai_orders", strings.NewReader(`{"project_id":"PROJECT_ID","platform":"shopify","currency":"EUR","from":"2026-09-04","to":"2026-10-03","days":[{"day":"2026-10-01","referrer":"chatgpt.com","orders":3,"revenue":"120.50"}]}`))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://api.llmpulse.ai/api/v1/ai_orders', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => {"project_id":"PROJECT_ID","platform":"shopify","currency":"EUR","from":"2026-09-04","to":"2026-10-03","days":[{"day":"2026-10-01","referrer":"chatgpt.com","orders":3,"revenue":"120.50"}]}
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/ai_orders"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .PUT(HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\",\"platform\":\"shopify\",\"currency\":\"EUR\",\"from\":\"2026-09-04\",\"to\":\"2026-10-03\",\"days\":[{\"day\":\"2026-10-01\",\"referrer\":\"chatgpt.com\",\"orders\":3,\"revenue\":\"120.50\"}]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID","platform":"shopify","products":[{"external_id":"gid://shopify/Product/1","handle":"trail-runner","title":"Trail Runner 2","product_type":"Running shoes","url":"https://acme-store.com/products/trail-runner"}]}' \
  "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions"

const response = await fetch("https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID","platform":"shopify","products":[{"external_id":"gid://shopify/Product/1","handle":"trail-runner","title":"Trail Runner 2","product_type":"Running shoes","url":"https://acme-store.com/products/trail-runner"}]})
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id":"PROJECT_ID","platform":"shopify","products":[{"external_id":"gid://shopify/Product/1","handle":"trail-runner","title":"Trail Runner 2","product_type":"Running shoes","url":"https://acme-store.com/products/trail-runner"}]}
)
data = response.json()

require 'httparty'

response = HTTParty.post(
  "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" },
  body: {"project_id":"PROJECT_ID","platform":"shopify","products":[{"external_id":"gid://shopify/Product/1","handle":"trail-runner","title":"Trail Runner 2","product_type":"Running shoes","url":"https://acme-store.com/products/trail-runner"}]}
)
data = response.parsed_response

req, _ := http.NewRequest("POST", "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions", strings.NewReader(`{"project_id":"PROJECT_ID","platform":"shopify","products":[{"external_id":"gid://shopify/Product/1","handle":"trail-runner","title":"Trail Runner 2","product_type":"Running shoes","url":"https://acme-store.com/products/trail-runner"}]}`))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => {"project_id":"PROJECT_ID","platform":"shopify","products":[{"external_id":"gid://shopify/Product/1","handle":"trail-runner","title":"Trail Runner 2","product_type":"Running shoes","url":"https://acme-store.com/products/trail-runner"}]}
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\",\"platform\":\"shopify\",\"products\":[{\"external_id\":\"gid://shopify/Product/1\",\"handle\":\"trail-runner\",\"title\":\"Trail Runner 2\",\"product_type\":\"Running shoes\",\"url\":\"https://acme-store.com/products/trail-runner\"}]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID","ids":[1,2]}' \
  "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/accept"

const response = await fetch("https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/accept", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID","ids":[1,2]})
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/accept",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id":"PROJECT_ID","ids":[1,2]}
)
data = response.json()

require 'httparty'

response = HTTParty.post(
  "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/accept",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" },
  body: {"project_id":"PROJECT_ID","ids":[1,2]}
)
data = response.parsed_response

req, _ := http.NewRequest("POST", "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/accept", strings.NewReader(`{"project_id":"PROJECT_ID","ids":[1,2]}`))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/accept', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => {"project_id":"PROJECT_ID","ids":[1,2]}
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/accept"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\",\"ids\":[1,2]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID","ids":[3]}' \
  "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/reject"

const response = await fetch("https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/reject", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID","ids":[3]})
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/reject",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id":"PROJECT_ID","ids":[3]}
)
data = response.json()

require 'httparty'

response = HTTParty.post(
  "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/reject",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" },
  body: {"project_id":"PROJECT_ID","ids":[3]}
)
data = response.parsed_response

req, _ := http.NewRequest("POST", "https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/reject", strings.NewReader(`{"project_id":"PROJECT_ID","ids":[3]}`))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/reject', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => {"project_id":"PROJECT_ID","ids":[3]}
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/catalog_prompt_suggestions/reject"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\",\"ids\":[3]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Integrações com lojas

GET/store_connection

GET/ai_orders

GET/catalog_prompt_suggestions

PUT/ai_orders

POST/catalog_prompt_suggestions

POST/catalog_prompt_suggestions/accept

POST/catalog_prompt_suggestions/reject

GET`/store_connection`

GET`/ai_orders`

GET`/catalog_prompt_suggestions`

PUT`/ai_orders`

POST`/catalog_prompt_suggestions`

POST`/catalog_prompt_suggestions/accept`

POST`/catalog_prompt_suggestions/reject`