{
  "opencollection": "1.0.0",
  "info": {
    "name": "eBay Account Advertising_eligibility Subscription API",
    "version": "v1.9.2"
  },
  "items": [
    {
      "info": {
        "name": "Subscription",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "getSubscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ebay.com{basePath}/subscription",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "This field is for future use."
              },
              {
                "name": "continuation_token",
                "value": "",
                "type": "query",
                "description": "This field is for future use."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method retrieves a list of subscriptions associated with the seller account."
        },
        {
          "info": {
            "name": "createSubscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ebay.com{basePath}/subscription",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method allows applications to create a subscription for a topic and supported schema version. Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business.<br><br>Each application and topic-schema pairing to a subscription should have a 1:1 cardinality.<br><br>You can create the subscription in disabled mode, test it (see the <b>test</b> method), and when everything is ready, you can enable the subscription (see the <b>e"
        },
        {
          "info": {
            "name": "createSubscriptionFilter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ebay.com{basePath}/subscription/:subscription_id/filter",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription for which a filter will be created."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method allows applications to create a filter for a subscription. Filters allow applications to only be sent notifications that match a provided criteria. Notifications that do not match this criteria will not be sent to the destination.<br><br>The <strong>filterSchema</strong> value must be a valid <a href=\"https://json-schema.org \" target=\"_blank\">JSON Schema Core document</a> (version 2020-12 or later). The <strong>filterSchema</strong> provided must describe the subscription's notificat"
        },
        {
          "info": {
            "name": "getSubscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ebay.com{basePath}/subscription/:subscription_id",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription to retrieve. Use <b>getSubscriptions</b> to retrieve subscription IDs."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method allows applications to retrieve subscription details for the specified subscription.<br><br>Specify the subscription to retrieve using the <strong>subscription_id</strong>. Use the <strong>getSubscriptions</strong> method to browse all subscriptions if you do not know the <strong>subscription_id</strong>.<br><br>Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business."
        },
        {
          "info": {
            "name": "updateSubscription",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.ebay.com{basePath}/subscription/:subscription_id",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the subscription to update. Use <b>getSubscriptions</b> to retrieve subscription IDs."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method allows applications to update a subscription. Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business.<br><br><span class=\"tablenote\"><b>Note:</b> This call returns an error if an application is not authorized to subscribe to a topic.</span><br><br>You can pause and restart a subscription. See the <b>disableSubscription</b> and <b>enableSubscription</b> methods."
        },
        {
          "info": {
            "name": "deleteSubscription",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.ebay.com{basePath}/subscription/:subscription_id",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription to delete. Use <b>getSubscriptions</b> to retrieve subscription IDs."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method allows applications to delete a subscription. Subscriptions can be deleted regardless of status."
        },
        {
          "info": {
            "name": "getSubscriptionFilter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ebay.com{basePath}/subscription/:subscription_id/filter/:filter_id",
            "params": [
              {
                "name": "filter_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription filter.  Filter ID values, if configured for a subscription, will be shown in the <b>subscriptions.filterId</b> field in <b>getSubscription</b> and <b>getSubscription</b> responses. The filter ID value is also returned in the Location response header when a filter is created with <b>createSubscriptionFilter</b>."
              },
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription associated with the filter. Use <b>getSubscriptions</b> to retrieve subscription IDs."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method allows applications to retrieve the filter details for the specified subscription filter.<br><br>Specify the subscription filter to retrieve by using the <strong>subscription_id</strong> and the <strong>filter_id</strong> associated with the subscription filter. The <strong>filter_id</strong> can be found in the response body for the <strong>getSubscription</strong> method, if there is a filter applied on the subscription.<br><br>Filters allow applications to only be sent notificatio"
        },
        {
          "info": {
            "name": "deleteSubscriptionFilter",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.ebay.com{basePath}/subscription/:subscription_id/filter/:filter_id",
            "params": [
              {
                "name": "filter_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription filter to delete.  Filter ID values, if configured for a subscription, will be shown in the <b>subscriptions.filterId</b> field in <b>getSubscription</b> and <b>getSubscription</b> responses. The filter ID value is also returned in the Location response header when a filter is created with <b>createSubscriptionFilter</b>."
              },
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription associated with the filter to delete. Use <b>getSubscriptions</b> to retrieve subscription IDs."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method allows applications to disable the active filter on a subscription, so that a new subscription filter may be added.<br><br><span class=\"tablenote\"><b>Note:</b> Subscription filters in <strong>PENDING</strong> status can not be disabled. However, a new filter can be created instead with the <strong>createSubscriptionFilter</strong> method and this new filter will override the <strong>PENDING</strong> filter.</span>"
        },
        {
          "info": {
            "name": "disableSubscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ebay.com{basePath}/subscription/:subscription_id/disable",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an enabled subscription that will be disabled. Use <b>getSubscriptions</b> to retrieve subscription IDs."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method disables a subscription, which prevents the subscription from providing notifications. To restart a subscription, call <strong>enableSubscription</strong>."
        },
        {
          "info": {
            "name": "enableSubscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ebay.com{basePath}/subscription/:subscription_id/enable",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a disabled subscription that will be enabled. Use <b>getSubscriptions</b> to retrieve subscription IDs."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method allows applications to enable a disabled subscription. To pause (or disable) an enabled subscription, call <strong>disableSubscription</strong>."
        },
        {
          "info": {
            "name": "testSubscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ebay.com{basePath}/subscription/:subscription_id/test",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription to test. Use <b>getSubscriptions</b> to retrieve subscription IDs."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method triggers a mocked test payload that includes a notification ID, publish date, and so on. Use this method to test your subscription end-to-end.<br><br>You can create the subscription in disabled mode, test it using this method, and when everything is ready, you can enable the subscription (see the <strong>enableSubscription</strong> method).<br><br><span class=\"tablenote\"><b>Note:</b> Use the <strong>notificationId</strong> to tell the difference between a test payload and a real payl"
        }
      ]
    }
  ],
  "bundled": true
}