/items/{id}/cancel

Cancel an item. This API call will only succeed if the Cancel action has been configured in your Bridge. Contact your administrator to know more.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
{
  "id":"5d8c22e845202c1c985c019d",
  "reference":"RX44J",
  "trackingId":"39a90b97-7c8d-4c54-b6a3-0e5c32cecfbc",
  "parentItemId":null,
  "customProperties":[
    {
      "type":"ID",
      "name":"Invoice Number",
      "codeName":"INVOICE_NUMBER",
      "value":"123"
    }],
  "service":null,
  "eta":{
    "from":"2019-09-26T13:36:10.42+08:00",
    "to":"2019-09-26T13:36:10.42+08:00"
  },
  "target":{
    "id":null,
    "company":"Test",
    "name":"Test",
    "phone":"1111",
    "email":"",
    "location":{
      "address1":"Blk 17 Dover Crescent",
      "address2":null,
      "postalCode":"130018",
      "countryCode":"SG",
      "coordinates":{
        "latitude":1.308001,
        "longitude":103.783166,
        "accuracy":"HEURISTIC"
      }
    }
  },
  "numberOfLineItems":3,
  "counters":[
  ],
  "majorState":"CLOSED",
  "statuses":[
    {
      "groupName":"DO",
      "groupCodeName":"ADS",
      "value":null
    }],
  "createdAt":"2019-09-26T10:31:04.54+08:00",
  "updatedAt":"2019-09-26T13:36:10.53+08:00",
  "currentSegment":null,
  "futureSegments":[
  ]
}

📘

Required parameters are marked with an asterisk (*).

Path Params
string
required

Unique ID of the item

Responses

Language
Credentials
Query
URL
LoadingLoading…
Response
Choose an example:
application/json