marketplace

PATCH `/v1/marketplace/listings/{listing_id}`

Edit a Zinn®, or publish it.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X PATCH https://api.zinndigital.com/v1/marketplace/listings/{listing_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

`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).

Parâmetros

Nome	Tipo	Obrigatório	O que é
`listing_id (path)`	`string`	Sim	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`inclusion_items`	`object[]`	Não	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`	Não	—
`summary`	`string`	Não	—
`slug`	`string`	Não	—
`field_values`	`object`	Não	Plain `{key: value}` — the envelope is added by the engine.
`publish`	`boolean`	Não	Validate against the stamped schema, require a package, recompute the price cache and go live — in one transaction.
`state`	`string<live, paused, archived>`	Não	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…

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Sim	—
`vendor_id`	`string`	Sim	—
`marketplace_id`	`string`	Sim	—
`marketplace_key`	`string`	Sim	—
`category_id`	`string`	Não	—
`listing_type_id`	`string`	Sim	—
`listing_type_key`	`string`	Sim	—
`schema_version`	`integer`	Sim	The version this listing's values were authored against. Stamped once, never moved — a later schema must not reinterpret an older listing.
`title`	`string`	Sim	—
`slug`	`string`	Sim	Permanent once live. It is the public URL.
`summary`	`string`	Sim	—
`field_values`	`object`	Sim	"`{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[]`	Não	Present on the detail read; the schema THIS listing is authored against.
`state`	`MarketplaceListingState`	Sim	⛔ `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`	Sim	—
`price_max_minor`	`integer`	Sim	—
`currency`	`string`	Sim	—
`published_at`	`string`	Não	—
`packages`	`MarketplacePackage[]`	Sim	—

Erros que este endpoint pode retornar

401 · 404 · 422

PATCH /v1/marketplace/listings/{listing_id}