Skip to content

Listing manifest

The manifest is a JSON object with camelCase members and enum values written as their names. It is stored and shown as you wrote it, after it passes the same validator CIQRA’s own listings pass.

Member Type Rule
key string 2 to 40 characters: lower-case letters, digits and -, starting with a letter. Not reserved.
version string major.minor.patch, for example 1.0.0.
name string 1 to 60 characters, no leading or trailing space. A proper noun, not translated.
kind Vendor A partner submits a third-party app.
category enum One of the market categories (for example Content, MarketingEmail, Shipping).
markets array At least one of Global, TR, US, EU, UK. No duplicates, and Global stands alone.
commerceOnly boolean True when the app only makes sense on a Commerce store.
availability Live Submit what can be installed.
scopes array At least one published scope, each enforced by a route.
settings array At most 30 fields: { "key": "accountId", "kind": "Identifier" }. Kinds: Url, Identifier, FieldName, Secret, TextList, Map, Toggle. A Secret is write-only.
webhookTopics array resource.event topics your app subscribes to.
pricing object { "model": "Free" } or { "model": "VendorBilled" }. No amount, no currency.
locales array The admin languages your copy exists in. en and tr are mandatory.
processing object Where the app processes data (below). Mandatory.
searchTerms array At most 12 lower-case words of at most 40 characters.

connectPath, integrationSlug and shelfKey must be absent.

"processing": {
"personalData": true,
"counterparty": "Acme Cloud Ltd",
"counterpartyCountries": ["IE"],
"kvkk": "StandardContract"
}
  • personalData says whether shopper or customer personal data reaches you or a sub-processor.
  • When it does, counterparty names who, and counterpartyCountries lists the countries (ISO 3166-1 alpha-2).
  • kvkk is the KVKK article 9 basis for Turkish personal data that leaves Türkiye: NotApplicable, AdequacyDecision, StandardContract, BindingCorporateRules, OccasionalException, or Undetermined (accepted with a warning, reported to you).

A manifest is at most 64 KiB. A member the platform does not define is refused, and so is a missing required one.