products.coupon_list

Cupons do produto. Cupons de desconto do produto (percentual ou valor fixo em centavos) com uso, validade e público.

• Endpoint: POST https://app.atomiks.com.br/api/v1/products.coupon_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_coupon_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId products.coupon_list)

Entrada

{
  "$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.coupon_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.coupon_list --json '{"productId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta products_coupon_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"
          },
          "code": {
            "type": "string"
          },
          "discountType": {
            "type": "string",
            "enum": [
              "percentage",
              "fixed"
            ]
          },
          "discountValue": {
            "type": "number"
          },
          "active": {
            "type": "boolean"
          },
          "maxUses": {
            "type": [
              "number",
              "null"
            ]
          },
          "usedCount": {
            "type": "number"
          },
          "startsAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "endsAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "offerIds": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "audience": {
            "type": "string",
            "enum": [
              "everyone",
              "email_list",
              "offer_buyers"
            ]
          },
          "allowedEmails": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "requiredOfferIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "requiredMatch": {
            "type": "string",
            "enum": [
              "any",
              "all"
            ]
          }
        },
        "required": [
          "id",
          "productId",
          "code",
          "discountType",
          "discountValue",
          "active",
          "maxUses",
          "usedCount",
          "startsAt",
          "endsAt",
          "offerIds",
          "audience",
          "allowedEmails",
          "requiredOfferIds",
          "requiredMatch"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "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).