docs
Get startedTroubleshootingPaymentsWebhooksAgent paymentsSwop MCPOviIdentity (swop.id)SwivyRPC (preview)API reference

Products and orders

Read your catalogue and your sales from your own server.

Your products and orders live in Swop. With a key that has commerce.read you can pull both into your own systems.

Products

A product is anything you sell: a physical item, a digital download, a ticket. You create and edit products in the Swop app. Each one has an _id, which is what you send as productId when you create a checkout.

curl "https://apps.apiswop.co/api/v5/merchant/products?limit=20&page=1" \
  -H "Authorization: Bearer $SWOP_MERCHANT_KEY"

Products are paged by page and limit (default 50, up to 200). Add status=archived to list archived products instead of live ones. Full shape in the products reference.

Orders

An order is created automatically when a checkout is paid. GET /orders returns your sales only, newest first, without the buyer's identity: it's built for your dashboard and accounting, not your customer list.

curl "https://apps.apiswop.co/api/v5/merchant/orders?limit=25" \
  -H "Authorization: Bearer $SWOP_MERCHANT_KEY"

Orders use a cursor, not page numbers, because new orders arrive at the top. Pass the nextBefore value from one response as before in the next. When nextBefore is null, you've reached the end.

Where's the buyer's name and address?

GET /orders deliberately leaves out buyer identity. To ship, use the checkout.paid webhook, which carries the buyer's name, email, phone and shipping address for that order.

On this page