Get started · 1 of 15
Start here
What your platform builds for Snapcaster, and the order to read these docs in.
Snapcaster handles buyer browse, checkout, payments, orders, and payouts. Your platform sends it each seller’s listings and on-hand quantity. After a sale, Snapcaster sends your platform either an order to fulfill or an inventory adjustment to apply, depending on your path.
Money amounts are integer cents in Canadian dollars, and skuId and productId are TCGplayer identifiers.
Start with the sandbox quickstart
Section titled “Start with the sandbox quickstart”Allow about ten minutes for the walkthrough, plus time for the sandbox’s payout process, which runs every five minutes.
For agents
Section titled “For agents”To give a coding agent these docs, point it at https://developers.snapcaster.ca/llms.txt, or at the .md copy of one page.
Every page has a Markdown copy at the same address, with .md in place of the trailing slash.
For example, the copy of /guide/golden-path/ is /guide/golden-path.md.
A copy has the page’s text, contract values and code samples, and its links point at other pages’ copies.
/llms.txt is the page index, and the footer of every page links to it.
It lists every guide page in reading order, the API reference index, the appendices and the changelog, and each entry gives the page’s description and the address of its copy.
From there, the API reference index lists every operation, webhook and type.
What comes next
Section titled “What comes next”The guide is one reading path, numbered in the sidebar in this order:
- Get started with the Sandbox quickstart, Choose your path, and Credentials and onboarding.
- Build the shared blocks in Sync a full catalog, Build a webhook receiver, and Webhook signing.
- Build Path A, inventory sync for
inventory, or Path B, order fulfillment forordersandboth. - Test and launch with the sandbox and Go live.
- Look up the terms every page uses in Core concepts, and how versions work in API versioning.
The API reference, Error codes, Rate limits, and Retries hold the details each page links to. The buyer-facing browse reference is informational and shows how your listings appear to buyers. Snapcaster implements those endpoints, not your platform.
Need help?
The email includes this page and selects sandbox as the environment. Update it if you need help with production.
Never include an API key or signing secret in the message.