API reference

Every operation and webhook available in the Marketplace partner contract.

Authentication

• marketplaceApiKey - http bearer. Seller-scoped Marketplace API key, presented as `Authorization: Bearer mp_{sellerCode}_{hex}`. The `mp_{sellerCode}_` prefix identifies the Seller; the trailing hex is the secret. Generated by the Seller and pasted into its Platform.

Store

Seller store status and vacation mode (`GET`/`PATCH /me`).

• GET /me - Get store status
• PATCH /me - Set vacation mode

Listings

Push, export, and delete a Seller’s listings: the inbound integration write path (both paths).

• GET /listings - Export listings
• POST /listings - Upsert listings
• DELETE /listings - Soft-delete listings
• POST /listings/purge - Purge all listings
• POST /listings/bulk - Bulk upsert/delete listings

Orders

Poll and fulfil orders: the Path B (`orders` / `both`) order lifecycle.

• GET /orders - Poll orders
• GET /orders/{orderId} - Get one order
• PATCH /orders/{orderId}/fulfillment - Update fulfillment
• POST /orders/{orderId}/cancel - Cancel an order
• POST /orders/{orderId}/refunds - Create a refund

Webhooks

Signed outbound events Snapcaster delivers to a Platform.

• order.created - Order created (Snapcaster → Platform)
• inventory.adjusted - Inventory adjusted (Snapcaster → Platform)
• order.cancelled - Order cancelled (Snapcaster → Platform)
• order.refunded - Order refunded (Snapcaster → Platform)

Browse (informational)

Public, unauthenticated buyer-facing Browse (Search, Product offers, and cart-line lookup). Informational for partners: how your listings appear to buyers.

• GET /search - Search products
• GET /products/{productId} - Get product offers
• POST /lines/lookup - Look up cart lines