Get a catalog binding

Módulo Procurement

GET/catalog-bindings/{id}catalogBindings.get

A tenant item bound to a canon element. Returns one catalog binding with its `ETag`. A catalog binding the caller may not see returns 404.

Requiere la capacidad procurement.catalog.read.
Alcances de OAuth: procurement.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

catalogBindings.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the catalog binding.
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Respuesta 200: CatalogBinding

catalogBindings.get: CatalogBinding
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the catalog binding.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
element_id	ItemId	Sí	Catalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$
item_id	string	Sí	Item ID {URID}-{ORG}-{SEQ}, issued by the database.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
name	string	Sí	Name the org uses for the item.Restricciones: length 1 to 300
unit_basis	string \| null	Sí	Unit the item is bought in.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_unit_price_minor	integer (int64) \| null	Sí	Default unit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	Sí	ISO 4217 currency of the default price.Restricciones: 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"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/catalog-bindings/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.catalogBindings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.catalog_bindings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos catalog-bindings get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f