Cancel Queued Job

Overview

You can use this endpoint to cancel a single existing Queued Job. To consume it, you must be an Authenticated User. Once you have obtained a valid token, it must be passed on the call.

Endpoint

An example of this endpoint for server XX:

https://xx.api.sellercloud.com/rest/api/QueuedJobs/Cancel?id={id}

For your server, the endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/QueuedJobs/Cancell?id={id}

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameter (query): Valid ID of an existing Queued Job that is not cancelled or completed.

Response

  • If the user is authenticated and the request is successful, then the response will be Status Code 200 => OK
  • If the user is not authenticated, then the response will be Status Code 401 => Error: Unauthorized
  • In case of an error, the response will be Status Code 500 => Internal Server Error
  • In case of an incorrect request, the response will be Status Code => 400 Bad Request

Was this article helpful?