Items
Update the pricing of an item
Sets the rental price, the sale price, the deposit, the replacement value and the time margins that block the item around a rental.
items:writeitems:write- 120/min
- Server annotation: Idempotent
Result
generated from the schema
The internal and external cost are NOT part of the public contract and cannot be written here. Returns the updated item in detail.
Arguments
Item identifier.
Limits: min length 1
Rental pricing, the three fields together; null clears it.
Show child attributesHide child attributes
Pricing mode.
Available options: periodPrice, fixedPrice, pricingStructure
Base rental price, as a decimal string.
Limits: pattern ^\d{1,13}(\.\d{1,2})?$
Period unit of the price.
Available options: hour, day, week, month
Sale price, as a decimal string; null clears it.
Limits: pattern ^\d{1,13}(\.\d{1,2})?$
Deposit amount, as a decimal string; null clears it.
Limits: pattern ^\d{1,13}(\.\d{1,2})?$
Replacement value, as a decimal string; null clears it.
Limits: pattern ^\d{1,13}(\.\d{1,2})?$
Whether the item allows insurance.
Whether the item allows discounts.
EAN or barcode; null clears it.
Limits: min length 1
Buffer time reserved BEFORE the rental; null clears it together with its unit.
Limits: min 0
Unit of the buffer before; null only together with bufferBefore: null.
Available options: hour, day
Buffer time reserved AFTER the rental; null clears it together with its unit.
Limits: min 0
Unit of the buffer after; null only together with bufferAfter: null.
Available options: hour, day
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique identifier of the item.
Item name.
SKU reference of the item; null if not recorded.
Item description; null if not recorded.
Additional information for the order (preparation/delivery notes); null if not recorded.
EAN/barcode; null if not recorded.
Item type: fixed (simple item) or variant (item with variants).
Available options: fixed, variant
Stock calculation method: bulk (in bulk, by quantity) or serialized (by serialized items).
Available options: bulk, serialized
Identifier of the collection it belongs to; null if it is in none.
Name of the collection it belongs to; null if it is in none.
URLs of the item images.
Sale price as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none.
Limits: pattern ^-?\d+\.\d{2}$
Deposit amount as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none.
Limits: pattern ^-?\d+\.\d{2}$
Minimum stock configured for alerts; null if not configured.
Number of serialized items registered for the item.
Rental pricing configuration; null if not configured.
Show child attributesHide child attributes
Pricing mode: periodPrice (price per period), fixedPrice (fixed price) or pricingStructure (pricing structure); null if the item has none configured.
Available options: periodPrice, fixedPrice, pricingStructure
Base rental price as a decimal string "1234.50" (ROUND_HALF_UP); null if not applicable.
Limits: pattern ^-?\d+\.\d{2}$
Period unit of the price: hour, day, week or month; null if the item has none configured.
Available options: hour, day, week, month
Whether the item allows insurance.
Whether the item allows discounts.
Buffer time reserved before the rental; null if not applicable.
Unit of the buffer before: hour or day; null if not applicable.
Available options: hour, day
Buffer time reserved after the rental; null if not applicable.
Unit of the buffer after: hour or day; null if not applicable.
Available options: hour, day
Physical properties (weight and dimensions); null if not recorded.
Show child attributesHide child attributes
Item weight in kilograms; null if not recorded.
Item width in centimeters; null if not recorded.
Item height in centimeters; null if not recorded.
Item length in centimeters; null if not recorded.
Item volume in cubic meters (m³); null if not recorded.
Current draw in amperes; null if not recorded.
Power in watts; null if not recorded.
Item variants (empty if the item is of type fixed).
Show child attributesHide child attributes
Unique identifier of the variant.
Variant name.
Rental price of the variant as a decimal string "1234.50" (ROUND_HALF_UP).
Limits: pattern ^-?\d+\.\d{2}$
Sale price of the variant as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none.
Limits: pattern ^-?\d+\.\d{2}$
EAN/barcode of the variant; null if not recorded.
Custom field values by custom field identifier; the definitions are in /api.
Creation date in ISO 8601 with offset.
Last update date in ISO 8601 with offset.
Replacement value of the item as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded.
Limits: pattern ^-?\d+\.\d{2}$
Identifiers of the items configured as accessories of this one.
Identifiers of the items configured as alternatives of this one.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs PATCH /api/v1/items/{itemId}/pricing.
Related pages
Link to this section: Related pagesItems
Update the pricing of an item
Sets the rental price, the sale price, the deposit, the replacement value and the time margins that block the item around a rental.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?