snapcasterAPI reference
Every operation, webhook and data type available in the Marketplace partner contract.
Authentication
marketplaceApiKey-http bearer. Send the seller's marketplace API key asAuthorization: Bearer mp_{sellerCode}_{hex}. Themp_{sellerCode}_prefix identifies the seller; the trailing hex is the secret. The seller generates the key and supplies it to your platform.
Store
Seller store status and vacation mode (GET/PATCH /me).
Listings
Create, update, export, and delete a seller's listings for either integration path.
Orders
Poll and fulfil orders for Path B (orders or both).
GET /orders- Poll ordersGET /orders/{orderId}- Get one orderPATCH /orders/{orderId}/fulfillment- Update fulfillmentPOST /orders/{orderId}/cancel- Cancel an orderPOST /orders/{orderId}/refunds- Create a refundGET /orders/{orderId}/cancellation-requests- List an order's cancellation requestsPOST /orders/{orderId}/cancellation-requests/{requestId}/decline- Decline a cancellation requestGET /orders/{orderId}/change-requests- List an order's change requestsPOST /orders/{orderId}/change-requests- File a fulfillment reportPOST /orders/{orderId}/change-requests/{requestId}/accept- Accept a change requestPOST /orders/{orderId}/change-requests/{requestId}/decline- Decline a change requestGET /orders/{orderId}/addition-requests- List an order's add-on requests (not yet available)POST /orders/{orderId}/addition-requests/{requestRef}/decline- Decline an add-on request (not yet available)GET /orders/{orderId}/addition-offers- List an order's add-on offers (not yet available)POST /orders/{orderId}/addition-offers- Send or replace an add-on offer (not yet available)POST /orders/{orderId}/addition-offers/{offerRef}/withdraw- Withdraw an add-on offer (not yet available)GET /orders/{orderId}/substitute-candidates- List substitutes for an order linePOST /orders/{orderId}/change-requests/{requestId}/withdraw- Withdraw a fulfillment reportPOST /orders/{orderId}/corrections- Correct the ship-to addressPOST /orders/{orderId}/address-verification/retry- Retry address verification
Webhooks
Signed outbound events Snapcaster delivers to a platform.
POST /webhooks/test- Send a test event to your webhook endpointorder.created- Order createdinventory.adjusted- Inventory adjustedorder.cancelled- Order cancelledorder.refunded- Order refundedorder.updated- Order updatedorder.cancellation_request.created- Cancellation request createdorder.cancellation_request.withdrawn- Cancellation request withdrawnorder.cancellation_request.resolved- Cancellation request resolvedorder.dispatch_overdue- Order dispatch overdueorder.change_request.created- Change request createdorder.change_request.resolved- Change request resolvedwebhook.test- Webhook testorder.addition_request.created- Add-on request created (not yet available)order.addition_request.resolved- Add-on request resolved (not yet available)order.addition_offer.updated- Add-on offer updated (not yet available)
Sandbox
Sandbox only: operations the sandbox API (https://api-sandbox.snapcaster.ca) serves to test an integration. The production API does not serve them.
POST /sandbox/test-purchases- Trigger a sandbox test purchaseGET /sandbox/test-purchases/{ref}- Read a sandbox test purchasePOST /sandbox/orders/{orderId}/cancellation-requests- Have the sandbox buyer ask to cancel an orderPOST /sandbox/orders/{orderId}/change-requests- Have the sandbox buyer ask for a changePOST /sandbox/orders/{orderId}/change-requests/{requestId}/answer- Have the sandbox buyer answer a fulfillment report
Browse (informational)
Public browse endpoints for product search, offers, and cart-line lookup. Use these to see how your listings appear to buyers. No authentication required.
Events by subscription
Snapcaster sends a platform only the events its subscription includes. See Choose your path.
| Event | What it reports | Path A | Path B | |
|---|---|---|---|---|
inventory | orders | both | ||
order.created | Order created | No | Yes | Yes |
inventory.adjusted | Inventory adjusted | Yes | No | Yes |
order.cancelled | Order cancelled | No | Yes | Yes |
order.refunded | Order refunded | No | Yes | Yes |
order.updated | Order updated | No | Yes | Yes |
order.cancellation_request.created | Cancellation request created | No | Yes | Yes |
order.cancellation_request.withdrawn | Cancellation request withdrawn | No | Yes | Yes |
order.cancellation_request.resolved | Cancellation request resolved | No | Yes | Yes |
order.dispatch_overdue | Order dispatch overdue | No | Yes | Yes |
order.change_request.created | Change request created | No | Yes | Yes |
order.change_request.resolved | Change request resolved | No | Yes | Yes |
webhook.test | Webhook test | Yes | Yes | Yes |
order.addition_request.created | Add-on request created (not yet available) | No | Yes | Yes |
order.addition_request.resolved | Add-on request resolved (not yet available) | No | Yes | Yes |
order.addition_offer.updated | Add-on offer updated (not yet available) | No | Yes | Yes |
Types
Every request body, response body and webhook payload is built from these named types. Each type page lists its fields and the operations and webhooks that use it.
ApiErrorBrowseFacetsBrowseFacetValueBrowseProductDetailBrowseProductDetailRunBrowseProductMetaBrowseProductOfferBrowseProductOffersResponseBrowseProductSummaryBrowseSearchResponseBrowseSellerFacetValueCancellationRequestCancellationRequestCreatedEventCancellationRequestEventDataCancellationRequestListResponseCancellationRequestResolvedDataCancellationRequestResolvedEventCancellationRequestResponseCancellationRequestWithdrawnEventChangeRequestChangeRequestCreatedEventChangeRequestEventDataChangeRequestLineChangeRequestListResponseChangeRequestResolvedDataChangeRequestResolvedEventChangeRequestResponseChangeRequestSubstituteChangeRequestSubstituteCandidateChangeRequestSubstituteCandidateListResponseCreateBuyerOrderChangeRequestBodyDeclineOrderAdditionRequestBodyDispatchOverdueEventDataEndOrderAdditionOfferBodyInventoryAdjustedDataInventoryAdjustedEventInventoryAdjustedLineLineLookupLineLineLookupResponseListingDisclosuresListingExportItemListingExportPageResponseListingFulfillmentObligationListingItemResultListingWriteResponseMarketplaceErrorOrderAdditionEligibilityOrderAdditionOfferEventDataOrderAdditionOfferLineOrderAdditionOfferMoneyOrderAdditionOfferSellerFeesOrderAdditionOfferShippingUpgradeOrderAdditionOfferUpdatedEventOrderAdditionPaymentOrderAdditionRequestOrderAdditionRequestCreatedEventOrderAdditionRequestEventDataOrderAdditionRequestLineOrderAdditionRequestListResponseOrderAdditionRequestResolvedEventOrderAdditionRequestResponseOrderAddressVerificationOrderCancelledDataOrderCancelledEventOrderCreatedDataOrderCreatedEventOrderDispatchOverdueEventOrderFulfillmentOrderPollPageResponseOrderRefundedDataOrderRefundedEventOrderResponseOrderShipToOrderUpdatedDataOrderUpdatedEventOrderWebhookCustomerOrderWebhookLineOrderWebhookShippingAddressPartnerOrderDataPoBoxDeliveryPurgeListingsResponseReviewScoreSandboxTestPurchaseSandboxTestPurchaseResponseSendOrderAdditionOfferBodyStoreOrderAdditionOfferStoreOrderAdditionOfferListResponseStoreOrderAdditionOfferResponseStoreShippingOptionStoreShippingOptionListResponseStoreShippingTypeStoreStatusStoreStatusResponseTerminationLineWebhookTestEventWebhookTestEventDataWebhookTestResponse