marketplace
PATCH /v1/marketplace/listings/{listing_id}
Edit a Zinn®, or publish it.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PATCH https://api.zinndigital.com/v1/marketplace/listings/{listing_id} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
`publish: true` validates every value against the stamped schema version, requires at least one package, recomputes the price cache and takes the listing live — in one transaction, because a listing that went live with a stale price sorts wrongly on every storefront page and quotes a price nobody agreed to, and nothing raises. ⛔ A live Zinn®'s `slug` is permanent: it is the public URL, and changing it breaks every link to it and loses the ranking that link earned. ⛔ A `domain` value is stored in the reveal table, never in `field_values` — the storefront's read path cannot leak what it cannot see (docs/83 §3).
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
listing_id (path) | string | はい | — |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
inclusion_items | object[] | いいえ | The handover checklist a buyer confirms receipt of, for an asset-transfer listing (a website, a domain, a Shopify store). The seller composes it; the listing type's `handover_te… |
title | string | いいえ | — |
summary | string | いいえ | — |
slug | string | いいえ | — |
field_values | object | いいえ | Plain `{key: value}` — the envelope is added by the engine. |
publish | boolean | いいえ | Validate against the stamped schema, require a package, recompute the price cache and go live — in one transaction. |
state | string<live, paused, archived> | いいえ | Take a Zinn® off sale, put it back, or retire it. Applied AFTER any value edit in the same request, so the storefront projection is rebuilt once from the state the listing actua… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | string | はい | — |
vendor_id | string | はい | — |
marketplace_id | string | はい | — |
marketplace_key | string | はい | — |
category_id | string | いいえ | — |
listing_type_id | string | はい | — |
listing_type_key | string | はい | — |
schema_version | integer | はい | The version this listing's values were authored against. Stamped once, never moved — a later schema must not reinterpret an older listing. |
title | string | はい | — |
slug | string | はい | Permanent once live. It is the public URL. |
summary | string | はい | — |
field_values | object | はい | "`{key: {v, ver}}`" — uniform two keys, `ver: null` for a seller-declared value, so no consumer branches on key presence. ⛔ A `domain` value is NOT here — it is in the reveal ta… |
field_schema | MarketplaceFieldDefinition[] | いいえ | Present on the detail read; the schema THIS listing is authored against. |
state | MarketplaceListingState | はい | ⛔ `archived`, never deleted. A listing that sold has public URLs, backlinks and an order behind it, and a 404 costs rankings that do not come back. |
price_minor | integer | はい | — |
price_max_minor | integer | はい | — |
currency | string | はい | — |
published_at | string | いいえ | — |
packages | MarketplacePackage[] | はい | — |
このエンドポイントが返すエラー
401 · 404 · 422