Skip to content

Create a vendor class assignment

Vendors module

POST/vendor-class-assignmentsvendorClassAssignments.create

A vendor placed in a vendor class. Creates a vendor class assignment. 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: VendorClassAssignmentCreate

vendorClassAssignments.create: VendorClassAssignmentCreate
FieldTypeRequiredDescription
vendor_idstring (uuid)YesIdentifier of the vendor.
vendor_class_idstring (uuid)YesIdentifier of the vendor class.
{
  "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "vendor_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: VendorClassAssignment

vendorClassAssignments.create: VendorClassAssignment
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the vendor class assignment.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
vendor_idstring (uuid)YesIdentifier of the vendor.
vendor_class_idstring (uuid)YesIdentifier of the vendor class.
{
  "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",
  "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "vendor_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/vendor-class-assignments" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"vendor_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","vendor_class_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.vendorClassAssignments.create({
    "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "vendor_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.vendor_class_assignments.create({"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "vendor_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos vendor-class-assignments create --data '{"vendor_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","vendor_class_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'