RentalMutation

Fields

    cancelOrder
    CancellationResult!
    Required
    Cancel one of the vendor's rentals with a reason.
      reason
      String!
      Required
      Why the rental is being cancelled.
      rentalId
      Int!
      Required
      Rental to cancel.
    createBot
    Bot!
    Required

    Create a new bot owned by the authenticated vendor.

    Requires a user-context token, unlike the other bot mutations: The bot records a human author, which is required and must be a real user. A client_credentials token has no honest value to put there, and inventing one would corrupt the attribution the public bot directory renders.

      input
      CreateBotInput!
      Required
      Details of the bot to create.
        avatarUrl
        String
        URL of the bot's avatar image.
        botType
        BotType!
        Required
        Which runtime surface the bot plugs into.
        category
        String
        Directory category the bot is filed under.
        configuration
        JSON
        Free-form JSON configuration passed through to the bot runtime.
        description
        String
        What the bot does, shown in the directory. Up to 500 characters.
        displayName
        String!
        Required
        Human-readable name shown in chat and the directory. 2–100 characters.
        isPublic
        Boolean

        Whether to list the bot in the public directory. Defaults to false.

        username
        String!
        Required

        Handle the bot is mentioned by, without the leading @. 3–50 characters, alphanumeric and underscores only, and unique platform-wide.

        webhookSecret
        String
        Shared secret the delivery signature is computed with. 32–128 characters. Store it — it is never returned again.
        webhookUrl
        String
        HTTPS URL to deliver the bot's events to. Without one it receives nothing.
    createLocation
    Location!
    Required
    Create a new location for the authenticated vendor.
      input
      CreateLocationInput!
      Required
      Details of the location to create.
        address
        String!
        Required
        Street address of the branch.
        city
        String
        City the branch is in.
        country
        String
        Country the branch is in.
        deliveryAvailable
        Boolean

        Whether the branch delivers. Defaults to true.

        deliveryRadius
        Float
        How far the branch delivers, in kilometres. Omit for unlimited.
        email
        String
        Contact email address for the branch.
        isActive
        Boolean

        Whether the branch is in service. Defaults to true.

        latitude
        Float
        Latitude in decimal degrees (WGS 84).
        longitude
        Float
        Longitude in decimal degrees (WGS 84).
        name
        String!
        Required

        Branch name, e.g. Downtown store.

        phone
        String
        Contact phone number for the branch.
        pickupAvailable
        Boolean

        Whether customers can collect from this branch. Defaults to true.

        postalCode
        String
        Postal or ZIP code.
        state
        String
        State, province or region the branch is in.
    createVendorCoupon
    Coupon!
    Required
    Create a coupon on this vendor's storefront. The code must be unique platform-wide, so a collision with an existing coupon — including another vendor's — is rejected.
      input
      CreateVendorCouponInput!
      Required
      Details of the coupon to create.
        code
        String!
        Required
        Code customers type at checkout. Must be unique across the platform.
        color
        String!
        Required
        Hex colour for UI display (e.g. "#FF5733").
        description
        String
        Terms or explanation shown with the coupon. Optional.
        discount
        Decimal!
        Required

        Percentage when percentage is true, otherwise a fixed amount.

        Never negative: the order paths subtract this, so a negative value would increase what the customer pays.

        expiresOn
        DateTime
        When the coupon stops working (UTC). Omit for a coupon that never expires.
        forDelivery
        Boolean!
        Required
        Whether the discount applies to the delivery fee.
        isActive
        Boolean!
        Required
        Whether the coupon can be redeemed straight away.
        maxCouponAmount
        Decimal
        Caps a percentage discount. Ignored for fixed amounts.
        minOrderAmount
        Decimal
        Smallest order the coupon applies to, in the vendor's currency. Omit for no minimum.
        percentage
        Boolean!
        Required

        Whether discount is a percentage rather than a fixed amount.

        productIds
        [Int!]
        Required
        Restrict to specific products. All of the vendor's products when empty.
        times
        Int
        Total redemptions allowed across all customers.
        vendorLocationIds
        [Int!]
        Required
        Restrict to specific locations. Valid at all of the vendor's locations when omitted or empty.
    createWebhook
    Webhook!
    Required
    Register a new webhook endpoint for the authenticated business.
      input
      CreateWebhookInput!
      Required
      Endpoint URL and the events to subscribe to.
        events
        [WebhookEvent!]!
        Required
        Events to subscribe to. At least one.
        isActive
        Boolean
        Whether to start delivering immediately. Defaults to active.
        url
        String!
        Required
        HTTPS URL to deliver events to.
    deleteBot
    Boolean!
    Required

    Permanently delete a bot. Returns true on success.

      botId
      Int!
      Required
      Unique identifier of the bot to delete.
    deleteLocation
    Boolean!
    Required

    Delete a location. Returns true on success.

      locationId
      Int!
      Required
      Unique identifier of the location to delete.
    deleteVendorCoupon
    Boolean!
    Required
    Delete a coupon this vendor owns.
      couponId
      Int!
      Required
      Unique identifier of the coupon to delete.
    deleteWebhook
    Boolean!
    Required

    Permanently delete a webhook. Returns true on success.

      webhookId
      Int!
      Required
      Unique identifier of the webhook endpoint to delete.
    extendOrder
    ExtensionResult!
    Required
    Extend one of the vendor's rentals to a new end date.
      newEndDate
      NaiveDate!
      Required
      New end date for the rental (YYYY-MM-DD).
      rentalId
      Int!
      Required
      Rental to extend.
    processPickup
    RentalOrder!
    Required
    Record pickup of one of the vendor's rentals, with an optional condition report.
      conditionReport
      ConditionReport
      Condition of the item at pickup. Omit to skip the report.
        checklist
        [ChecklistItem!]
        Required
        Checklist items
        damages
        [DamageReport!]
        Required
        Specific damage descriptions
        notes
        String
        Notes about the condition
        overallRating
        Int!
        Required
        Overall condition rating (1-5)
        photos
        [String!]
        Required
        Photos documenting the condition
      rentalId
      Int!
      Required
      Rental being collected.
    processReturn
    ReturnResult!
    Required
    Record return of one of the vendor's rentals, with a condition report.
      conditionReport
      ConditionReport!
      Required
      Condition of the item at return.
        checklist
        [ChecklistItem!]
        Required
        Checklist items
        damages
        [DamageReport!]
        Required
        Specific damage descriptions
        notes
        String
        Notes about the condition
        overallRating
        Int!
        Required
        Overall condition rating (1-5)
        photos
        [String!]
        Required
        Photos documenting the condition
      rentalId
      Int!
      Required
      Rental being returned.
    regenerateBotSecret
    String!
    Required
    Regenerate a webhook bot's secret, invalidating the previous one. Returns the new secret so the caller can update their webhook handler.
      botId
      Int!
      Required
      Unique identifier of the bot to issue a new secret for.
    regenerateWebhookSecret
    String!
    Required
    Rotate a webhook's signing secret, returning the new secret. The new value is only surfaced here — it is stored hashed-in-place and cannot be retrieved again afterwards.
      webhookId
      Int!
      Required
      Webhook whose signing secret to replace.
    testBotWebhook
    BotWebhookTest!
    Required
    Queue a test webhook delivery for a webhook-type bot.
      botId
      Int!
      Required
      Bot whose webhook endpoint to test.
    updateBot
    Bot!
    Required
    Update an existing bot. Permissions, version and tags are not editable through the developer API.
      botId
      Int!
      Required
      Bot to update.
      input
      UpdateBotInput!
      Required
      Fields to change on the bot.
        avatarUrl
        String
        Replacement avatar image URL.
        category
        String
        Replacement directory category.
        configuration
        JSON
        Replacement JSON configuration. Replaces the stored blob outright.
        description
        String
        Replacement description. Up to 500 characters.
        displayName
        String
        Replacement display name. 2–100 characters.
        isPublic
        Boolean
        Whether the bot is listed in the public directory.
        webhookSecret
        String
        Rotated signing secret. 32–128 characters. Supplying it invalidates the previous secret immediately.
        webhookUrl
        String
        Replacement HTTPS delivery URL.
    updateLocation
    Location!
    Required
    Update an existing location.
      input
      UpdateLocationInput!
      Required
      Fields to change on the location.
        address
        String
        Replacement street address.
        city
        String
        Replacement city.
        country
        String
        Replacement country.
        deliveryAvailable
        Boolean
        Whether the branch delivers.
        deliveryRadius
        Float
        Replacement delivery radius in kilometres.
        email
        String
        Replacement contact email address.
        isActive
        Boolean
        Whether the branch is in service.
        latitude
        Float
        Replacement latitude in decimal degrees (WGS 84).
        longitude
        Float
        Replacement longitude in decimal degrees (WGS 84).
        name
        String
        Replacement branch name.
        phone
        String
        Replacement contact phone number.
        pickupAvailable
        Boolean
        Whether customers can collect from this branch.
        postalCode
        String
        Replacement postal or ZIP code.
        state
        String
        Replacement state, province or region.
      locationId
      Int!
      Required
      Location to update.
    updateVendorCoupon
    Coupon!
    Required
    Update a coupon this vendor owns.
      couponId
      Int!
      Required
      Coupon to update.
      input
      UpdateVendorCouponInput!
      Required
      Fields to change on the coupon.
        code
        String
        New code customers type at checkout. Omit to leave it unchanged.
        color
        String

        New hex colour for display (e.g. #FF5733). Omit to leave it unchanged.

        description
        String
        New terms or explanation. Omit to leave it unchanged.
        discount
        Decimal
        Never negative, for the same reason as on create: the order paths subtract it.
        expiresOn
        DateTime
        New expiry (UTC). Omit to leave it unchanged.
        forDelivery
        Boolean
        Whether the discount applies to the delivery fee. Omit to leave it unchanged.
        isActive
        Boolean
        Whether the coupon can still be redeemed. Omit to leave it unchanged.
        maxCouponAmount
        Decimal
        New cap on a percentage discount. Omit to leave it unchanged.
        minOrderAmount
        Decimal
        New order minimum, in the vendor's currency. Omit to leave it unchanged.
        percentage
        Boolean

        Whether discount is a percentage. Omit to leave it unchanged.

        productIds
        [Int!]
        Required
        Replaces the product restriction outright. An empty list clears it.
        times
        Int
        New total redemption limit. Omit to leave it unchanged.
        vendorLocationIds
        [Int!]
        Required

        Replaces the location restriction outright. Some(vec![]) clears it.

    updateWebhook
    Webhook!
    Required
    Modify an existing webhook's URL, events, or active status.
      input
      UpdateWebhookInput!
      Required
      Fields to change on the webhook.
        events
        [WebhookEvent!]
        Required
        Replacement subscription list. Replaces the existing set outright.
        isActive
        Boolean

        Whether the webhook delivers. Set false to pause without deleting.

        url
        String
        Replacement HTTPS delivery URL.
      webhookId
      Int!
      Required
      Webhook to update.
    upsertRentalSettings
    VendorRentalSettings!
    Required
    Create or update the vendor's rental settings.
      input
      UpdateVendorRentalSettingsInput!
      Required
      Rental settings to apply to the vendor.
        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