Saltar al contenido

Update a catalog binding

Módulo Procurement

PATCH/catalog-bindings/{id}catalogBindings.update

A tenant item bound to a canon element. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad procurement.catalog.write.
  • Alcances de OAuth: procurement.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

catalogBindings.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the catalog binding.

Cuerpo de la solicitud: CatalogBindingUpdate

catalogBindings.update: CatalogBindingUpdate
CampoTipoObligatorioDescripción
namestringNoName the org uses for the item.Restricciones: length 1 to 300
unit_basisstring | nullNoUnit the item is bought in.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_unit_price_minorinteger (int64) | nullNoDefault unit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullNoISO 4217 currency of the default price.Restricciones: pattern ^[A-Z]{3}$
{
  "name": "4x8 Stage Deck",
  "unit_basis": "ea",
  "default_unit_price_minor": 4500,
  "currency_code": "USD"
}

Respuesta 200: CatalogBinding

catalogBindings.update: CatalogBinding
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the catalog binding.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
element_idItemIdSí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_idstringSíItem ID {URID}-{ORG}-{SEQ}, issued by the database.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
namestringSíName the org uses for the item.Restricciones: length 1 to 300
unit_basisstring | nullSíUnit the item is bought in.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_unit_price_minorinteger (int64) | nullSíDefault unit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullSí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 PATCH "$XOS_BASE_URL/catalog-bindings/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"name":"4x8 Stage Deck","unit_basis":"ea","default_unit_price_minor":4500,"currency_code":"USD"}'
const { data, etag } = await xos.catalogBindings.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "4x8 Stage Deck",
    "unit_basis": "ea",
    "default_unit_price_minor": 4500,
    "currency_code": "USD"
  }, { ifMatch: etag });
response = xos.catalog_bindings.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "4x8 Stage Deck", "unit_basis": "ea", "default_unit_price_minor": 4500, "currency_code": "USD"}, if_match=etag)
xos catalog-bindings update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"4x8 Stage Deck","unit_basis":"ea","default_unit_price_minor":4500,"currency_code":"USD"}' --if-match auto