Skip to content
XOS Developers

Delete a vendor class

Vendors module

DELETE/vendor-classes/{id}vendorClasses.delete

An org vendor class, seeded from the Standard Library. Soft-deletes the vendor class: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

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

Response 204: no body.

Code samples

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