APIリファレンス
marketplace
このエリアには 48 個のエンドポイントがあります。それぞれに、パラメータ、レスポンス、実行可能なリクエストを備えた専用のページがあります。
| メソッド | パス | 機能 | アクセス権限 |
|---|---|---|---|
| GET | /v1/marketplace/conversations | Every thread this org is in, on either side. | — |
| GET | /v1/marketplace/listing-types | The kinds of Zinn® this account may sell. | — |
| GET | /v1/marketplace/listing-types/{key}/schema | The public field schema for a kind of Zinn®. | — |
| GET | /v1/marketplace/listings | The Zinn®s this account sells. | — |
| POST | /v1/marketplace/listings | Start a Zinn®. | — |
| GET | /v1/marketplace/listings/{listing_id} | One of this account's Zinn®s, with the schema it is authored against. | — |
| PATCH | /v1/marketplace/listings/{listing_id} | Edit a Zinn®, or publish it. | — |
| GET | /v1/marketplace/listings/{listing_id}/enquiries | The pre-sales conversation about one listing. | — |
| POST | /v1/marketplace/listings/{listing_id}/enquiries | Ask a seller a question before buying. | — |
| GET | /v1/marketplace/listings/{listing_id}/images | A listing's images, and the limits an upload must satisfy. | — |
| POST | /v1/marketplace/listings/{listing_id}/images | Upload one image to a listing. | — |
| DELETE | /v1/marketplace/listings/{listing_id}/images/{image_id} | Remove an image, and its stored object. | — |
| PATCH | /v1/marketplace/listings/{listing_id}/images/{image_id} | Set the alt text, the gallery position, or make this the cover. | — |
| GET | /v1/marketplace/listings/{listing_id}/packages | What a buyer can actually buy on this Zinn®. | — |
| PUT | /v1/marketplace/listings/{listing_id}/packages | Replace the whole package list. | — |
| GET | /v1/marketplace/listings/{listing_id}/reveal | The identifying value behind the mask (authenticated). | — |
| GET | /v1/marketplace/orders/{sale_id} | The order workspace — one order, from your side of it. | — |
| POST | /v1/marketplace/orders/{sale_id}/handover/{item_id} | Tick one handover item — from your side of the order. | — |
| GET | /v1/marketplace/orders/{sale_id}/messages | The order chat. | — |
| POST | /v1/marketplace/orders/{sale_id}/messages | Send a message on an order. | — |
| POST | /v1/marketplace/orders/{sale_id}/messages/preview | Assess a draft before it is sent — the inline nudge. | — |
| POST | /v1/marketplace/orders/{sale_id}/requirements | The buyer's brief — and the thing that starts the delivery clock. | — |
| GET | /v1/marketplace/overview | The marketplace hub — every vertical, the latest Zinn®s, what recently sold. | — |
| GET | /v1/marketplace/purchases | Everything this org has bought on the marketplace. | — |
| GET | /v1/marketplace/purchases/{sale_id} | One purchase, as the buyer sees it. | — |
| POST | /v1/marketplace/purchases/{sale_id}/accept | Accept delivery — the act that releases the seller's money. | — |
| POST | /v1/marketplace/purchases/{sale_id}/revision | Send the delivery back, and say what is wrong. | — |
| GET | /v1/marketplace/vendor/ledger | What the seller is owed, and what is still being held. | — |
| GET | /v1/marketplace/vendor/payout-methods | Where this seller can be paid, and the rails they may choose. | — |
| POST | /v1/marketplace/vendor/payout-methods | Propose a destination to be paid at. | — |
| DELETE | /v1/marketplace/vendor/payout-methods/{method_id} | Stop using a destination. | — |
| POST | /v1/marketplace/vendor/payout-methods/{method_id} | Show that the destination belongs to you. | — |
| GET | /v1/marketplace/vendor/payout-readiness | Whether money may leave the platform to this seller, and why not. | — |
| GET | /v1/marketplace/vendor/payouts | What has been paid out, and what is being held. | — |
| GET | /v1/marketplace/vendor/profile | Whether this account sells on the marketplace, and where its file is. | — |
| POST | /v1/marketplace/vendor/profile | Become a Zinner®. | — |
| GET | /v1/marketplace/vendor/sales | Everything this org has sold on the marketplace. | — |
| POST | /v1/marketplace/vendor/sales/{sale_id}/deliver | Mark the work delivered — starts the buyer's acceptance window. | — |
| GET | /v1/marketplace/vendor/verification | The seller's identity file and what it still needs. | — |
| PUT | /v1/marketplace/vendor/verification | Open the identity file on a track, or edit it. | — |
| POST | /v1/marketplace/vendor/verification/documents | Reserve a document slot and get a short-lived upload URL. | — |
| GET | /v1/marketplace/vendor/verification/documents/{document_id}/url | A short-lived URL that downloads one identity document. | — |
| POST | /v1/marketplace/vendor/verification/subjects | Add a natural person to the identity file. | — |
| DELETE | /v1/marketplace/vendor/verification/subjects/{subject_id} | Remove a person from a file that is still editable. | — |
| POST | /v1/marketplace/vendor/verification/submit | Hand the identity file to review. | — |
| GET | /v1/marketplace/verticals | The marketplace verticals a buyer can browse. | — |
| GET | /v1/marketplace/{vertical}/search | Filter, sort and page one vertical's live Zinn®s. | — |
| GET | /v1/marketplace/{vertical}/{slug} | One live Zinn®, as anyone sees it. | — |