Typed & documented
Build against an OpenAPI-described API with generated, typed SDKs.
All integrations
Developer
Connect REST API to vendor
OpenAPI spec auto-generated from code on every deploy. CI fails on drift. Full endpoint coverage for catalog, orders, customers, and payments.
What you get
Everything the REST API integration ships with
Built once, supported forever — no extra middleware to babysit.
Signed webhooks
React to events in real time, with retries and a dead-letter queue.
Scoped credentials
Issue per-integration keys with granular scopes you can revoke.
How the REST API integration works inside vendor
REST API is part of the Vendor developer platform — build custom workflows and integrations on a typed, documented foundation.
OpenAPI spec auto-generated from code on every deploy. CI fails on drift. Full endpoint coverage for catalog, orders, customers, and payments.
What gets synced
Available through REST API:
- Catalog, orders, and configuration resources.
- Typed request and response schemas.
- Signed webhook events.
- Scoped, revocable credentials.
Setup
Create a scoped API key in the admin.
Read the OpenAPI docs or install the SDK to get going.
Limits & considerations
Requests are rate-limited per plan.
Use scopes to grant each integration only what it needs.
Pairs well with
Stack the rest of your tools
Browse adjacent integrations your team will likely use alongside this one.
Developer
GraphQL Gateway
Optional GraphQL gateway over the same data model — preferred for storefront teams shipping highly stateful UIs.
Developer
Webhooks
Signed, outbox-backed event delivery with automatic retry, dead-letter inspection, and Slack/email alerts when delivery needs a human.
Developer
TypeScript SDK
Typed SDK auto-published from the OpenAPI spec on every push. Always in sync with the API, with full type safety for every endpoint.