Ver .md

products.deliverable_list

Entregáveis do produto. Entregáveis do produto (offerId nulo vale para todas as ofertas) e os só de uma oferta, com exclusions: por oferta, os entregáveis do produto que ela não entrega.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/products.deliverable_list (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: products_deliverable_list
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId products.deliverable_list)

Entrada

CampoTipoObrigatórioNota
productIdstring (uuid)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "productId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/products.deliverable_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"productId":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs products.deliverable_list --json '{"productId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta products_deliverable_list com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "productId": {
            "type": "string"
          },
          "offerId": {
            "type": [
              "string",
              "null"
            ]
          },
          "category": {
            "type": "string",
            "enum": [
              "file",
              "link",
              "event",
              "email",
              "membership",
              "internal_membership",
              "webhook"
            ]
          },
          "name": {
            "type": "string"
          },
          "config": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "createdAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "productId",
          "offerId",
          "category",
          "name",
          "config",
          "createdAt"
        ],
        "additionalProperties": false
      }
    },
    "exclusions": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "items",
    "exclusions"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).