---
title: "Open Shopify to install Comms"
method: POST
path: "/payments/shopify/install"
tags: ["Payments"]
deprecated: true
---

# Open Shopify to install Comms

`POST /payments/shopify/install`

## Request

- Base URL: `https://osis.co/api/v1/comms`
- URL: `https://osis.co/api/v1/comms/payments/shopify/install`
- Auth: HTTP bearer

> **Deprecated.**

This retired typed-domain endpoint returns 409 shopify_owned_install_required with install_url https://apps.shopify.com/comms-by-osis for every workspace, including existing paid and operator-curated customers. Install or reopen Comms from Shopify, approve OAuth, then connect the verified store to a Comms workspace. Old consent links must also restart from Shopify. Existing connections, custom-app credentials, checkout functionality, and billing are unchanged. Requires an owner/admin or a comms_payments_manage key.

## Other responses

- `401`: API key is missing or wrong.
- `403`: payments_api_disabled: accept the merchant terms to turn on the Payments API. merchant_terms_update_required: accept the new terms version. payments_suspended: Comms suspended payments for your workspace. You also get 403 if your key is missing a scope, or with payment_admin_required.
- `409`: shopify_owned_install_required: install or reopen Comms from https://apps.shopify.com/comms-by-osis. All public-app installation must start in Shopify.
- `503`: shopify_app_not_configured: the Comms Shopify app isn't available yet.

---

[API](https://skmtc.dev/osis/apis/comms-api.md) · [All operations](https://skmtc.dev/osis/apis/comms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/osis/apis/comms-api/revisions/59a4c0ba8936?raw)