UpdateVendorRentalSettingsInput

Rental rules to apply across a merchant. Every field is optional; omitting one leaves that setting unchanged.

Fields

    allowExtensions
    Boolean
    Whether customers may extend a running rental.
    allowOneWayRentals
    Boolean
    Whether an item may be returned to a different branch.
    deliveryBaseFee
    Decimal
    Flat delivery charge, in the merchant's currency.
    deliveryPerKmFee
    Decimal
    Delivery charge per kilometre, in the merchant's currency.
    deliveryRadiusKm
    Decimal
    How far the merchant delivers, in kilometres.
    depositFixedAmount
    Decimal
    Flat deposit, in the merchant's currency.
    depositMaxAmount
    Decimal
    Cap on the calculated deposit, in the merchant's currency.
    depositPerDayAmount
    Decimal
    Deposit charged per rental day, in the merchant's currency.
    depositPercentage
    Decimal
    Deposit as a percentage of the rental price.
    depositType
    String
    How the deposit is worked out: "percentage", "fixed_amount" or "per_day".
    extensionNoticeHours
    Int
    How long before the due time an extension must be asked for, in hours (0-168).
    freeDeliveryAbove
    Decimal
    Order value above which delivery is free, in the merchant's currency.
    gracePeriodHours
    Int
    Hours allowed after the due time before a late fee starts (0-168).
    lateFeeFixed
    Decimal
    Flat late fee, in the merchant's currency.
    lateFeePerDay
    Decimal
    Late fee charged per day, in the merchant's currency.
    lateFeePerHour
    Decimal
    Late fee charged per hour, in the merchant's currency.
    lateFeePercentage
    Decimal
    Late fee as a percentage of the rental price.
    lateFeeType
    String
    How the late fee is worked out: "none", "percentage" or "fixed_per_day".
    maxAdvanceBookingDays
    Int
    How far ahead a rental may be booked, in days (1-365).
    maxExtensionDays
    Int
    Longest extension allowed, in days.
    minAdvanceBookingHours
    Int
    How far ahead a rental must be booked, in hours (0-720).
    offersDelivery
    Boolean
    Whether the merchant delivers rented items.
    offersReturnPickup
    Boolean
    Whether the merchant collects the item at the end of the rental.
    oneWayBaseFee
    Decimal
    Flat one-way charge, in the merchant's currency.
    oneWayFeeType
    String
    How the one-way charge is worked out: "none", "fixed", "per_km" or "matrix".
    oneWayPerKmFee
    Decimal
    One-way charge per kilometre, in the merchant's currency.
    pickupReminderHours
    Int
    How long before collection the reminder is sent, in hours (0-168).
    requireDeposit
    Boolean
    Whether a deposit is taken on every rental.
    returnPickupFee
    Decimal
    Charge for collecting the item, in the merchant's currency.
    returnReminderHours
    Int
    How long before the return is due the reminder is sent, in hours (0-168).
    sameDayCutoffTime
    String

    Latest time of day a same-day rental is accepted, HH:MM.

    sendPickupReminder
    Boolean
    Whether a reminder is sent before collection.
    sendReturnReminder
    Boolean
    Whether a reminder is sent before the return is due.
Built with