View Categories

Launching soon on the Shopify App StoreJoin the waitlist

GraphQL API reference: add-on apps

2 min read

Each add-on app has its own GraphQL reference page now. They all use the same address, keys and rules as Rentals & Bookings: see GraphQL API reference: Rentals & Bookings for how to send a request, and the API overview for keys, limits and errors.

Each app’s operations need that app. The operations of an app the store doesn’t have are refused before anything runs, with errors[].extensions.code: "app_not_installed" and data.app naming the app. Every operation needs a secret key; mutations need Allow changes (write). rentalApiCaller { installedApps } lists the apps your key can reach.

AppGraphQL referenceFor exampledata.app
E-Sign Contracts & WaiversGraphQL API reference: E-Sign Contracts & WaiversrentalContracts, verifyRentalContractcontracts
Refundable Security DepositsGraphQL API reference: Refundable Security DepositsrentalOrderDeposits, refundRentalDepositsdeposits
Custom Fields (Fields, Waiver & ID)GraphQL API reference: Custom FieldsrentalOrderFields, rentalFieldGroupsfields
SI Request a Quote, Hide PriceGraphQL API reference: Request a QuotesalesQuotes, createSalesQuotequotes
SI Subscriptions & MembershipsGraphQL API reference: Subscriptions & MembershipssubsSubscriptions, subsPauseSubscriptionsubscriptions
SI Delivery RoutingGraphQL API reference: Delivery RoutingroutesStops, routesDayPlanroutes
curl -s "https://YOUR-API-ADDRESS/graphql/2026-10" -H "Authorization: Bearer sirb_your_secret_key" -H "Content-Type: application/json" \
  -d '{"query": "{ salesQuotes(first: 5) { totalCount } }"}'
# 200, on a store without SI Request a Quote:
{"errors": [{"message": "This store does not have the SI Request a Quote, Hide Price app installed, so its operations are not available.",
             "locations": [{"line": 1, "column": 3}],
             "extensions": {"code": "app_not_installed", "http_status": 403, "data": {"app": "quotes"}}}]}

E-Sign Contracts & Waivers #

rentalContracts, rentalContract, rentalOrderContract, verifyRentalContract, resendRentalContract: GraphQL API reference: E-Sign Contracts & Waivers.

Security Deposits #

rentalOrderDeposits, refundRentalDeposits, setRentalDepositAutoRefund and the product deposit rules: GraphQL API reference: Refundable Security Deposits.

Custom Fields #

rentalOrderFields, rentalFieldGroups, rentalCustomerIdVerification, definition imports and exports, answers exports: GraphQL API reference: Custom Fields.

Quotes #

salesQuotes, salesQuote, createSalesQuote, updateSalesQuote, sendSalesQuote, convertSalesQuote and more: GraphQL API reference: Request a Quote.

Subscriptions & Memberships #

subsSubscriptions, subsPauseSubscription, subsMemberships, subsAdjustCredit, subsQueue, subsAnalytics and more: GraphQL API reference: Subscriptions & Memberships.

Delivery Routing #

routesStops, routesStopCreate, routesRoutes, routesDayPlan, routesSend, routesVehicles, routesWebhookSubscriptionCreate and more: GraphQL API reference: Delivery Routing.