POST /v1/external/orders/cancel

Use this API to cancel a created order. Multiple order_ids can be passed together as an array to cancel them simultaneously.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
idsYESintegerThe Shiprocket order id/ids of the orders that need to be canceled.16178831

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
ids[] Array No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.