ServiceMutation
Fields
acceptOrderOrder!RequiredorderIdInt!RequiredcancelBookingServiceBooking!RequiredbookingIdInt!RequiredcancelOrderOrder!RequiredorderIdInt!RequiredcreateBookingServiceBooking!RequiredinputCreateServiceBookingInput!RequiredhoursIntnotesStringpickupDateNaiveDatepickupTimeNaiveTimepriceDecimal!RequiredserviceIdStringuserIdStringcreateBotBot!RequiredinputCreateBotInput!RequiredavatarUrlStringbotTypeBotType!RequiredcategoryStringconfigurationJSONdescriptionStringdisplayNameString!RequiredisPublicBooleanusernameString!RequiredwebhookSecretStringwebhookUrlStringcreateLocationLocation!RequiredinputCreateLocationInput!RequiredaddressString!RequiredcityStringcountryStringdeliveryAvailableBooleandeliveryRadiusFloatemailStringisActiveBooleanlatitudeFloatlongitudeFloatnameString!RequiredphoneStringpickupAvailableBooleanpostalCodeStringstateStringcreateOfferingServiceOffering!RequiredinputCreateServiceOfferingInput!RequiredageRestrictedBooleandescriptionStringdiscountPriceDecimaldurationDuration!RequiredimageUrls[String!]!RequiredDefaults:isActiveBooleanlocationBooleannameString!RequiredpriceDecimal!RequiredcreateVendorCouponCoupon!RequiredinputCreateVendorCouponInput!RequiredcodeString!RequiredcolorString!RequireddescriptionStringdiscountDecimal!RequiredexpiresOnDateTimeforDeliveryBoolean!RequiredisActiveBoolean!RequiredmaxCouponAmountDecimalminOrderAmountDecimalpercentageBoolean!RequiredproductIds[Int!]RequiredtimesIntvendorLocationIds[Int!]RequiredcreateWebhookWebhook!RequiredinputCreateWebhookInput!Requiredevents[WebhookEvent!]!RequiredisActiveBooleanurlString!RequireddeleteBotBoolean!RequiredbotIdInt!RequireddeleteLocationBoolean!RequiredlocationIdInt!RequireddeleteOfferingBoolean!RequiredserviceIdInt!RequireddeleteVendorCouponBoolean!RequiredcouponIdInt!RequireddeleteWebhookBoolean!RequiredwebhookIdInt!RequiredmarkOrderPreparingOrder!RequiredorderIdInt!RequiredmarkOrderReadyOrder!RequiredorderIdInt!RequiredregenerateBotSecretString!RequiredbotIdInt!RequiredregenerateWebhookSecretString!RequiredwebhookIdInt!RequiredtestBotWebhookBotWebhookTest!RequiredbotIdInt!RequiredupdateBookingServiceBooking!RequiredbookingIdInt!RequiredinputUpdateServiceBookingInput!RequiredhoursIntnotesStringpaymentStatusPaymentStatuspickupDateNaiveDatepickupTimeNaiveTimepriceDecimalupdateBotBot!RequiredbotIdInt!RequiredinputUpdateBotInput!RequiredavatarUrlStringcategoryStringconfigurationJSONdescriptionStringdisplayNameStringisPublicBooleanwebhookSecretStringwebhookUrlStringupdateLocationLocation!RequiredinputUpdateLocationInput!RequiredaddressStringcityStringcountryStringdeliveryAvailableBooleandeliveryRadiusFloatemailStringisActiveBooleanlatitudeFloatlongitudeFloatnameStringphoneStringpickupAvailableBooleanpostalCodeStringstateStringlocationIdInt!RequiredupdateOfferingServiceOffering!RequiredinputUpdateServiceOfferingInput!RequiredageRestrictedBooleandescriptionStringdiscountPriceDecimaldurationDurationisActiveBooleanlocationBooleannameStringpriceDecimalserviceIdInt!RequiredupdateVendorCouponCoupon!RequiredcouponIdInt!RequiredinputUpdateVendorCouponInput!RequiredcodeStringcolorStringdescriptionStringdiscountDecimalexpiresOnDateTimeforDeliveryBooleanisActiveBooleanmaxCouponAmountDecimalminOrderAmountDecimalpercentageBooleanproductIds[Int!]RequiredtimesIntvendorLocationIds[Int!]RequiredupdateWebhookWebhook!RequiredinputUpdateWebhookInput!Requiredevents[WebhookEvent!]RequiredisActiveBooleanurlStringwebhookIdInt!Required
Accept a pending order.
Order to accept.
Cancel a service booking the vendor owns.
Booking to cancel.
Cancel a pending or accepted order.
Order to cancel.
Create a service booking for the authenticated vendor.
Details of the booking to create.
How many hours to book. Omit for a service that is not sold by time.
Anything the provider should know. Optional.
Date of the appointment (YYYY-MM-DD). Omit to leave it unscheduled.
Time of the appointment (HH:MM:SS). Omit to leave it unscheduled.
Agreed price for the booking. Must not be negative.
The service to book. Required.
The customer the booking is for. 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.
Details of the bot to create.
URL of the bot's avatar image.
Which runtime surface the bot plugs into.
Directory category the bot is filed under.
Free-form JSON configuration passed through to the bot runtime.
What the bot does, shown in the directory. Up to 500 characters.
Human-readable name shown in chat and the directory. 2–100 characters.
Whether to list the bot in the public directory. Defaults to false.
Handle the bot is mentioned by, without the leading @. 3–50 characters, alphanumeric and underscores only, and unique platform-wide.
Shared secret the delivery signature is computed with. 32–128
characters. Store it — it is never returned again.
HTTPS URL to deliver the bot's events to. Without one it receives nothing.
Create a new location for the authenticated vendor.
Details of the location to create.
Street address of the branch.
City the branch is in.
Country the branch is in.
Whether the branch delivers. Defaults to true.
How far the branch delivers, in kilometres. Omit for unlimited.
Contact email address for the branch.
Whether the branch is in service. Defaults to true.
Latitude in decimal degrees (WGS 84).
Longitude in decimal degrees (WGS 84).
Branch name, e.g. Downtown store.
Contact phone number for the branch.
Whether customers can collect from this branch. Defaults to true.
Postal or ZIP code.
State, province or region the branch is in.
Create a service offering. Currency is taken from the vendor.
Details of the service to create.
Whether buyers must pass an age check. Defaults to false.
Long-form description of what the service covers.
Sale price in major units. Defaults to 0, meaning no discount.
Period the price is quoted against.
Publicly reachable image URLs. At least one is required — a service with
no image renders as a blank tile everywhere it is listed. Defaulted at
the schema level so the omission is rejected by the service with an
actionable message rather than by GraphQL validation.
Whether the service is bookable. Defaults to true.
Whether the service is performed at the customer's location rather than the vendor's. Defaults to false.
Customer-facing service name.
List price in major units of the vendor's currency, per duration.
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.
Details of the coupon to create.
Code customers type at checkout. Must be unique across the platform.
Hex colour for UI display (e.g. "#FF5733").
Terms or explanation shown with the coupon. Optional.
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.
When the coupon stops working (UTC). Omit for a coupon that never expires.
Whether the discount applies to the delivery fee.
Whether the coupon can be redeemed straight away.
Caps a percentage discount. Ignored for fixed amounts.
Smallest order the coupon applies to, in the vendor's currency. Omit for no minimum.
Whether discount is a percentage rather than a fixed amount.
Restrict to specific products. All of the vendor's products when empty.
Total redemptions allowed across all customers.
Restrict to specific locations. Valid at all of the vendor's locations
when omitted or empty.
Register a new webhook endpoint for the authenticated business.
Endpoint URL and the events to subscribe to.
Events to subscribe to. At least one.
Whether to start delivering immediately. Defaults to active.
HTTPS URL to deliver events to.
Permanently delete a bot. Returns true on success.
Unique identifier of the bot to delete.
Delete a location. Returns true on success.
Unique identifier of the location to delete.
Delete a service offering. Returns true on success.
Unique identifier of the service offering to delete.
Delete a coupon this vendor owns.
Unique identifier of the coupon to delete.
Permanently delete a webhook. Returns true on success.
Unique identifier of the webhook endpoint to delete.
Mark an accepted order as preparing.
Order now being prepared.
Mark a preparing order as ready.
Order now ready for collection.
Regenerate a webhook bot's secret, invalidating the previous one.
Returns the new secret so the caller can update their webhook handler.
Unique identifier of the bot to issue a new secret for.
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.
Webhook whose signing secret to replace.
Queue a test webhook delivery for a webhook-type bot.
Bot whose webhook endpoint to test.
Update a service booking the vendor owns.
Booking to update.
Fields to change on the booking.
New length of the booking, in hours.
Replaces the notes left with the booking.
New payment state for the booking.
New date for the appointment (YYYY-MM-DD).
New time for the appointment (HH:MM:SS).
New price for the booking.
Update an existing bot. Permissions, version and tags are not editable
through the developer API.
Bot to update.
Fields to change on the bot.
Replacement avatar image URL.
Replacement directory category.
Replacement JSON configuration. Replaces the stored blob outright.
Replacement description. Up to 500 characters.
Replacement display name. 2–100 characters.
Whether the bot is listed in the public directory.
Rotated signing secret. 32–128 characters. Supplying it invalidates the
previous secret immediately.
Replacement HTTPS delivery URL.
Update an existing location.
Fields to change on the location.
Replacement street address.
Replacement city.
Replacement country.
Whether the branch delivers.
Replacement delivery radius in kilometres.
Replacement contact email address.
Whether the branch is in service.
Replacement latitude in decimal degrees (WGS 84).
Replacement longitude in decimal degrees (WGS 84).
Replacement branch name.
Replacement contact phone number.
Whether customers can collect from this branch.
Replacement postal or ZIP code.
Replacement state, province or region.
Location to update.
Update a service offering.
Fields to change on the service.
Whether buyers must pass an age check.
Replacement description.
Replacement sale price in major units. 0 clears the discount.
Replacement billing period for the price.
Whether the service is bookable.
Whether the service is performed at the customer's location.
Replacement service name.
Replacement list price in major units of the service's currency.
Service to update.
Update a coupon this vendor owns.
Coupon to update.
Fields to change on the coupon.
New code customers type at checkout. Omit to leave it unchanged.
New hex colour for display (e.g. #FF5733). Omit to leave it unchanged.
New terms or explanation. Omit to leave it unchanged.
Never negative, for the same reason as on create: the order paths
subtract it.
New expiry (UTC). Omit to leave it unchanged.
Whether the discount applies to the delivery fee. Omit to leave it unchanged.
Whether the coupon can still be redeemed. Omit to leave it unchanged.
New cap on a percentage discount. Omit to leave it unchanged.
New order minimum, in the vendor's currency. Omit to leave it unchanged.
Whether discount is a percentage. Omit to leave it unchanged.
Replaces the product restriction outright. An empty list clears it.
New total redemption limit. Omit to leave it unchanged.
Replaces the location restriction outright. Some(vec![]) clears it.
Modify an existing webhook's URL, events, or active status.
Fields to change on the webhook.
Replacement subscription list. Replaces the existing set outright.
Whether the webhook delivers. Set false to pause without deleting.
Replacement HTTPS delivery URL.
Webhook to update.
Built with