Create a vendor class

Vendors module

POST/vendor-classesvendorClasses.create

An org vendor class, seeded from the Standard Library. Creates a vendor class. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability vendors.class.write.
OAuth scopes: vendors.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: VendorClassCreate

vendorClasses.create: VendorClassCreate
Field	Type	Required	Description
name	string	Yes	Vendor class name.Constraints: length 1 to 300
std_vendor_class_id	string \| null	No	Standard Library vendor class adopted.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
description	string \| null	No	What the class covers.Constraints: length 1 to 20000

{
  "name": "Staging",
  "std_vendor_class_id": "VC-001",
  "description": "Staging rental houses."
}

Response 201: VendorClass

vendorClasses.create: VendorClass
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the vendor class.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Yes	Vendor class name.Constraints: length 1 to 300
std_vendor_class_id	string \| null	Yes	Standard Library vendor class adopted.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
description	string \| null	Yes	What the class covers.Constraints: length 1 to 20000

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Staging",
  "std_vendor_class_id": "VC-001",
  "description": "Staging rental houses."
}

Code samples

curl -X POST "$XOS_BASE_URL/vendor-classes" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Staging","std_vendor_class_id":"VC-001","description":"Staging rental houses."}'

const { data } = await xos.vendorClasses.create({
    "name": "Staging",
    "std_vendor_class_id": "VC-001",
    "description": "Staging rental houses."
  });

response = xos.vendor_classes.create({"name": "Staging", "std_vendor_class_id": "VC-001", "description": "Staging rental houses."})

xos vendor-classes create --data '{"name":"Staging","std_vendor_class_id":"VC-001","description":"Staging rental houses."}'