Delete a consignment
curl --request DELETE \
--url https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text){
"deleted": true,
"id": "cons_01J9ZK..."
}
Consignments
Delete a consignment
Permanently delete a consignment.
DELETE
/
consignments
/
{id}
Delete a consignment
curl --request DELETE \
--url https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{tenant}.mytraddal.com/admin/api/v1/consignments/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text){
"deleted": true,
"id": "cons_01J9ZK..."
}
Requires the
consignments:write scope.
string
required
The consignment ID.
Deletion is permanent. Consignments that are on a manifest or have active
holds may be protected by your workspace’s guard rules and refuse deletion.
{
"deleted": true,
"id": "cons_01J9ZK..."
}
⌘I