---
title: "Read your Shopify catalog"
method: GET
path: "/payments/shopify/catalog"
tags: ["Payments"]
---

# Read your Shopify catalog

`GET /payments/shopify/catalog`

## Request

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

Needs comms_read. Lists up to 20 published products per page, with up to 50 variants each, including prices, requiresShipping, and eligibility. Use after to get the next page of products. The Payments API is off until an owner or admin accepts the merchant terms. Until then, this returns 403 payments_api_disabled.

## Query parameters

- `after` string

## Response `200`

Your products and variants.

- ShopifyCatalog
  - `products` object, required
    - `pageInfo` object, required
      - `hasNextPage` boolean, required
      - `endCursor` string, nullable, required
    - `nodes` object[], required
      - `id` string, required
      - `title` string, required
      - `variants` object, required
        - `pageInfo` object, required
          - `hasNextPage` boolean, required
          - `endCursor` string, nullable, required
        - `nodes` object[], required
          - `id` string, required
          - `title` string, required
          - `availableForSale` boolean, required
          - `requiresShipping` boolean, required
          - `price` object, required
            - `amount` string, required
            - `currencyCode` string, required
          - `eligibility` VariantEligibility, required: Whether Comms will make a checkout for this variant.
            - `eligible` boolean, required
            - `reason` 'operator_blocked' | 'not_reviewed' | 'requires_shipping' | 'gift_card' | 'subscription_only' | 'unavailable' | 'prohibited_category': requires_shipping: the product doesn't ship. gift_card and subscription_only: not supported. unavailable: out of stock or not available to the Comms app in Shopify. prohibited_category: see category. operator_blocked: blocked by Comms review. not_reviewed: waiting for Comms review (workspaces set up before open signup only).
            - `category` 'alcohol' | 'tobacco' | 'cannabis' | 'weapons' | 'adult' | 'drugs' | 'gambling' | 'live_animals' | 'hazardous' | 'financial'
            - `message` string

## 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_not_connected: your store isn't connected yet. shopify_install_required: install the Comms app. shopify_reauthorization_required: connect your store again.

---

[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)