List checkout profiles

GET/settings/checkout_profiles

Costs 1 rate-limit point · Rate limits

List the shop's checkout and accounts configurations (Shopify checkout profiles) and which one is published, as the order status page setup shows before the merchant adds Filemonk's block. Read-only: adding the block happens in Shopify's checkout editor, which an agent can't open.

Asks Shopify; large shops page slowly (Shopify throttles this list). 502 when Shopify did not answer.

Also searched astheme configurationscheckout profileswhich checkout is publishedorder status page setup

Returns

dataarray of objects
Show 3 child attributesHide child attributes
- idstring, nullable
  Example: gid://shopify/CheckoutProfile/1234567
- namestring, nullable
  Example: Default checkout
- publishedboolean, nullable
  Example: true
publishedstring, nullable
Example: Default checkout

Errors

401

Missing or invalid API key.

422

The request failed validation, or sent a key the action does not take (code: "unknown_parameters" with unknown and accepted). Nothing was saved.

429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time the window ends); a 429 adds Retry-After (seconds), retry_after, retryable: true and a next_step in the body. A 429 did nothing: wait retry_after seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with per_page over many single reads.

502

Shopify (or the email service) did not complete the request. Nothing was changed; try again shortly.

Every error has the same shape: see Errors.

GET/settings/checkout_profiles

curl "https://app.filemonk.io/api/v2/external/settings/checkout_profiles" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"

const res = await fetch("https://app.filemonk.io/api/v2/external/settings/checkout_profiles", {
  headers: {
    "X-Auth-Token": process.env.FILEMONK_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.filemonk.io/api/v2/external/settings/checkout_profiles",
    headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v2/external/settings/checkout_profiles")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "data": [
    {
      "id": "gid://shopify/CheckoutProfile/1234567",
      "name": "Default checkout",
      "published": true
    },
    {
      "id": "gid://shopify/CheckoutProfile/1234568",
      "name": "Holiday checkout",
      "published": false
    }
  ],
  "published": "Default checkout"
}

{
  "errors": [
    "Invalid API key"
  ]
}

{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}

{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}

{
  "errors": [
    "Shopify did not complete the request. Nothing was changed; try again shortly."
  ],
  "code": "shopify_error"
}