Create a catalog binding

Procurement module

POST/catalog-bindingscatalogBindings.create

A tenant item bound to a canon element. Creates a catalog binding. 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 procurement.catalog.write.
OAuth scopes: procurement.
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: CatalogBindingCreate

catalogBindings.create: CatalogBindingCreate
Field	Type	Required	Description
element_id	ItemId	Yes	Catalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$
name	string	Yes	Name the org uses for the item.Constraints: length 1 to 300
unit_basis	string \| null	No	Unit the item is bought in.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_unit_price_minor	integer (int64) \| null	No	Default unit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	No	ISO 4217 currency of the default price.Constraints: pattern ^[A-Z]{3}$

{
  "element_id": "4000.01.01-XPMS-001",
  "name": "4x8 Stage Deck",
  "unit_basis": "ea",
  "default_unit_price_minor": 4500,
  "currency_code": "USD"
}

Response 201: CatalogBinding

catalogBindings.create: CatalogBinding
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the catalog binding.
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.
element_id	ItemId	Yes	Catalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$
item_id	string	Yes	Item ID {URID}-{ORG}-{SEQ}, issued by the database.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
name	string	Yes	Name the org uses for the item.Constraints: length 1 to 300
unit_basis	string \| null	Yes	Unit the item is bought in.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_unit_price_minor	integer (int64) \| null	Yes	Default unit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	Yes	ISO 4217 currency of the default price.Constraints: pattern ^[A-Z]{3}$

{
  "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",
  "element_id": "4000.01.01-XPMS-001",
  "item_id": "0000.01.01-NORTHW-001",
  "name": "4x8 Stage Deck",
  "unit_basis": "ea",
  "default_unit_price_minor": 4500,
  "currency_code": "USD"
}

Code samples

curl -X POST "$XOS_BASE_URL/catalog-bindings" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"element_id":"4000.01.01-XPMS-001","name":"4x8 Stage Deck","unit_basis":"ea","default_unit_price_minor":4500,"currency_code":"USD"}'

const { data } = await xos.catalogBindings.create({
    "element_id": "4000.01.01-XPMS-001",
    "name": "4x8 Stage Deck",
    "unit_basis": "ea",
    "default_unit_price_minor": 4500,
    "currency_code": "USD"
  });

response = xos.catalog_bindings.create({"element_id": "4000.01.01-XPMS-001", "name": "4x8 Stage Deck", "unit_basis": "ea", "default_unit_price_minor": 4500, "currency_code": "USD"})

xos catalog-bindings create --data '{"element_id":"4000.01.01-XPMS-001","name":"4x8 Stage Deck","unit_basis":"ea","default_unit_price_minor":4500,"currency_code":"USD"}'