SubscriptionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/bol-com/json-schema/bol-com-subscription-request-schema.json",
  "title": "SubscriptionRequest",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bol-com-openapi.json#/components/schemas/SubscriptionRequest",
  "required": [
    "resources",
    "subscriptionType",
    "url"
  ],
  "type": "object",
  "properties": {
    "resources": {
      "type": "array",
      "description": "Array of event types for which the subscription is set. Note that some event types are only available for certain subscription types.",
      "items": {
        "type": "string",
        "description": "Array of event types for which the subscription is set. Note that some event types are only available for certain subscription types.",
        "enum": [
          "PROCESS_STATUS",
          "SHIPMENT",
          "PRICE_STAR_BOUNDARY",
          "COMPETING_OFFER",
          "OFFER_FOR_SALE",
          "OFFER_NOT_FOR_SALE",
          "ORDER"
        ]
      }
    },
    "url": {
      "minLength": 1,
      "type": "string",
      "description": "The destination for event notifications. For WEBHOOK subscription types, this is the URL where messages are posted to. For GCP_PUBSUB, this is the topic name."
    },
    "subscriptionType": {
      "type": "string",
      "description": "The type of subscription. It indicates the platform where the events will be subscribed to. Be aware that certain event types are only available for specific types.",
      "enum": [
        "WEBHOOK",
        "GCP_PUBSUB",
        "AWS_SQS"
      ]
    },
    "enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether the subscription is enabled and will receive notifications or not. Defaults to true."
    },
    "identity": {
      "type": [
        "string",
        "null"
      ],
      "description": "Identity needed for publishing a notification. Must be provided if subscriptionType = AWS_SQS and must be in format of AWS ARN"
    }
  }
}