Ver .md

products.offer_deliverables_set

Definir o que a oferta não entrega. Troca a lista de entregáveis do produto que a oferta NÃO entrega (excludedIds). A oferta principal herda tudo e não aceita exclusões.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/products.offer_deliverables_set (corpo JSON)
  • Quem pode chamar: administrador da conta
  • Escopo da chave: crm:write
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: products_offer_deliverables_set
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId products.offer_deliverables_set)

Entrada

CampoTipoObrigatórioNota
offerIdstring (uuid)sim
excludedIdsstring (uuid)[]sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "offerId": {
      "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)$"
    },
    "excludedIds": {
      "maxItems": 200,
      "type": "array",
      "items": {
        "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": [
    "offerId",
    "excludedIds"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs products.offer_deliverables_set --json '{"offerId":"00000000-0000-0000-0000-000000000000","excludedIds":[]}'

MCP: ferramenta products_offer_deliverables_set com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "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).