Saltar al contenido

Create a catalog binding

Módulo Procurement

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.

  • Requiere la capacidad procurement.catalog.write.
  • Alcances de OAuth: procurement.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: CatalogBindingCreate

catalogBindings.create: CatalogBindingCreate
CampoTipoObligatorioDescripción
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]+$
namestringSíName 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}$
{
  "element_id": "4000.01.01-XPMS-001",
  "name": "4x8 Stage Deck",
  "unit_basis": "ea",
  "default_unit_price_minor": 4500,
  "currency_code": "USD"
}

Respuesta 201: CatalogBinding

catalogBindings.create: 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 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"}'