# Hypamoon Marketplaces API

**Canonical:** https://apis.io/apis/hypamoon-com/hypamoon-com-marketplaces-api/  
**Provider:** Hypamoon — https://apis.io/providers/hypamoon-com/  
**Base URL:** https://api.hypamoon.com/api/v1  
**Documentation:** https://hypamoon.com/docs/reference

Hypamoon Marketplaces API is one of 25 APIs that [Hypamoon](https://apis.io/providers/hypamoon-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Marketplace. The published artifact set on APIs.io includes an OpenAPI specification.

A marketplace in an app: sellers with their own products, one checkout over several sellers, commission for the holder, and payouts through the holder's own Stripe account. Rules per country decide who may sell what, where.

## Operations (32)

| Method | Path | Summary |
|---|---|---|
| GET | `/marketplaces/{id}` | Get the marketplace of an app |
| PUT | `/marketplaces/{id}` | Set up or change the marketplace |
| GET | `/marketplaces/{id}/rules` | The rules for a seller, a delivery and a category |
| GET | `/marketplaces/{id}/sellers` | List the sellers |
| POST | `/marketplaces/{id}/sellers` | Invite a seller |
| GET | `/marketplaces/{id}/sellers/{sellerId}` | Get one seller |
| PATCH | `/marketplaces/{id}/sellers/{sellerId}` | Activate, suspend or close a seller |
| POST | `/marketplaces/{id}/sellers/{sellerId}/suspend` | Suspend a seller |
| POST | `/marketplaces/{id}/sellers/{sellerId}/reinstate` | Lift a seller's suspension |
| PUT | `/marketplaces/{id}/sellers/{sellerId}/onboarding` | The seller's own details |
| PATCH | `/marketplaces/{id}/sellers/{sellerId}/credentials/{type}` | Approve or reject a credential |
| PUT | `/marketplaces/{id}/sellers/{sellerId}/tin` | The seller's tax number, above the reporting threshold |
| GET | `/marketplaces/{id}/sellers/{sellerId}/shipping` | A seller's shipping methods |
| PUT | `/marketplaces/{id}/sellers/{sellerId}/shipping` | Set a seller's shipping methods |
| POST | `/marketplaces/{id}/sellers/{sellerId}/payments` | A link to the verification by Stripe for a seller |
| GET | `/marketplaces/{id}/listings` | List the products of the sellers |
| POST | `/marketplaces/{id}/listings` | Add a product (seller) |
| GET | `/marketplaces/{id}/listings/{listingId}` | Get one product |
| PATCH | `/marketplaces/{id}/listings/{listingId}` | Change, approve or remove a product |
| GET | `/marketplaces/{id}/suborders` | List the sub-orders |
| GET | `/marketplaces/{id}/suborders/{suborderId}` | Get one sub-order |
| PATCH | `/marketplaces/{id}/suborders/{suborderId}` | Mark a sub-order shipped or delivered |
| POST | `/marketplaces/{id}/suborders/{suborderId}/refund` | Refund one sub-order |
| POST | `/marketplaces/{id}/suborders/{suborderId}/reverse` | Take a payout back after a dispute |
| GET | `/marketplaces/{id}/payments` | The connection with the holder's Stripe account |
| PUT | `/marketplaces/{id}/payments` | Connect the holder's Stripe account |
| DELETE | `/marketplaces/{id}/payments` | Disconnect the holder's Stripe account |
| POST | `/marketplaces/{id}/quote` | Quote a cart over several sellers |
| POST | `/marketplaces/{id}/checkout` | Start the checkout over several sellers |
| GET | `/marketplaces/{id}/orders/{orderId}` | Get an order with its sub-orders |
| GET | `/marketplaces/{id}/payouts` | Payouts per seller |
| GET | `/marketplaces/{id}/readiness` | Is the marketplace ready to go live? |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/hypamoon-com/openapi/hypamoon-com-marketplaces-api-openapi.yml

## Other Hypamoon APIs (12)

- [Hypamoon Agencies API](https://apis.io/apis/hypamoon-com/hypamoon-com-agencies-api/)
- [Hypamoon Agents API](https://apis.io/apis/hypamoon-com/hypamoon-com-agents-api/)
- [Hypamoon Apps API](https://apis.io/apis/hypamoon-com/hypamoon-com-apps-api/)
- [Hypamoon Assistant API](https://apis.io/apis/hypamoon-com/hypamoon-com-assistant-api/)
- [Hypamoon Billing API](https://apis.io/apis/hypamoon-com/hypamoon-com-billing-api/)
- [Hypamoon Call plans API](https://apis.io/apis/hypamoon-com/hypamoon-com-call-plans-api/)
- [Hypamoon Calls API](https://apis.io/apis/hypamoon-com/hypamoon-com-calls-api/)
- [Hypamoon Chat API](https://apis.io/apis/hypamoon-com/hypamoon-com-chat-api/)
- [Hypamoon Chat widget API](https://apis.io/apis/hypamoon-com/hypamoon-com-chat-widget-api/)
- [Hypamoon Containers API](https://apis.io/apis/hypamoon-com/hypamoon-com-containers-api/)
- [Hypamoon Data API](https://apis.io/apis/hypamoon-com/hypamoon-com-data-api/)
- [Hypamoon Domains API](https://apis.io/apis/hypamoon-com/hypamoon-com-domains-api/)

## Tags

Marketplace

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hypamoon-com/hypamoon-com-marketplaces-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hypamoon-com/.