Payments

Read your Shopify catalog

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.

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

Query parameters

afterstring

Response

Your products and variants.

Example response

{
  "products": {
    "nodes": [
      {
        "variants": {
          "nodes": [
            {
              "price": {
                "amount": "25.00",
                "currencyCode": "USD"
              },
              "eligibility": {
                "message": "This product category isn’t allowed on Comms."
              }
            }
          ]
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.