Skip to Content
ReferenceAPICatalogueUpdate a price

Catalogue API

Update a catalogue price

Update a contextual price for a catalogue item.

PATCH/v1/catalogue/items/{itemId}/prices/{priceId}
capability catalogue.prices.update · v1operational dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

  • itemIdstring<uuid>required
    path
  • priceIdstring<uuid>required
    path
  • type"base" | "override" | "sale"
    body
  • currencyCodestring
    bodymin length 3max length 3
  • amountinteger
    bodymin 0max 100000000000
  • minQuantityinteger
    bodymin 1max 10000
  • maxQuantityinteger | null
    bodymin 1max 10000
  • rulesobject[]
    bodymax items 20
    • attributestringrequired
      min length 1max length 120
    • operator"eq" | "neq" | "in" | "not_in" | "gt" | "gte" | "lt" | "lte"required
    • valuestring | number | boolean | string | number | boolean[]required
  • priorityinteger
    bodymin -1000max 1000
  • startsAtstring<date-time> | null
    body
  • endsAtstring<date-time> | null
    body
  • expectedUpdatedAtstring<date-time>required
    body

Response

Successful responses use Dawn's data envelope.

  • dataCataloguePricerequired
    • idstring<uuid>required
    • workspaceIdstring<uuid>required
    • catalogueItemIdstring<uuid>required
    • type"base" | "override" | "sale"required
    • currencyCodestringrequired
      min length 3max length 3
    • amountintegerrequired
      min 0max 100000000000
    • minQuantityintegerrequired
      min 1max 10000
    • maxQuantityinteger | nullrequired
      min 1max 10000
    • rulesobject[]required
      max items 20
      • attributestringrequired
        min length 1max length 120
      • operator"eq" | "neq" | "in" | "not_in" | "gt" | "gte" | "lt" | "lte"required
      • valuestring | number | boolean | string | number | boolean[]required
    • priorityintegerrequired
      min -1000max 1000
    • startsAtstring<date-time> | nullrequired
    • endsAtstring<date-time> | nullrequired
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
  • metaobject

Errors

Error responses use the shared error envelope.

  • 404The catalogue price could not be found.
  • 409The catalogue price changed after it was loaded.
  • 422The catalogue price is invalid.
  • 503The catalogue price could not be saved.
Last updated on