Delete Orphaned Listing Categories For Channel

deletehttps://api.flxpoint.com/listing/category/orphaned/channel

Use this when you want to delete listing data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Delete orphaned listing categories for a single channel (categories with no listing products associated). Accepts either an Account API Token or a Channel API Token; the caller must have access to the specified channel. Use this endpoint to retry cleanup for a single channel after a partial failure of the account-wide endpoint, or to target a specific channel known to have orphans.

Request

Query parameters

channelIdqueryinteger
The channel ID orphaned categories should be found and deleted from. When using a channel token nothing needs to be passed here. When using an account token the channel ID must be passed.

Example request

delete/listing/category/orphaned/channel

curl -X DELETE "https://api.flxpoint.com/listing/category/orphaned/channel" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json

deletedCountintegerrequired

default 0

Example response

{
  "deletedCount": 0
}

401Unauthorized

No schema documented for this status.

403Forbidden - Channel ID does not exist

No schema documented for this status.

OpenAPI fragment

{
  "delete": {
    "summary": "Delete Orphaned Listing Categories For Channel",
    "description": "Delete orphaned listing categories for a single channel (categories with no listing products associated). Accepts either an Account API Token or a Channel API Token; the caller must have access to the specified channel. Use this endpoint to retry cleanup for a single channel after a partial failure of the account-wide endpoint, or to target a specific channel known to have orphans.",
    "parameters": [
      {
        "in": "query",
        "name": "channelId",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "description": "The channel ID orphaned categories should be found and deleted from. When using a channel token nothing needs to be passed here. When using an account token the channel ID must be passed."
      }
    ],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/DeleteOrphanedCategoriesResponse"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      },
      "403": {
        "description": "Forbidden - Channel ID does not exist"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight