v41

latestOpenAPI 3.0.0UNLICENSEDraw.githubusercontent.com2026-07-0839165177.6 KB
Merchant Connectors

Create merchant connector installation link

Generate an installation link for a merchant connector (e.g. Shopify).

The returned URL begins the connector's OAuth handshake. Direct the merchant to it; once they authorize the Rye app, the connector redirects back to Rye to complete the install. The merchant is attributed to the calling developer and becomes available for checkout via this account.

get/api/v1/merchant-connectors/{connector}/installation-link

Path parameters

connector'shopify' required

A merchant connector is a Rye integration with a third-party merchant platform (e.g. Shopify) that lets developers onboard merchants to Rye. Today only Shopify is supported; this union expands as we add support for additional connectors (Woocommerce, BigCommerce, etc.).

The merchant connector to generate an installation link for

Query parameters

storeUrlstring required

Domain or URL of the merchant store to generate the installation link for

privateboolean

If true, the merchant onboarded via this link is exclusive to the calling developer

Response

OAuth authorization URL for the requested connector

urlstring required

URL to redirect the merchant to in order to install the Rye app on their merchant platform.

connector'shopify' required

The merchant connector this installation link was generated for.