Saltar al contenido

Update a vendor product

Módulo Procurement

PATCH/vendor-products/{id}vendorProducts.update

A product a vendor offers, optionally bound to an 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

vendorProducts.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the vendor product.

Cuerpo de la solicitud: VendorProductUpdate

vendorProducts.update: VendorProductUpdate
CampoTipoObligatorioDescripción
element_idItemIdNoCatalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$
unit_price_minorinteger (int64) | nullNoList unit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullNoISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
vendor_skustringNoThe vendor's product identifier.Restricciones: length 1 to 100
catalog_binding_idstring (uuid) | nullNoIdentifier of the catalog item the product fulfills.
lead_time_daysinteger | nullNoDays from order to delivery.Restricciones: range 0 to any
{
  "unit_price_minor": 4500,
  "currency_code": "USD",
  "vendor_sku": "DSS-DECK-0408",
  "catalog_binding_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "lead_time_days": 14
}

Respuesta 200: VendorProduct

vendorProducts.update: VendorProduct
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the vendor product.
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.
vendor_idstring (uuid)SíIdentifier of the vendor.
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]+$
unit_price_minorinteger (int64) | nullSíList unit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullSíISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
vendor_skustringSíThe vendor's product identifier.Restricciones: length 1 to 100
catalog_binding_idstring (uuid) | nullSíIdentifier of the catalog item the product fulfills.
lead_time_daysinteger | nullSíDays from order to delivery.Restricciones: range 0 to any
{
  "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",
  "element_id": "4000.01.01-XPMS-001",
  "unit_price_minor": 4500,
  "currency_code": "USD",
  "vendor_sku": "DSS-DECK-0408",
  "catalog_binding_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "lead_time_days": 14
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/vendor-products/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 '{"unit_price_minor":4500,"currency_code":"USD","vendor_sku":"DSS-DECK-0408","catalog_binding_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","lead_time_days":14}'
const { data, etag } = await xos.vendorProducts.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "unit_price_minor": 4500,
    "currency_code": "USD",
    "vendor_sku": "DSS-DECK-0408",
    "catalog_binding_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "lead_time_days": 14
  }, { ifMatch: etag });
response = xos.vendor_products.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"unit_price_minor": 4500, "currency_code": "USD", "vendor_sku": "DSS-DECK-0408", "catalog_binding_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "lead_time_days": 14}, if_match=etag)
xos vendor-products update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"unit_price_minor":4500,"currency_code":"USD","vendor_sku":"DSS-DECK-0408","catalog_binding_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","lead_time_days":14}' --if-match auto