Tuhund - Delivery Order Cancellation API

API List

CRM Integration API

Delivery / Shipment Order API

Expense Claims Integration API

Inventory Module Integration API

Sales Module Integration API

Shopping Cart Integration API

Procurement Module API

Manufacturing Module API

API # : 8037 | API Name : docancel

This API is used to cancel multiple delivery orders. It returns status of up to 1000 orders in a single request.

All delivery orders cannot be cancelled. Orders already picked up will not cancel but will auto-generate RTO (Return to Origin) request. Orders that are already delivered will auto-generate RVP (Reverse Pickup) request.

In case the calling API key is not authorized to retrieve data for any record or modify any record, system will neither modify not return that data. No error code will be populated in such an event.

URL : <domain>/apic/docancel
Methods Allowed : POST

Payload Schema :

{
  "type": "object",
  "properties": {
    "id": {
      "type": "array",
      "items": [
        {
          "type": "string",
          "description":"Shipment Order ID, also known as Airway Bill Number or Tracking ID"
        }
      ]
    }
  },
  "required": [
    "id"
  ]
}

Sample Payload :

{
	"id":[
        "1617200099422",
        "1617200356674"
    ]
}

Request Headers :

Name	Description
device	A short name of your application. Device is mandatory but any value between 3 and 20 characters is accepted.
Authentication	Authentication code generated for API call.

Sample success response :

{
  "response": 1,
  "totalitems": 2,
  "list": [
    {
      "deliveryid": "1617200099422",
      "result": 1,
      "description": "Cancelled"
    },
    {
      "deliveryid": "1617200099423",
      "result": 1,
      "description": "Cancelled"
    },
    {
      "deliveryid": "1617200099424",
      "result": 2,
      "description": "RTO Generated",
      "rtoid": "1717256655564",
    },
    {
      "deliveryid": "1617200099428",
      "result": 3,
      "description": "RVP Generated",
      "rvpid": "1717256655564",
    },
    {
      "deliveryid": "1617200099425",
      "result": 0,
      "description": "No such record found"
    },
    {
      "deliveryid": "1617200099426",
      "result": -1,
      "description": "Not Permitted"
    },
    {
      "deliveryid": "1617200099426",
      "result": -2,
      "description": "Failed. Please try again"
    }
  ]
}