products.offer_archive

Arquivar ou desarquivar oferta. Arquiva (archived: true) ou restaura a oferta; arquivar também a desativa. A oferta principal não é arquivada: arquive o produto.

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

Entrada

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

Exemplo

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

CLI:

node cli/atomiks.mjs products.offer_archive --json '{"id":"00000000-0000-0000-0000-000000000000","archived":true}'

MCP: ferramenta products_offer_archive com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "productId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "isMain": {
      "type": "boolean"
    },
    "status": {
      "type": "string",
      "enum": [
        "incomplete",
        "ready_to_submit",
        "approved",
        "archived"
      ]
    },
    "priceCents": {
      "type": "number"
    },
    "newPriceCents": {
      "type": [
        "number",
        "null"
      ]
    },
    "recurrence": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "frequency": {
              "type": "string",
              "enum": [
                "monthly",
                "quarterly",
                "semi-annually",
                "yearly"
              ]
            },
            "intervalMonths": {
              "type": "integer",
              "minimum": 1,
              "maximum": 12
            },
            "trialDays": {
              "type": "integer",
              "minimum": 0,
              "maximum": 180
            }
          },
          "required": [
            "frequency",
            "intervalMonths",
            "trialDays"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "incompleteReason": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "hasCoupon": {
      "type": "boolean"
    },
    "archived": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "productId",
    "name",
    "isMain",
    "status",
    "priceCents",
    "newPriceCents",
    "recurrence",
    "incompleteReason",
    "hasCoupon",
    "archived"
  ],
  "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).