Skip to content
XOS Developers

Delete a vendor

Vendors module

DELETE/vendors/{id}vendors.delete

An organization in the vendor relationship with this org, with its counterparty type. Soft-deletes the vendor: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability vendors.vendor.write.
  • OAuth scopes: vendors.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

vendors.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the vendor.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/vendors/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.vendors.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.vendors.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos vendors delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f