Endpoints

The store data a seller integration can read and manage through the API.

API access (coming soon). The seller API is not available yet. The pages below are a preview. Contact support if you need early access.

The API is organised around the same things you manage in your dashboard. These are the resources most useful for a seller integration.

Available resources

ResourceWhat you can do
ProductsList your products, read their details, and create or update listings.
OrdersRead your sales with line items and totals, and look up an individual order.
CustomersRead your buyers and their order history.
Discounts & upsellsCreate and manage discount codes and upsell offers, within your plan limits.
Store & settingsRead your storefront profile and store settings.

Authentication

Every request needs your access token in the Authorization: Bearer <token> header. See the Overview for how tokens are issued and how responses are formatted.

Payment webhooks

Payments run through Stripe, and Roqstar listens for Stripe webhook events to keep your orders and payouts in sync. This happens automatically. It is not something you call yourself.