vértice
Produto Preços Painel
WhatsApp Business

Produtos de coleção no resultado do provedor

Limitado à página de coleções/produtos retornada pelo provedor.

API key Escopo read
Exemplo de requisição
curl -X GET "https://seu-dominio/instances/:id/business/collections/:collectionId/products" \
  -H "x-api-key: $VERTICE_API_KEY"
GET /instances/{id}/business/collections/{collectionId}/products
API key
Entenda

Conceituação

Limitado à página de coleções/produtos retornada pelo provedor. Não é uma varredura completa de todas as páginas.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

Path

id string obrigatório

ID da instância.

collectionId string obrigatório

Parâmetro collectionId da rota.

Query

limit string opcional

Valores aceitos: 51 (1..100).

Contrato

Resposta

200
{
  "data": {
    "id": "..."
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.