{
  "opencollection": "1.0.0",
  "info": {
    "name": "commercetools Change History Carts Subscriptions API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Subscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://history.{region}.commercetools.com/:projectKey/subscriptions",
            "params": [
              {
                "name": "projectKey",
                "value": "",
                "type": "path",
                "description": "The unique key identifying the commercetools project."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return. Defaults to 20, maximum 500."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Number of results to skip for pagination. Maximum 10000."
              },
              {
                "name": "where",
                "value": "",
                "type": "query",
                "description": "Query predicate string for filtering results. Uses commercetools predicate syntax (e.g., 'customerEmail = \"user@example.com\"')."
              }
            ]
          },
          "docs": "Returns a paginated list of all subscriptions configured in the project. Subscriptions define destinations for change notifications and message delivery to external services such as SQS, SNS, Google Pub/Sub, or Azure Service Bus."
        },
        {
          "info": {
            "name": "Create a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://history.{region}.commercetools.com/:projectKey/subscriptions",
            "params": [
              {
                "name": "projectKey",
                "value": "",
                "type": "path",
                "description": "The unique key identifying the commercetools project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new subscription that routes messages and change notifications to an external destination. Supported destinations include AWS SQS, SNS, EventBridge, Azure Service Bus, Event Grid, Google Pub/Sub, and Confluent Cloud. A maximum of 50 subscriptions per project is allowed."
        },
        {
          "info": {
            "name": "Get a subscription by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://history.{region}.commercetools.com/:projectKey/subscriptions/:id",
            "params": [
              {
                "name": "projectKey",
                "value": "",
                "type": "path",
                "description": "The unique key identifying the commercetools project."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The system-generated unique identifier of the resource."
              }
            ]
          },
          "docs": "Retrieves a single subscription by its system-generated ID, including its destination configuration, message type filters, change filters, and delivery format settings."
        },
        {
          "info": {
            "name": "Update a subscription by ID",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://history.{region}.commercetools.com/:projectKey/subscriptions/:id",
            "params": [
              {
                "name": "projectKey",
                "value": "",
                "type": "path",
                "description": "The unique key identifying the commercetools project."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The system-generated unique identifier of the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Applies update actions to the subscription with the given ID. Supported actions include changing the destination, setting message types, setting changes, and changing the format."
        },
        {
          "info": {
            "name": "Delete a subscription by ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://history.{region}.commercetools.com/:projectKey/subscriptions/:id",
            "params": [
              {
                "name": "projectKey",
                "value": "",
                "type": "path",
                "description": "The unique key identifying the commercetools project."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The system-generated unique identifier of the resource."
              },
              {
                "name": "version",
                "value": "",
                "type": "query",
                "description": "Current version of the resource for optimistic concurrency control."
              }
            ]
          },
          "docs": "Permanently deletes the subscription with the given ID. The current version must be provided. After deletion, no further messages are routed to the associated destination."
        }
      ]
    }
  ],
  "bundled": true
}