{"_id":"59c07ea2a00f90001cd75cc0","category":{"_id":"59c07ea1a00f90001cd75cb3","version":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-16T01:50:19.202Z","from_sync":false,"order":1,"slug":"reference-api-documentation","title":"Reference API Documentation"},"parentDoc":null,"project":"56c27a9a2be66d19008d618d","user":"56c27a665da27c17003df001","version":{"_id":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":1,"createdAt":"2017-09-19T02:19:13.858Z","releaseDate":"2017-09-19T02:19:13.858Z","categories":["59c07ea1a00f90001cd75cb2","59c07ea1a00f90001cd75cb3"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Rose","version_clean":"5.1.0","version":"5.1"},"githubsync":"","__v":4,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-16T04:48:59.057Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"Example","language":"json","code":"{\n   \"reason\": \"Sorry ah, dun want this item anymore.\"\n}"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"deliveryId\": \"abcd1234\",\n   \"status\": \"Success\"\n}","name":""},{"status":400,"language":"json","code":"{\n    \"type\": \"ERROR\",\n    \"code\": 4000,\n    \"message\": \"Invalid API key\"\n}","name":""}]},"settings":"56c2818b2be66d19008d6196","auth":"required","params":[{"_id":"56c30596deff570d00568a54","ref":"","in":"path","required":false,"desc":"Delivery Id","default":"","type":"string","name":"id"},{"_id":"56c30596deff570d00568a53","ref":"","in":"body","required":false,"desc":"Reason for cancelling the delivery","default":"","type":"string","name":"reason"}],"url":"/tr46/deliveries/:id/cancel"},"isReference":true,"order":12,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This API call will only succeed if your Zyllem Bridge configuration allows a **Cancel** action in the current state of the item. Contact your administrator to know more.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"\"\n}\n[/block]\n##:fa-life-ring:  [Ask a question](https://developer.zyllem.com/discuss)","excerpt":"Lets you cancel a delivery order for an item","slug":"deliveriesidcancel","type":"endpoint","title":"/tr46/deliveries/:id/cancel"}

post/tr46/deliveries/:id/cancel

Lets you cancel a delivery order for an item

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string
Delivery Id

Body Params

reason:
string
Reason for cancelling the delivery

Examples


Result Format


Documentation

[block:callout] { "type": "info", "body": "This API call will only succeed if your Zyllem Bridge configuration allows a **Cancel** action in the current state of the item. Contact your administrator to know more." } [/block] [block:api-header] { "type": "basic", "title": "" } [/block] ##:fa-life-ring: [Ask a question](https://developer.zyllem.com/discuss)