VendorRentalSettings

Response for vendor rental settings

Fields

    allowExtensions
    Boolean!
    Required
    Whether customers may extend a running rental.
    allowOneWayRentals
    Boolean!
    Required
    Whether an item may be returned to a different branch.
    createdAt
    DateTime!
    Required
    When the settings were created (UTC).
    deliveryBaseFee
    Decimal
    Flat delivery charge, in the merchant's currency. Null when none applies.
    deliveryPerKmFee
    Decimal
    Delivery charge per kilometre, in the merchant's currency. Null when delivery is not priced by distance.
    deliveryRadiusKm
    Decimal
    How far the merchant delivers, in kilometres. Null when delivery is off.
    depositFixedAmount
    Decimal
    Flat deposit, in the merchant's currency. Null unless the deposit is a fixed amount.
    depositMaxAmount
    Decimal
    Cap on the calculated deposit, in the merchant's currency. Null for no cap.
    depositPerDayAmount
    Decimal
    Deposit charged per rental day, in the merchant's currency. Null unless the deposit is per-day.
    depositPercentage
    Decimal
    Deposit as a percentage of the rental price. Null unless the deposit is percentage-based.
    depositType
    String!
    Required
    How the deposit is worked out: a percentage of the rental price, a fixed amount, or an amount per day.
    extensionNoticeHours
    Int!
    Required
    How long before the due time an extension must be asked for, in hours.
    freeDeliveryAbove
    Decimal
    Order value above which delivery is free, in the merchant's currency. Null when delivery is never free.
    gracePeriodHours
    Int!
    Required
    Hours allowed after the due time before a late fee starts.
    id
    Int!
    Required
    Unique identifier for the settings record.
    lateFeeFixed
    Decimal
    Flat late fee, in the merchant's currency. Null unless a flat fee applies.
    lateFeePerDay
    Decimal
    Late fee charged per day, in the merchant's currency. Null when the fee is not charged daily.
    lateFeePerHour
    Decimal
    Late fee charged per hour, in the merchant's currency. Null when the fee is not charged hourly.
    lateFeePercentage
    Decimal
    Late fee as a percentage of the rental price. Null unless the fee is percentage-based.
    lateFeeType
    String!
    Required
    How the late fee is worked out: none, a percentage of the rental price, or a flat amount per day.
    maxAdvanceBookingDays
    Int!
    Required
    How far ahead a rental may be booked, in days.
    maxExtensionDays
    Int
    Longest extension allowed, in days. Null when there is no limit.
    minAdvanceBookingHours
    Int!
    Required
    How far ahead a rental must be booked, in hours.
    offersDelivery
    Boolean!
    Required
    Whether the merchant delivers rented items.
    offersReturnPickup
    Boolean!
    Required
    Whether the merchant collects the item at the end of the rental.
    oneWayBaseFee
    Decimal
    Flat one-way charge, in the merchant's currency. Null unless the charge is flat.
    oneWayFeeType
    String!
    Required
    How the one-way charge is worked out: none, a flat fee, per kilometre, or from a branch-to-branch table.
    oneWayPerKmFee
    Decimal
    One-way charge per kilometre, in the merchant's currency. Null unless the charge is priced by distance.
    pickupReminderHours
    Int!
    Required
    How long before collection the reminder is sent, in hours.
    requireDeposit
    Boolean!
    Required
    Whether a deposit is taken on every rental.
    returnPickupFee
    Decimal
    Charge for collecting the item, in the merchant's currency. Null when none applies.
    returnReminderHours
    Int!
    Required
    How long before the return is due the reminder is sent, in hours.
    sameDayCutoffTime
    String

    Latest time of day a same-day rental is accepted, HH:MM. Null when there is no cutoff.

    sendPickupReminder
    Boolean!
    Required
    Whether a reminder is sent before collection.
    sendReturnReminder
    Boolean!
    Required
    Whether a reminder is sent before the return is due.
    updatedAt
    DateTime!
    Required
    When the settings were last changed (UTC).
    vendorId
    Int!
    Required
    Merchant these settings apply to.
Built with