Public reference

Shop

Every endpoint in this group. Open one for its parameters and a worked example.

9 Endpoints

View as Markdown

Shop

9

POST /api/v1/admin/shop/batches/bulk-publish Publish / unpublish card series to the shop prm_shop_publish

Authentication: Staff token or session
Requires permission: prm_shop_publish Publish / unpublish card series to the shop
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/admin/shop/batches/{id}/publish Publish / unpublish card series to the shop prm_shop_publish

Authentication: Staff token or session
Requires permission: prm_shop_publish Publish / unpublish card series to the shop
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/admin/shop/batches/{id}/unpublish Publish / unpublish card series to the shop prm_shop_publish

Authentication: Staff token or session
Requires permission: prm_shop_publish Publish / unpublish card series to the shop
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/admin/shop/readiness View the Card Shop prm_shop_index

Authentication: Staff token or session
Requires permission: prm_shop_index View the Card Shop

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/admin/shop/sales

Authentication: Staff token or session
Requires any one of: prm_shop_sales prm_shop_sales_all

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/admin/shop/sales/{id}

Authentication: Staff token or session
Requires any one of: prm_shop_sales prm_shop_sales_all

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/admin/shop/sales/{id}/resend

Authentication: Staff token or session
Requires any one of: prm_shop_sales prm_shop_sales_all
Rate limit: pay_init

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/admin/shop/sales/{id}/reveal Reveal a shop buyer's name and phone prm_shop_buyer_contact

Authentication: Staff token or session
Requires permission: prm_shop_buyer_contact Reveal a shop buyer's name and phone
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/admin/shop/storefront View the Card Shop prm_shop_index

Authentication: Staff token or session
Requires permission: prm_shop_index View the Card Shop

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

Written to be read by machines too

The reference is public and needs no account, so a tool that has never seen X-Radius can reach a correct first call on its own.

/llms.txt: An index of every page, with one-line summaries.
/llms-full.txt: The whole reference as one Markdown file, with no navigation to crawl.
/openapi.json: OpenAPI 3.1, generated from the router that serves this instance.
/skill.md: A ready-made skill file for an assistant: authentication, the response envelope and the error codes in one page.
<page-url>.md: Append .md to any reference URL for the same page as Markdown.
Accept: text/markdown: Send this header on the ordinary URL and the answer comes back as Markdown instead.

Hand this to your assistant

Read https://x-radius.com/llms.txt, then fetch the endpoint you need as Markdown by appending .md to its URL.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us