Sign in
Custom Items

Update a Custom Item

Make changes to a custom item. Any blank parameter deletes an old value, any unspecified parameter does nothing

patch/custom-items/{id}

Path parameters

idstring required

The uberall unique id for the custom item

Request body

titlestring required

mandatory, the custom name, e.g. 'Strong Coffee'

descriptionstring
identifierstring
listNamestring
idinteger

The uberall unique id for the custom item

priceinteger

optional, the price of the custom, e.g. 1500 ( i.e. 15,00 EUR )

currencyobject

optional, indicating the currency for price and priceMax in ISO-4217, e.g. EUR

categorystring

optional, a category name, e.g. 'Coffee'

unitstring

optional, indicating the unit of measure, e.g. 'per kg'

urlstring

optional, a url related to the custom item

priceMaxinteger

optional, indicating there is a price range, e.g. 2500 ( i.e. 25,00 EUR )

Example request

{
  "category": "Coffee",
  "unit": "per kg"
}

Response

Successfully updated custom item

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Example response

{
  "response": {
    "customItem": {
      "category": "Coffee",
      "unit": "per kg"
    }
  }
}

Changes

No changes recorded. 2 of the 14 revisions have no diff computed, so they could not be searched.