Skills
Skill 41 of 67
Wix target adapter with verified write primitives, shared execution runtimes, and contract tests.
57 minutes · 12,630 words · 36 sections
Install
npx skills add wix/skills --skill rp-target-wixnpx skills add wix/skills/plugin marketplace add wix/skillsThe first command installs just this skill, by the name in its SKILL.md; the second installs the whole repository.
Wix target adapter. Owns the Wix-side write surface and shared execution runtime that every migration shares —
verified once here so the platform-agnostic stages and per-project codegen never
re-derive (and re-break) it. This is the symmetric counterpart to rp-source-wordpress:
that adapter owns reading a source platform; this one owns writing to Wix.
lib/stores-inventory.js exports inventoryForVariant, resolveInventoryLocation, and
reconcileInventory(wix, rows, {expectedCount, gaps, locationId?}). Rows carry resolved
productId, variantId, and inventory: {inStock:boolean} OR {quantity:integer}.
expectedCount must equal rows plus named source gaps. Bulk writes follow complete location-
scoped reads; existing items reconcile or update by revision, then values and availability
are read back. Failure remains partial and the next invocation re-reads before writing.
The existing single-create inventory helpers remain available for narrow probes; imports
use the bulk reconciliation path. trackQuantity is derived and must never be sent.
Read domains/stores/entities/inventory-item.json and the setup inventory-probe contract.
Not a stage in the flow — a reference + shared library consulted by:
rp-import-codegen vendors lib/wix-writers.js into the project (like the
wp-http transport) plus the shared write/setup runtime modules, and generates thin
project-specific write specs/transforms that call these primitives/runtime APIs.
Codegen does not re-emit Wix API plumbing.rp-setup-discovery / rp-execute-setup consult the “Verified endpoints” and
“Provisioning” notes for app-install / Wix-Data / collection mechanics.Because the Wix surface is identical across source platforms, adding a new source
(rp-source-shopify, …) requires no change here.
app-page-routing-capabilities.json is the per-family gate for
lib/app-page-routing.js and scripts/internal-link-audit.js route. The shared
lib/url-mapper-transport.js builds writer-side create/update/read requests over an
injected authenticated sender and requires destination inspection. Only the Stores
product URL Mapper payload currently has a recorded request and saved-state read-back
shape. Its writer-side pattern may be configured after Stores installation and before
frontend creation, but it is not evidence that the frontend serves that route. The
generated transport supplies the migration credential and writer-side read/write methods;
the public reader’s empty mapping is not a valid read-back. Use the recorded request
and read-back fixture in app-page-routing-capabilities.json.
Every other discovered app family remains unverified until its exact key, page
identifier, variables, supported method, request and read-back fixture are committed to
the capability file and tested. Portfolio and Builder Blog remain unverified. Never infer
one family’s adapter from another or use full-site registration. A missing or conflicting
route produces a local route result and an Import Operator item; it does not become a
served route through the URL ledger.
This adapter owns the shared Wix layer written once for all migrations.
It should own:
state/crosswalk/crosswalk.ndjson authority, append-only
attempt journal, optional CMS mirror seed/upload adapters)state/url-preservation/ base paths, ledger, planned
redirects, and unresolved route rows) and the SEO Redirects writer
(lib/seo-redirects.js: Bulk Create only, declared APP/WIX_USER identity with Manage SEO Settings, no forceReplace,
durable write intents and List Redirects reconciliation; user-token API create/read-back
verified, frontend serving and full live acceptance still unverified)lib/ndjson.js): streaming read/write, batching by count and by
cost, cursoring, and append-only producers. Migration data files are record streams, so the
scan/batch/cursor primitives live here once instead of being re-derived by codegen.Per-migration code generation should own only:
WriteSpec.dependencyRefs from each in-scope entity’s
domain-knowledge dependsOn field, not re-derived per projectcreateWixClient accepts only object-identity capabilities issued by the shared runtime.
An unprivileged client admits registered read builders only; a raw request is not a
trusted read. Import clients require a bound task plus the gate’s current per-batch
readinessGrant and sourceStableKey on every write, including auxiliary writes and
dry-run captures. Every import write must retain the closed writer builder’s object identity and sealed method, URL, body and headers. A raw, copied or modified request is refused even with a valid grant; use the shared marked builders and grant wrappers. Use writers.bindRecordClient(taskClient, { readinessGrant, sourceStableKey }) for library composites, or writers.withReadinessGrant(request, { readinessGrant, sourceStableKey }) for individual builders; these preserve trusted builder marks. Before standard product inventory reconciliation, read the current product through that record client and call registerImportInventoryScope(recordClient, canonicalProduct, targetProduct). It requires a same-record successful product write or current site-bound crosswalk, correlates variants by choices, and binds stock to that record, product, variants and read location/item revisions. Standard reviewed quantity/location behavior remains available; quick Shopify retains its separate boolean/default-location scope. A serialized/copied capability, caller phase or stale/foreign-site grant
is refused before transport. Setup and quick mode use their own bounded issuers, never an
import bypass. Disposable probes require the explicit ownership confirmation and are
restricted to the shipped verification callers.
Use lib/dependency-readiness.js for producer binding, task evaluation and record-level
reference resolution. Its closed states distinguish complete, empty, partial, setup-passed,
approved/unapproved exclusion and unknown evidence. Setup remains task-complete. The
diagnostic projection is not an input. Keep latest journal outcomes, site-bound pass
evidence and existing contact/product verification as the authority; task ordering alone
cannot grant write permission.
Quick mode loads only its shipped adapter contract and keeps declared dependencies in contract order. Shopify product capability additionally admits exactly product tags and bounded inventory work for products created/read through that same client. Inventory still correlates real product, variant, item and location evidence, preserves partial stock outcomes, and never receives a raw-transport or probe exception.
lib/wix-writers.js exposes pure request builders (build*Request) + executors. Shapes
marked VERIFIED were validated by a real call against a live site, not just read from
docs. Shapes marked UNVERIFIED are docs-schema/MCP-derived bootstrap primitives that
must be surfaced in execution plans until a live contract call promotes them. It also
exports sendDirectRest for dev-probe capabilities only: its requests carry no request
mark, so an import, setup or quick client refuses them as writes. A native entity this
adapter has no reviewed writer for is written by guarded raw requests
(sendGuardedRawRequest, below), never by sendDirectRest.
This resource should also expose shared execution-runtime modules above those primitives, so generated migrations use one common path for retries, throttling, checkpointing, reporting, and audit logging.
Read/return contract for query* executors. Every query* executor
(queryStoresProducts, queryStoresCategories, queryContacts, queryCoupons,
queryOrders) unwraps the response to the entity array and returns one page, discarding
pagingMetadata. Two failure modes follow, both of which have shipped:
.products / .categories off it a second time
gives undefined → []. A dedupe index or existing-entity safety net then comes back
empty without erroring, which is indistinguishable from a fresh site — so the import
duplicates what is already there, and a setup verification reports 0 categories on a site
with 25.queryAll* primitive where one exists — queryAllStoresCategories,
queryAllStoresProducts, queryAllDataItems — otherwise send
wix.send(build<X>Request(body)) and read pagingMetadata.cursors.next off the raw
response.Every sweep used for dedupe must throw on a partial result rather than return it. “Empty net” and “empty store” look identical to the caller, and the caller assumes the second.
Target entity suitability lives in domains/, not in a large prose table in this skill.
Use the deterministic reader as the normal access path:
node scripts/domain-knowledge.js list-domains
node scripts/domain-knowledge.js list-entities --domain stores
node scripts/domain-knowledge.js read-entity --ref stores/product
node scripts/domain-knowledge.js resolve-source --source-system woocommerce --source-entity product
node scripts/domain-knowledge.js resolve-source --route /wc/v3/products
node scripts/domain-knowledge.js list-flagged --flag IMPORT_UNRELIABLE
node scripts/domain-knowledge.js summarize-entities --refs stores/product,ecom/orderdomains/index.json is generated from domain/entity files and checked in. After editing
domain knowledge, run:
node scripts/domain-knowledge-validate.js --write-indexAuthoring or editing any entity file also requires the dependency check, both
directions: (1) what does this entity need to already exist and be crosswalked — record it in
dependsOn: string[] (a domain/entity ref array; empty is a real, reviewed answer, not the same
as the field being absent); (2) does this entity change what an already-written entity’s
dependsOn should say (e.g. authoring gift-cards/gift-card should have prompted revisiting
ecom/order.json — it hadn’t, until it was caught by hand). domain-knowledge-validate.js
checks dependsOn refs resolve and the whole graph stays acyclic whenever the field is present, but
it is not yet required on every entity — node scripts/domain-knowledge-validate.js --list-missing-deps prints the live backlog of entities that have never had it authored at all;
that command is the source of truth, not a hand-maintained list.
domains/SERVICE-PLUGINS.md covers the escalation ladder for a source capability with no native
Wix primitive: native primitive first, always, then a Wix service plugin (Wix calls an
endpoint we host and we answer per request), and only then a recorded gap. It carries the cost list,
a worked example — bounded quantity discount bands, implemented live 2026-08-31 — and a catalog of
all 25 service plugins with per-plugin migration relevance. Read it before writing “Wix cannot
express this” into a gap report.
Operation contracts. operationContracts.<operation> records, per reviewed
write operation, what each dependsOn ref means for that operation: conditional,
guardedPaths (payload paths that would carry a reference needing a separate producer; a
{ path, equals } guard matches one value, such as the Gift Cards catalog appId),
creatingPaths plus withinWrite { completion, outcome, identityOutput, verification } when
the write itself creates or resolves the dependency, inapplicable { reason } when the
entity-level edge does not apply to that operation, secondaryOutputs (identities the write
returns that another dependent may use after read-back), childOutputs (many child identities
the write creates, each keyed by its own source key and proven by the parent’s verified write
receipt: a product’s variants; the child entity file names its parent in childOf), auxiliaryOperations, and
recovery.reconciliationKeys for identity recovery after an uncertain write. evidence is
prose and excluded from the operationContractDigest that mapping proofs bind; every other
field is semantic, so changing it invalidates those proofs. Add an entry only from verified
API evidence; a missing entry or empty guardedPaths means “unknown” and keeps the separate
producer requirement. setupProducible: true marks an entity setup may produce when no import
task writes it; when an import task writes it, the import owns it and no setup step may claim it.
The flag must match setup: an entity a named setup executor writes (SETUP_EXECUTOR_ENTITY_REFS
in lib/setup-verification.js) carries it, and a flagged entity has that executor or a build*
writer in WRITE_BUILDERS_BY_ENTITY.
The selected targets’ support rules and reliability flags bind reconciliation freshness.
Member create helpers/builders are aliases of createMember.
writerId values in entity files must match exported functions from lib/wix-writers.js;
use null for setup/manual work or native entities with no writer yet. An entity with a
builder in WRITE_BUILDERS_BY_ENTITY names it as writerId (for example stores/product-tag
uses buildCreateStoresProductTagRequest). A native entity with writerId: null and no such
builder is written by guarded raw requests; its write operation is sendGuardedRawRequest. A task’s write operation on a native or native-plus-cms entity must be a writer for that
entity (its writerId, an operation contract name, alias or auxiliary operation, or a function
listed for it in WRITE_BUILDERS_BY_ENTITY or WRITE_HELPERS_BY_ENTITY, such as ensureCoupon
and bulkCreateCoupons), or the raw path when it has none; another entity’s writer does
not count, and an entity with a reviewed writer cannot use the raw path
(scripts/import-contract-verify.js refuses either with MISSING_WRITER). A writer listed in
the entity’s own alternateWrites counts only when it is exported, importSafe: true and
verification: verified-live, and the entity is not import-unsafe; otherwise the gate names
the reason and the default writer
(MISSING_WRITER:<task>:<ref>:alternate-unverified:use bulkUpsertContacts). List every new
marked builder there; the contract test re-derives the map from the markRequest calls.
A reviewed
wrapper that writes only through its entity’s writer or builders goes in WRITE_HELPERS_BY_ENTITY.
Entity files may also expose fieldContracts[] for verified nested write paths. These
are machine-readable contracts for codegen and dry-run validators, not replacements for
the human notes below. For Stores products, domains/stores/entities/product.json
records the verified Catalog V3 create contract for product.subscriptionDetails,
including required nested paths, allowed recurrence values, read-back behavior, and the
live-validated subscriptions[].description <= 60 constraint. Generated transforms
should consume that metadata through the vendored wix-writers.js exports instead of
copying limits into project-local code.
Live verification helpers must not edit domains/ directly. When a probe changes a
target write assumption, emit a proposal artifact and let the orchestrator promote it
deliberately:
node skills/wix-replatform/resources/rp-target-wix/scripts/verify-stores.js stores subscription-create \
--artifact migrations/<project>/setup/stores-subscription-verification.json \
--proposal-artifact migrations/<project>/setup/contract-ledger-proposal.jsonUse lib/contract-ledger.js to validate the handoff: a passed verification without a
proposal is incomplete, and a proposal that is neither promoted into fieldContracts[]
nor explicitly deferred is stale product knowledge. Codegen should consume
fieldContracts[] through scripts/domain-knowledge.js summarize-entities, which
includes promoted contracts.
When a canonical product contains both shortDescription and description,
lib/wix-build.js writes one Stores plainDescription: short body, <hr />, then long
body. HTML-empty bodies and normalized, case-insensitive lorem ipsum… filler are
treated as empty independently, so a real companion body remains. The horizontal-rule
serialization is unverified in a live Wix storefront: canary it and capture a Hebrew/RTL
screenshot before any bulk import or remediation backfill.
| Capability | Endpoint | Notes / traps |
|---|---|---|
| HTML → rich content | POST /ricos/v1/ricos-document/convert/to-ricos | VERIFIED. options.plugins enum is UPPERCASE — the docs example shows lowercase and 400s. |
| Import media from URL | POST /site-media/v1/files/import | VERIFIED. Async: response is PENDING; poll GET /site-media/v1/files/{id} for READY before referencing. |
| Blog category | POST /blog/v3/categories | VERIFIED. body { category: { label, slug, description } }. |
| Blog tag | POST /blog/v3/tags | VERIFIED. Body is top-level { label, language } — NOT { tag: { label, slug } }; slug is derived. |
| Blog post | POST /blog/v3/draft-posts → …/{id}/publish | VERIFIED. memberId required (3rd-party). VERIFIED (2026-08-02): the site owner’s auto-created user-member satisfies it — it was already present on our API-provisioned test site with zero Members-area interaction (single-site observation), so attribute-to-owner needs no member provisioning. Resolve it via listMembers + loginEmail match — never derive it from the account/user GUID (the observed id equality is a single observation, undocumented). Also VERIFIED (2026-08-02): author is re-assignable after publish — PATCH /blog/v3/draft-posts/{id} { draftPost: { memberId } } then republish updates the published post’s author (post id == draft id; republish fires non-suppressed events — do author-upgrade passes inside the notification-mute window). Visible custom cover media requires both heroImage.id and media: { displayed:true, custom:true, wixMedia:{ image:{ id }}}. heroImage.id alone leaves the cover hidden. |
| Blog posts (bulk) | POST /blog/v3/bulk/draft-posts/create | UNVERIFIED bootstrap (public docs + wix/skills wix-manage recipe, 2026-07-21). Max 20 posts/call; bulkCreateDraftPosts chunks larger inputs. Prefer over per-post creates for N ≥ 2 (single create runs ~25–30s/call per the recipe). Publish is still per-post — a bulk publish flag is unverified. Surface in the execution plan until the live contract call promotes it. |
| CMS item | POST /wix-data/v2/items | VERIFIED. { dataCollectionId, dataItem: { data } }. Requires Wix Data enabled (else WDE0110). |
| Members | GET/POST /members/v1/members | VERIFIED. dedup by loginEmail (gated PII; use a fallback member when absent). VERIFIED (2026-08-02, single-site observation): the target-site member list can already contain auto-created user-members for the owner/contributing Wix users (status: APPROVED; resolve by loginEmail, never by deriving from the account GUID — the observed id equality is undocumented) — never dedupe or count these against source-site members; DELETE /members/v1/members/{id} works for cleaning up importer-created members. Throughput: no bulk create; documented ≥1s spacing (10k ≈ 3h serial floor — plan + resume via crosswalk). Create sends no email and does not fire the signup automations trigger (source-confirmed) — silent by default. Activation policy (decided 2026-08-03): passwords are never imported, and passwordless members complete the standard forgot-password flow (confirmed). Delivery = post-import label-wave automation: owner creates one dashboard automation (trigger label added, e.g. migrated-2026 → owner-branded email: “Log in → Forgot password”); importer applies the label per contact with assignContactLabels (crm/contact-label), paced for rate control and re-targeting; enable only after the import window. Never mass-send send-set-password-email (3h single-use link), and never fetch/store per-member reset links — they are credential-equivalent secrets and the no-link flow needs none. |
| Stores product (BULK — the scale path) | POST /stores/v3/bulk/products-with-inventory/create | UNVERIFIED bootstrap. Use this, not per-product creates, for any catalog above a handful — 1000 products is 11 calls instead of 1000. Creates up to 100 products with inline options, inline brand/ribbon/infoSections, all variants AND per-variant inventory items in one request. Five caps apply simultaneously and exceeding ANY ONE rejects the whole request: products ≤100, variantsInfo.variants ≤1000 total, options ≤100 total, modifiers ≤100 total, infoSections ≤100 total. With 2 options per product the options cap binds at 50 products, not 100 — so batch with lib/ndjson.js → readBatchesByLimits using the exported BULK_PRODUCT_LIMITS + storesProductBulkCost, never on record count alone. TRAP: bulk is NOT atomic — a 200 can carry per-item failures in results[].itemMetadata.success; never infer success from the HTTP status. TRAP: correlate results by itemMetadata.originalIndex, not response position. TRAP: bulkActionMetadata.undetailedFailures counts failures whose detail the server dropped; ignoring it silently loses records. returnEntity:false (default) still returns itemMetadata.id, which is all a crosswalk needs — pass true only for a contract probe that must inspect the created entity. bulkCreateStoresProductsWithInventory handles normalization, correlation and the unaccounted-item check, returning { results, succeeded, failed, undetailedFailures, unaccounted }. Normalization is purely local — HTML descriptions travel as plainDescription for Wix to convert server-side — so a batch is one HTTP call. It used to convert one description per product first, which made a 100-product batch 101 calls and reliably tripped the Ricos endpoint’s 403 throttle. |
| Stores product | POST /stores/v3/products, POST /stores/v3/products/query, PATCH /stores/v3/products/{id}, GET /stores/v3/products/{id}, GET /stores/v3/products/slug/{slug} | VERIFIED (2026-07-05; media patch verified live). buildCreateStoresProductRequest runs normalizeStoresProductV3, which bakes in the create traps: PHYSICAL requires physicalProperties:{}; simple/V1-ish top-level price, sku, and physical properties are moved into a single V3 variant; option/variant choice names clamped to 50 (identical truncation both places); variant optionChoiceNames.renderType defaulted to TEXT_CHOICES; compareAtPrice dropped unless strictly > actualPrice; variant price must be a money object ({ actualPrice: { amount: "14.95" } }) — a bare string/number 400s “Expected an object” (verified 2026-07-19), so the normalizer coerces scalar prices. Read-back (verified 2026-10-21): variant choices sent as optionChoiceNames read back as optionChoiceIds, resolved to names through the product’s options[]; the empty product-level physicalProperties reads back with a derived shippingWeightRange. Both verifiers (lib/write-verification.js, lib/read-back-comparison.js) compare through that view; variant weights are still compared exactly. Descriptions: a string description is HTML and is moved to plainDescription by normalizeStoresProductV3; Wix converts that to rich content server-side, so the product path never calls the Ricos endpoint (description proper is a Ricos document object — HTML there is a type error). TRAP: plainDescription is silently ignored when description is also set — a 200 with an empty description — so the normalizer throws when both are present. TRAP: hard cap of 16,000 characters (the old Ricos path chunked at 28k and merged, so it was effectively unbounded); over-long bodies throw rather than truncate, and need an info section or an explicit mapping-gaps.json entry. For product media, prefer media.itemsInfo.items[] with external url values when the source URLs are publicly reachable: the Stores product API ingests them in the background, avoiding the slower, heavily-throttled Media Manager pre-import path. Use pre-imported Wix media ids only when the target flow requires them. Upsert lookups: getStoresProduct(wix, id) and getStoresProductBySlug(wix, slug) return the product or throw 404 — callers should catch and treat as null for “not found”. Catalog sweeps: queryStoresProducts returns one page unwrapped to the array with the cursor discarded, so a crosswalk-recovery or name-match safety net must use queryAllStoresProducts(wix), which follows the cursor and throws rather than returning a partial index. Slugs: sanitizing is owned by lib/wix-build.js (toWixSlug, applied automatically via the coerce: 'slug' rule on product.slug), not by this module and deliberately not by normalizeStoresProductV3 — the writer passes the caller’s slug through unchanged so URL preservation can record the original next to the derived plannedTargetSlug. It matters because Wix rejects anything outside [a-z0-9-] and slug validation precedes application, so one bad slug (Shopify mints ph-5_5 from a “pH 5.5” title) 400s the entire bulk batch rather than just that product. General patch: patchStoresProduct(wix, { productId, revision, ...fields }) applies normalizeStoresProductV3, so a string description moves to plainDescription here too; revision from the existing product is required. UNVERIFIED for get-by-id, get-by-slug, and general-field patch (endpoint VERIFIED; arbitrary-field patching and slug lookup not yet live-tested). Variable products / variant matrices: Wix Stores V3 requires server-assigned optionChoiceId GUIDs before a variant matrix can be built — those IDs do not exist until after the initial createStoresProduct call returns. A single-pass import therefore cannot create a full variant matrix in one call. The two-pass approach: (1) create the product with options declared (but no variants), (2) create each option choice via POST /stores/v3/products/{id}/options/{optionId}/choices to obtain server-assigned choice IDs, (3) create variants via POST /stores/v3/products/{id}/variants. When the two-pass flow is out of scope (e.g. public-data single-pass run), import as a single-variant product at the base price, record the fidelity loss in mapping-gaps.json, surface it in the execution-plan report, and ensure the generated product detail page renders productOptions when non-empty so the storefront is ready once options are added. |
| Stores category | POST /categories/v1/categories, POST /categories/v1/categories/query | VERIFIED (2026-07-05) for create. Body { category, treeReference } — treeReference is top-level (sibling of category, {appNamespace:"@wix/stores"}); nesting it 400s “treeReference must not be empty”. Empty optional strings such as description: "" are omitted. Query: same top-level treeReference trap applies. queryStoresCategories(wix) returns one page (100 max) unwrapped to the array — it does not return all categories, and the unwrap discards the cursor so it cannot be paged. Any dedupe/upsert index must use queryAllStoresCategories(wix), which follows pagingMetadata.cursors.next and throws rather than returning a partial index. A site with more than 100 categories reads back only 100 through the single-page call, which would duplicate the missing ones. UNVERIFIED for query (not yet live-tested). |
| Events category | POST /events/v1/categories, POST /events/v1/categories/query | VERIFIED (2026-10-27). createEventCategory sends { category: { name, states:["MANUAL"] } }. TRAP: names are not unique (a second create with the same name succeeds). TRAP: Query returns zero rows unless paging is sent, and ignores name/states filters — findEventCategoriesByName lists all with paging and matches in code. |
| Events event | POST /events/v3/events, GET /events/v3/events/{id}, POST /events/v1/bulk/categories/events | VERIFIED (2026-10-27). createEvent({ event, draft }) — draft is required and comes from the source status; past dates are accepted. TRAP: event.categories is silently dropped on create — assign with assignEventToCategories({ eventId, categoryIds }) (one event, all its categories; the client checks both ids against the record’s grant). TRAP: Query Events never returns drafts — a draft whose create response was lost is held, not resent; published events are adopted by adoptPublishedEvent (title + start date, then read by id: that read lets the record assign the adopted event its categories). initialType (RSVP/TICKETING) is immutable. |
| Events ticket definition | POST /events/v3/ticket-definitions | VERIFIED (2026-10-27). createTicketDefinition — TICKETING events only; name 1–30 chars; free = NO_FEE with price 0; a paid ticket’s feeType comes from the source or the mapping review, never a default. Past events accepted. Use only this alias path, never the canonical host as well. |
| Events RSVP | POST /events/v2/rsvps, POST /events/v2/rsvps/query | VERIFIED (2026-10-27). createRsvp always sets rsvp.disableNotifications:true and defaults options.ignoreResponseStatus + ignoreLimits (a past event needs ignoreResponseStatus). Published RSVP events only (draft → 400 EVENT_NOT_FOUND). TRAP: with the overrides a repeated email creates a second RSVP — dedupe by email per event, and before resending after a lost response use findRsvpsByEmail (email is not filterable). Each RSVP creates or matches a CRM contact. |
| Wix Forms form | POST /form-schema-service/v4/forms, POST /form-schema-service/v4/forms/query | VERIFIED (2026-10-26). createForm({ form, sourceFieldTargets }) — namespace wix.form_app.form; every field needs identifier, a lowercase GUID id and a layout slot (checked before send). It appends a hidden “Original submission date” field (target original_submission_date) because Wix ignores an entry’s createdDate. TRAP: a colliding name is renamed — record result.name. A lost create is adopted only by the hidden field id, never by name (the site’s “Contact” form is the merchant’s). TRAP: Create Form adds an ACTIVE owner-email automation for the form; see the next row. Repair: updateFormSchema({ formId, form, sourceFieldTargets, sourceFormId }) (PATCH /form-schema-service/v4/forms/{id}, full schema at the current revision, VERIFIED 2026-10-31) updates a form this import created (it must carry the hidden field id) whose live formFields lack a planned input target; unchanged when nothing is missing (no write; ownership is not checked), failed with reason: 'form-not-created-by-import' when a form that needs repair lacks the hidden field id (never written). A repair result never lowers an already-imported crosswalk row. |
| Wix Forms entries | POST /forms/v4/submissions, GET /forms/v4/submissions/{id}, spam reports …/form-spam-submission-reports/namespace/query; Automations V2 query/get/PATCH /automations-service/v2/automations/{id}; Get / partial Update Form (spamFilterProtectionLevel) | VERIFIED (2026-10-26). Use importFormEntries per form: it pauses the form’s wix_form_app-form_submitted automations and lowers its spam filter to NONE (best-effort, one attempt each; ledger execution/forms/automation-pause.json), sends every entry, then reads them back 4 at a time (sendFormSubmission / verifyFormSubmission; seen:true, original date in the hidden field, polled to CONFIRMED; in-spam/deleted recorded, never re-sent; a create whose reply was lost is read back once with findFormSubmission over …/form-submission-service/v4/submissions/namespace/query, unverified live), and restores both, also on a throw; with no entries left, pass wix to restore an earlier run’s changes. TRAP: mute does not stop the owner email — only the pause does. TRAP: updating the preinstalled automation returns a new id; the ledger keeps it. Never call Report Not Spam (it runs the automations). |
| Wix Tag (global) | POST /tags/v1/tags | UNVERIFIED bootstrap. Body { tag: { name, fqdn } }. FQDN for Stores V3 products: "wix.stores.catalog.v3.product". Max 100 tags per FQDN. Create tags before products; crosswalk tag IDs into product tags.publicTags.tagIds[] at create time. Tags are a native Wix entity — do not route product tags to CMS. |
| Stores inventory | POST /stores/v3/inventory-items, POST /stores/v3/bulk/inventory-items/create, POST /stores/v3/bulk/inventory-items/update | VERIFIED LIVE for single create, bulk create/update, Inventory and default-location Catalog read-back. Imports use reconcileInventory with the full expected variant count; persist its report and complete the inventory checkpoint only when status:complete and complete:true. No-data remains distinct. buildCreateInventoryItemRequest requires exactly one explicit inStock boolean or quantity integer; omitting both now throws instead of sending an unspecified stock policy. trackQuantity is validated for compatibility but omitted from requests because it is read-only. |
| Stores category membership | POST /categories/v1/bulk/categories/add-item | VERIFIED (2026-07-05). { item:{ catalogItemId, appId }, categoryIds[], treeReference }; appId = Wix Stores 215238eb-…, catalogItemId = Wix product id. bulkAddItemToCategories(wix, payload) takes exactly one { productId, categoryIds } object — never extra positional arguments (a generated call site once passed three, silently dropping the third and sending undefined for both fields on every call; see lib/stores-category-attach.js). Do not call it inline and trust the resolved promise: use reconcileCategoryAttachment(wix, rows, opts), which calls it with the correct shape, never swallows a write error, and reads every product back (DIRECT_CATEGORIES_INFO) before marking a row attached — an ADD is confirmed by “every expected id present”, never exact set equality. |
| Contacts | POST /contacts/v5/contacts, POST /contacts/v5/bulk/contacts/upsert, POST /contacts/v5/contacts/query, GET /contacts/v5/contacts/{id}, PATCH /contacts/v5/contacts/{id} | GA (docs verified 2026-08-04 — was Developer Preview when selected on 2026-07-26). Do not fall back to V4 unless a migration explicitly chooses a legacy compatibility path. The GA contact shape is FLAT — no info wrapper, no emails.items/phones.items list wrappers: one main email/phone (contact matching + subscription status live on these) plus additionalEmails/additionalPhones arrays; addresses[] keeps postal fields nested under address; company is { name, jobTitle }. Create and update both take { contact, allowDuplicates }; update requires the current revision and has no fieldMask. Phone tags: OTHER/MAIN/HOME/MOBILE/WORK/FAX (no UNTAGGED). buildCreateContactRequest/buildUpdateContactRequest accept the flat GA contact (legacy info payloads convert strictly — non-mechanical keys like extendedFields/labelKeys throw). Live create/query/update verification is still pending a token with Contacts permissions (2026-07-26 probe got 403) — keep V5 writers surfaced as UNVERIFIED in execution reports until a live contract test promotes them. Custom fields (GA): the V5 contact carries extendedFields.namespaces.<ns>; per the V5 contact-object docs, definitions go through the Data Extension Schema API with FQDN wix.contacts.*.contact (user-defined values under _user_fields). The V4 Contacts Extended Fields API (POST /contacts/v4/extended-fields, values under info.extendedFields) pairs with the V4 surface only — do not mix. CAVEAT: the Data Extension Schema intro’s supported-objects table does not list contacts yet (docs inconsistency at GA cutover); verify the DES path live during setup before relying on it. Labels: a V4 label is the V5 private tag (label.tagId goes in tags.privateTags.tagIds[], verified live 2026-10-27). Write definitions with findOrCreateContactLabel (Contact labels row) and put them on contacts with assignContactLabels (Labels on a contact row); never send tags in the contact upsert, whose default OVERWRITE replaces a matched contact’s tags. |
| Coupons | POST /stores/v2/coupons, POST /stores/v2/coupons/query, DELETE /stores/v2/coupons/{id} | createCoupon VERIFIED LIVE (stores/coupon entity, multi-thousand import). Contract: use ensureCoupon({ specification }) — Query Coupons by exact specification.code (paced, retried; the write is not readable immediately), zero matches creates, one reconciles, more is ambiguous and creates nothing. The specification comes from rp-source-wordpress/lib/coupon-discovery.js mapCouponToWix; never hand-roll it (epoch-ms times, explicit appliesToSubscriptions, exhausted codes active: false). Redeemability is REFUSED unless it was decided: ensureCoupon, bulkCreateCoupons and normalizeCouponSpecification all throw before any network call unless the specification carries a boolean active and either a positive-integer usageLimit or the directive usageUnlimited: true (stripped before the body is built; usageLimit: 0 is rejected by the target, so unlimited has no sentinel number). Both fields are optional on the API and each omission resolves the expensive way – absent active reads as ON, and the target’s own usage count starts at zero. CREATE paths only: updateCouponFields must keep carrying only the fields being changed. Scope is enforced by the writer, so a hand-rolled specification now fails locally instead of on the store: normalizeCouponSpecification derives scope.namespace from scope.group.name (product/collection -> stores, form -> forms; never a flat constant) and REFUSES an unenumerated group name, a nameless group, a group with no entityId, or a namespace/group pair that is not one of the five accepted pairs – naming the field, the value and the accepted values. A refusal throws; it never drops the scope, because a dropped scope is a storewide coupon. bulkCreateCoupons sets refused specifications aside BEFORE it sends, reports each one coupon-scope-shape-invalid keyed by code, and writes the rest in one call. A scoped coupon should carry scopeTarget: {visible} – the caller’s verdict on the restricted product or collection: {visible: false} is refused unsent as coupon-scope-target-hidden (never widened to storewide, never parked with active: false), and an omitted scopeTarget writes but marks the result coupon-scope-target-visibility-unchecked. |
| Members | POST /members/v1/members, POST /members/v1/members/query, GET /members/v1/members/{id}, POST /contacts/v5/contacts/query | Create VERIFIED LIVE. Contract: ensureMember({ loginEmail, contact, knownMemberId }) (customer-member.js builds contact from a source customer — buildMemberContact, phone via normalizePhoneE164, never sent un-converted: Create Member 400s on anything not already E.164). Reconciles by a crosswalk row read back and verified (member-crosswalk-row-stale if not), else Query Members by loginEmail (one match reconciles, more is ambiguous); before every create that carries a phone, Contacts V5 is queried by that phone and it is DROPPED (member-phone-collision-dropped) on a match — Create Member reuses an existing contact with a matching phone even from a DELETED member, and two different customers would otherwise merge into one Wix identity. Persist loginEmail on the crosswalk row (lib/member-crosswalk.js) or resolveOrderBuyer cannot link anything. Create Member ≥1s apart (documented floor). |
| Pricing plans | POST /pricing-plans/v3/plans, POST /pricing-plans/v3/plans/query, POST /pricing-plans/v2/plans/{id}/archive | Create VERIFIED LIVE 2026-08-16 (pricing-plans/plan entity). Contract: ensurePlanDefinition({ plan, idempotencyKey, knownPlanId }) — the reconciliation IDENTITY is the client-minted pricingVariants[].id (offer-derived, preserved by Wix), never the name (names are cut to 50 chars and collide). A knownPlanId is read back (GET /pricing-plans/v3/plans/{id}) and adopted only if it exists, is not archived and carries our variant id, else plan-crosswalk-row-stale; then Query Plans by name, filtered to plans carrying our variant id (one reconciles, more is ambiguous, a merchant’s same-named plan is ignored); then Create Plan ≥1s apart with idempotencyKey in the BODY beside plan (a header is ignored). An adopted plan that is ours but no longer inert is reported (plan-reconciled-not-inert), not archived. The body comes from lib/pricing-plan-definition.js buildPlanDefinition and is REFUSED unless visibility: PRIVATE and buyable: false; the CREATED plan is checked too and archived at once if it came back purchasable (plan-failed, cause created-plan-not-inert, `archived: true |
| Pricing plan orders | POST /pricing-plans/v2/checkout/orders/offline, POST /pricing-plans/v2/orders/{id}/pause, GET /pricing-plans/v2/orders, GET /pricing-plans/v2/orders/{id} | Create VERIFIED LIVE 2026-08-16 (pricing-plans/plan-order entity). Contract: ensurePlanOrder({ planId, memberId, startDate, paid, paused, knownOrderId }) — one source contract, at most one order: orders cannot be deleted. startDate (the source start date) is required and is the match key: a knownOrderId is read back and adopted only if it is this member’s order for this plan, then List Orders (buyerIds + planIds) matched on startDate (one adopts, more is plan-order-reconciliation-ambiguous; a canceled/ended match is plan-order-existing-not-live, never re-created), then create (a 429 waits and tries once more). The body is only planId, memberId, paid, startDate — never couponCode or submissionId. Status is read-only: past/present start → ACTIVE, future → PENDING; paused: true creates ACTIVE then pauses (a PENDING order cannot be paused: plan-order-pause-failed). Canceled/expired source contracts are never written here (CMS history + cutover item). An unreadable reply or 5xx on create lists once and adopts a match, else plan-order-unknown-outcome — never resend. Read-back re-reads until lastPaymentStatus leaves UNPAID (it settles after the create returns). Any returned orderId goes to the crosswalk whatever the outcome. Outcomes are PLAN_ORDER_OUTCOME in lib/plan-order-outcome-registry.js; the importer records each with recordPlanOrderOutcome and the completion report turns them into cutover items. The pause is admitted by the import client only for an order this record already saw with its granted plan and member. |
| eCom order | POST /ecom/v1/orders/import (historical orders), POST /ecom/v1/orders/query | VERIFIED LIVE (2026-08-12; re-verified 2026-08-16 with applied discounts, line-item description lines and merchant notes). Import Order is the only import-safe path — see ecom/order.json. Caller-supplied id VERIFIED LIVE 2026-09-05: a never-seen GUID is accepted and kept; a re-send with an existing id silently REPLACES the whole body (attached payments and extendedFields survive); a non-GUID is a 400. lib/order-history.js derives the id from the source — do not pick one, and never re-send an existing order. POST /ecom/v1/orders (createOrder) remains BLOCKED for migration: it decrements inventory, emails the buyer and auto-creates contacts. TRAP: order.number must be numeric — a prefixed source number fails the whole call with a bare 400 {"message":"Not a numeric value"} and no field path. |
| Site notifications mute | POST /notification-preferences/v1/site-mute/mute, POST /notification-preferences/v1/site-mute/unmute, GET /notification-preferences/v1/site-mute | VERIFIED (2026-08-04, full cycle live on a test target: mute → state read → idempotent re-mute → unmute → state restored, all 200). Mutes all notifications of the site in context — all recipients, all channels; sendability denied regardless of recipient-level preferences. All three calls return { siteMuteState: { muted, reason?, mutedBy: { wixUserId } } }; executors unwrap to siteMuteState. Mute body { reason?: string } (≤500, clamped by the builder) — always pass a project-identifying reason (RePlatform migration — <project>) so the mute is auditable. TRAP: re-mute overwrites reason (last caller wins) — the import preflight’s idempotent re-call must pass the same reason as setup. AUTH TRAP: user tokens only — the CLI-minted OauthNG site token (WIX_AUTH_TOKEN from config/wix.env) works; an account API key gets a uniform empty-body 403 on all three endpoints. Hard invariant: when mute is in effect (always for WIX_SITE_STRATEGY=new; explicit opt-in for existing sites), a failed mute halts the run before any import write — no degraded mode. unmuteSiteNotifications is never called by the flow itself — explicit owner request only; after an on-request unmute, confirm muted: false via getSiteMuteState. |
| eCom order merchant notes | POST /ecom/v1/orders/{orderId}/activities/add | VERIFIED LIVE 2026-08-16 (ecom/order-merchant-note). addOrderMerchantNotes(wix, { orderId, messages }) / buildAddOrderMerchantNotesRequest: one order per call, 1-300 MERCHANT_COMMENT messages, each 1-5000 chars (the builder throws; truncating or splitting is a mapping decision recorded in the ledger). orderId is sent in the body as well as the path so the readiness grant checks it against the record’s granted ecom/order target (dependencyReferenceFields, per-record edge). Returns activityIds. Wix stamps createdDate and authorEmail (the token holder) at call time; carry the source author/date in the message. Not idempotent: after an unknown outcome read the order back and match MERCHANT_COMMENT text before resending. |
| Item SEO tags (Blog posts) | POST /promote/seo/v1/bulk/item-seo-tags/set + GET /promote/seo/v1/item-seo-tags/BLOG_POST/{id} | VERIFIED LIVE 2026-10-27 on an editor site. setItemSeoTags(wix, { itemType: 'BLOG_POST', entries: [{ itemId, tags?, focusKeywords? }] }, { readinessGrant, sourceStableKeys }) / buildBulkSetItemSeoTagsRequest. BLOG_POST only (STORES_PRODUCT stays on product.seoData). Other item types use guarded raw requests through PATCH /promote/seo/v1/item-seo-tags/{itemType}/{itemId}; the raw guard refuses BLOG_POST and STORES_PRODUCT and any request whose item type it cannot read (preferredWrite.writerScope). itemId is the Wix post id (per-record blog/post edge, checked per entry). Reads each item, merges (writes replace in full), strips robots and canonical into exclusions, sends chunks of 20, reads back: only verified (every written tag resolves TAG_SOURCE_ITEM) is landed; unverified-after-success, failed, failed-whole-call and not-landed are retried. A robots or canonical the item already has is sent back unchanged. |
| SEO patterns | GET/POST/PATCH /promote/seo/v1/seo-patterns/{pageType}, GET .../{pageType}/variables | VERIFIED LIVE 2026-10-27. ensureSeoPattern(wix, { pageType, tags }): read, check {{variables}} (invalid-variable writes nothing), merge over the site’s own pattern or the Wix default, create or set (a 409/404 re-reads once, never flips verb blindly), read back. A site-owned pattern is overwritten for the identities the source brings and returned as previousSitePattern; defaultPattern is always returned. Robots is never written; PAGE_TYPE_NOT_ON_SITE → setup-missing-app. No WIX_DATA_PAGE_ITEM. |
| Site SEO tags | GET/PATCH /promote/seo/v1/site-seo-tags | VERIFIED LIVE 2026-10-27. setSiteSeoTags(wix, { tags, shareImage? }): one verification tag per provider, then the source share image in its own PATCH. shareImage is { mediaId, sourceUrl } with mediaId resolved per record through the gate (shareImage.mediaId); the og:image URL is the granted media file’s own URL (read by id), and the client refuses any other og:image. An image that did not land resolves to nothing (dependencyFailureActions: omit), so the tags are still written; it, a not-ready file or a missing read-back returns shareImage.outcome: not-written with a cause, exclusion site-og-image-not-written and operator action site-share-image-not-written. An og:image tag in tags is never sent. The site’s own og:image is kept unless the source image replaces it. Robots is never written (site-noindex-refused); a robots tag the site already has is sent back verbatim, because omitting it from the full-replacement PATCH would make the site indexable. Every call returns the operator action site-indexing-launch-decision. All three SEO surfaces need a site with an editor (HtmlWeb) instance: on a Create Project site with no template they fail with HTML 400/500/428 or Missing HtmlWeb instance (seo pitfall needs-an-html-web-site). |
| Stores brand | POST /stores/v3/brands, POST /stores/v3/brands/query | VERIFIED LIVE 2026-10-27 (stores/brand). createStoresBrand(wix, { brand: { name } }): one brand per call; the name is unique, so a 409 reuses the one brand with that exact name (outcome: 'reused'). Name only; other brand data goes to the CMS fallback. |
| Stores customization | POST /stores/v3/customizations, POST /stores/v3/customizations/query | VERIFIED LIVE 2026-10-27 (stores/product-customization). createStoresCustomization(wix, { customization }): standalone field names (freeTextInput, customizationRenderType; the product-side names are refused). Unique by name + type + render type; a 409 reuses the match only when its settings or choices are the same, otherwise CUSTOMIZATION_NAME_CONFLICT (name same-named groups apart). Attach to products by id from the product writer, restating the settings. |
| Stores promotion | POST /stores/v3/promotions, GET /stores/v3/promotions/{id} | VERIFIED LIVE 2026-10-27 (stores/promotion). A category-page banner, never a discount. createStoresPromotion(wix, { promotion: { name, enabled, categories }, imageUrl }) imports the image, waits for READY, creates with media.id and reads the image back. Outcomes created, reused (a create whose reply was lost, found once in the same call; or, on a re-run of such a record with { readBackFirst: true }, a promotion with every non-media field sent the same, found before any image import or create — a first attempt never looks, since two source banners may share a name), image-failed (nothing created), image-cleared. The payload path promotion.categories[].id is checked per record. |
| Stores back-in-stock request | POST /back-in-stock-service/v1/back-in-stock-notification-requests, PUT .../{id}/mark-as-notification-sent, POST .../query | VERIFIED LIVE 2026-10-27 (stores/back-in-stock-request). Needs setup steps install-wix-back-in-stock and start-back-in-stock-collection (else 428 BACK_IN_STOCK_COLLECTION_DISABLED). createBackInStockRequest(wix, { itemDetails: { name, price }, request, notified, knownRequestId }): creating sends nothing; notified: true marks it sent offline. A 409 duplicate is resolved client-side (Query filters on status only) or deferred. A mark whose reply was lost is read back; still unconfirmed it is mark-unverified with requestId (journal succeeded_unverified with that target id). A marked request no longer blocks a duplicate create, so a re-run of a record with a known request id passes knownRequestId: the request is read and finished, never created again. A new email creates a contact. |
| Reviews | POST /reviews/v1/bulk/reviews/create, POST /reviews/v1/bulk/reviews/moderate, GET /reviews/v1/reviews/{id}?returnPrivateReviews=true, PATCH /reviews/v1/reviews/{id}/reply | VERIFIED LIVE 2026-10-27 (stores/review). Needs install-wix-reviews. createStoresReviews(wix, { records: [{ sourceStableKey, review }], readinessGrant }): chunks of 100, each item checked against its own record (entityId, author.contactId), results by originalIndex (created, already-exists, failed, unknown). Rating 0-5 (bulk accepts 0). moderateStoresReviews([{ wix, reviewId, status }]) sends every APPROVED/REJECTED moderation first, then reads them back in shared rounds. Moderate per batch, right after its create and before the task’s next evaluateTask, with record clients bound to that batch’s grant: a grant from an earlier evaluation is refused unsent (moderation-failed, error.requestSent: false); a review created earlier is moderated by gating its key again in the current batch. A failed chunk never hides earlier chunks’ results (failed when nothing was sent, else unknown). Merchant replies (docs-verified, not yet live): setStoresReviewReply(recordClient, { reviewId, message }) after create, with the review record’s own client; PATCH /reviews/v1/reviews/{id}/reply is admitted only for that record’s own review, reads before (same reply: already-present, nothing sent) and after (verified / unverified); over 1000 characters is not-sent (CMS shadow + ledger). |
| Contact labels | POST /contacts/v4/labels, GET /contacts/v4/labels/{key} | VERIFIED LIVE 2026-10-27 (crm/label). findOrCreateContactLabel(wix, { displayName }) / buildFindOrCreateContactLabelRequest: Wix returns the label with that name or creates it (newLabel), so a retry or unknown outcome resends the same call; read back by key. Outcomes label-written / label-reconciled-existing / label-unverified / label-failed. The crosswalk target is label.tagId (5 chars): a V4 label IS the V5 contact private tag. |
| Labels on a contact | POST /contacts/v5/contacts/{contactId}/update-tags, GET /contacts/v5/contacts/{id}?fields=TAGS | VERIFIED LIVE 2026-10-27 (crm/contact-label). assignContactLabels(wix, { contactId, tagIds }) / buildUpdateContactTagsRequest: one contact per call, assign-only, contactId in the path and the body so the readiness grant checks it and each tag id (per-record crm/contact + crm/label edges). Wix accepts a tag id that does not exist, so tag ids come only from the grant. Never put tags in the contact upsert: the default OVERWRITE replaces a matched contact’s tags. Up to 1000 tag ids per call (the builder throws above that; split in mapping). Outcomes contact-labels-assigned / contact-labels-unverified / contact-labels-failed. |
| Member About | POST /members/v2/abouts/query, POST /members/v2/abouts, PATCH /members/v2/abouts/{id}, GET /members/v2/abouts/{id} | VERIFIED LIVE 2026-08-16 and 2026-10-27 (members/member-about). upsertMemberAbout(wix, { memberId, content }): query by memberId, PATCH the one found with its revision, else create; one re-query after a 409 (ALREADY_EXISTS / INVALID_REVISION); two Abouts for one member are member-about-ambiguous (nothing written). memberAboutContentFromText(bio) wraps a plain bio as paragraph nodes and returns null for an empty bio (skip it). Wix accepts an About for a member id that does not exist, so memberAbout.memberId comes only from the per-record members/member grant. Deleting a member leaves its About. Journal (all three writers): record *-written / *-updated / *-reconciled-existing / contact-labels-assigned as imported with the target id; *-unverified as needs_verification with the target id (counted unresolved); *-failed and member-about-ambiguous as failed, so the completion report and cutover handoff count them. A *-failed whose error.requestSent is false was refused by the client before sending: journal it failed_retryable with top-level requestSent: false and failure.errorCode from error.code, never as an uncertain write. |
Direct REST (sendDirectRest) | any path | Dev probes only. Unmarked requests are refused as writes by import, setup and quick clients (DEPENDENCY_READINESS_REQUIRED in an import task). Never generated for an import; a native entity with no writer uses guarded raw requests. |
Guarded raw requests (sendGuardedRawRequest, buildGuardedRawRequest, buildGuardedRawReadRequest, verifyGuardedRawCanary) | the entity’s own Wix API, any path the agent picks | Import tasks only, for a native or native-plus-cms entity with no reviewed writer. The agent picks method and URL; the client refuses (RAW_REQUEST_REFUSED:<reason>) DELETE and a POST to a delete path segment (…/bulk/delete, delete-by-filter; delete), any host but www.wixapis.com (host), a path with %, ; or an empty segment (path; paths are compared lower-case), a URL any toolkit builder or another entity’s reviewed writer sends (other-entity:<ref> or other-entity:toolkit, built from the builder source and knowledge; the entity’s own knowledge endpoint wins a tie), toolkit-only services (reserved: site mute, app install, CMS collections, site properties), and any entity that has a reviewed writer, except the records outside its preferredWrite.writerScope (item SEO for item types other than BLOG_POST). The client sends a private copy taken when send is called, so editing the request afterwards changes nothing. The task-entity and readiness-grant checks of a reviewed writer still run. Every call is journaled in state/attempts/raw-requests.ndjson; a call with no outcome is never retried (RAW_REQUEST_OUTCOME_UNKNOWN) until resolveRawRequestOutcome records the operator’s check. Per run, the first record is the canary: until verifyGuardedRawCanary passes on a read the client made, any other record is refused (RAW_REQUEST_CANARY_PENDING); a mismatch holds the entity for the rest of the run (RAW_REQUEST_ENTITY_HELD). rawRequestSummary(projectDir) gives the completion-report and cutover rows. |
Writers send emails and phones exactly as given; nothing replaces them (safe mode was removed;
notifications rely on the site mute). Target domain entity files may define
contactFields[] with { kind, targetPath, source, notes } entries naming the request-body
paths that carry an email or phone. The order contact-field rules (order-history.js) read
their list from ecom/order‘s contactFields[].
lib/wix-writers.js exports the Stores subscription contract and deterministic helpers:
STORES_SUBSCRIPTION_CONTRACTnormalizeStoresProductSubscriptionsvalidateStoresProductSubscriptionDetailsGenerated import code should call the normalizer from product transforms and the validator during dry-run and immediately before live create. Validation failures are record-level preflight failures/deferred outcomes; do not send known-invalid subscription payloads to Wix to discover field errors live.
Catalog V3 subscriptions are a native Stores target, not an automatic CMS fallback or
semantic loss. Product create with subscriptionDetails.allowOneTimePurchases and
subscriptions[] entries containing title, description, frequency, interval, and
autoRenewal was verified live on 2026-07-26; Wix returned
server-assigned subscription option ids. Mapping/codegen should emit native recurring product
creates when the source cadence is known. General subscription patching remains unverified.
Use the shared Stores verification CLI for live target checks that would otherwise become migration-local snippets:
node skills/wix-replatform/resources/rp-target-wix/scripts/verify-stores.js stores subscription-create \
--artifact migrations/<project>/setup/stores-subscription-verification.json \
--proposal-artifact migrations/<project>/setup/contract-ledger-proposal.json
node skills/wix-replatform/resources/rp-target-wix/scripts/verify-stores.js stores product-count \
--project migrations/<project> \
--artifact migrations/<project>/execution/stores-product-count-verification.json
node skills/wix-replatform/resources/rp-target-wix/scripts/verify-stores.js stores product-by-source-marker \
--marker-path customFields.sourceId --marker-value <source-id> \
--artifact migrations/<project>/execution/stores-product-marker-verification.json
node skills/wix-replatform/resources/rp-target-wix/scripts/verify-stores.js stores delete-probe \
--product-id <probe-product-id> \
--artifact migrations/<project>/setup/stores-probe-cleanup.jsonThe CLI reads WIX_AUTH_TOKEN and WIX_SITE_ID from the environment or
config/wix.env under the current project root, creates the shared Wix client, and sends
requests through wix.send(...). It writes machine-readable artifacts with the target
site id, endpoint, method, verified nested paths, discovered constraints, probe id,
cleanup status, warnings, recovery instructions, and timestamp. Failed probe cleanup is
not hidden: the artifact must remain with an explicit warning and a delete-probe
recovery command.
URL preservation is a mapping and execution-state concern. This adapter owns only the Wix-side facts that generated code may rely on when deciding whether a final target URL is known.
Current import-only phase rules:
urlStatus: "pending_target_route" or target_url_missing and record unresolved rows
for the future website-builder phase.actualTargetSlug or
actualTargetRelativeUrl and write a redirect plan if it differs from the source URL.Known routed entity status:
| Entity | URL behavior contract |
|---|---|
| Blog posts | Create/publish is verified for content writes. Final public route exposure after publish is not verified here; generated code must treat the target route as pending_target_route unless a safe lookup in the generated write spec proves the final relative URL. |
| Blog categories | Category create is verified. Final public category route exposure is not verified here; default to pending_target_route. |
| Stores products | Product create and slug-bearing product operations are verified, but arbitrary route/base-path configuration is not part of this phase. Generated code may record actual target slugs only when returned or safely looked up; target relative URLs remain pending_target_route unless the route pattern is explicitly verified in the project. |
| Stores categories/collections | Category create is verified. Final collection/category route exposure is not verified here; default to pending_target_route. |
| CMS items with dynamic pages | CMS item writes are verified. Dynamic page route patterns are site-builder configuration, not native item import output; default to pending_target_route unless website-builder artifacts define the route. |
In addition to endpoint primitives, this adapter should define the reusable runtime API that generated migrations call.
Conceptual contracts:
executeWriteSpec({
spec,
items,
client,
dryRun,
runContext,
}): Promise<WriteExecutionReport>
executeSetupPlan({
plan,
client,
dryRun,
runContext,
}): Promise<SetupExecutionReport>The exact filenames are implementation details, but the shared runtime should be the single place that owns generic Wix execution mechanics.
WriteSpec contractGenerated migrations should pass a declarative WriteSpec into the shared runtime.
Each spec should define, as applicable:
entitymode: create | update | upsert | bulk_create | bulk_upsertcreateupdatelookupbulkbatchSizeconcurrencyretryPolicythrottlePolicyauditKeyscrosswalkAuthority: "local"cmsMirrorcrosswalkStrategyreconciliationStrategydependencyRefsverificationLevel: verified | unverifiedThis resource should document how each field is interpreted by the runtime.
WriteExecutionReport contractThe shared runtime should return a compact, token-aware report suitable for the agent.
It should include:
The runtime should prefer grouped summaries over raw per-record detail.
These per-entity or per-phase reports are intermediate runtime outputs. They are inputs to the final completion artifact, not replacements for it.
The shared runtime should support deterministic emission of a final machine-readable completion artifact for the whole run.
Preferred output:
execution/completion-report.jsonThis artifact should be the authoritative source for:
dryRun: true: requests built, Wix calls skipped,
would-create/update/delete, would require live lookup, and local validation failuresThe shared runtime should also support deterministic rendering inputs for:
execution/review/completion-summary.mdThe rendered summary should be derived from completion-report.json, not independently
invented by the agent.
The shared runtime should emit append-only machine-readable audit events.
Preferred format: NDJSON.
Each event should capture, at minimum:
setup | importThe run ID is required because audit files are append-only across dry-runs, retries, and
recovery passes. Completion reports should be generated from runtime counters for the
current run and may use audit aggregation only when filtered by run ID. The shared
lib/audit-summary.js helper enforces this filter for fallback/verification summaries.
The shared Wix runtime exports createDryRunConfig, normalizeDryRunValue,
createWixClient, and createWixSetupExecutor.
Dry-run is enabled by DRY_RUN=true or by the generated entrypoint’s --dry-run flag.
It is disabled by default. true, 1, yes, and on enable it; false, 0, no,
and off disable it.
When createWixClient({ dryRun: true }) is used:
authToken and siteId may be blank unless the generated project requires the site ID
for a local artifact namespace;send() must not call fetch, SDK, MCP, or CLI transports;send() must capture the would-send request under
state/attempts/wix-request-captures.ndjson when projectDir or requestCapturePath
is supplied;Authorization and redact secret-like header/body keys;{ contact }, { product }, { dataItem }, { file }, or an expected collection
field such as { contacts: [] } for skipped queries.lib/dry-run-target.js), and those placeholder responses count as the record’s evidence
for its follow-up calls, the same as live responses; the shared target read pacer never waits in a dry run.Dry-run placeholder target IDs are not live authority. If downstream local execution
needs them, write them only to state/crosswalk/dry-run-crosswalk.ndjson or keep them
in memory. Never append simulated target IDs to state/crosswalk/crosswalk.ndjson and
never upload them to a CMS crosswalk mirror.
When createWixSetupExecutor({ dryRun: true }) is used, each setup step must first be
reduced to a structured intent, then captured as planned_dry_run without invoking MCP,
CLI, SDK, or REST transports that access or mutate Wix account/site state.
The shared runtime contract should preserve explicit artifact authority:
execution-log.md for chronology and operator/debug context onlycompletion-report.json for final outcomecompletion-summary.md for deterministic user-facing renderingThe runtime should not force downstream consumers to reconstruct final outcome by reading raw audit logs or chronological execution logs.
createWixClient().send checks the response status before it tries to read
the body, and every failure it throws says which of two things happened:
outcomeKnown: true, status set, body parsed, applicationErrorCode populated when
the envelope carried one. Report it and classify it by status; only the duplicate-protected transient paths below may retry.outcomeKnown: false, with rawBody holding the first 400 characters of what actually
came back and status set to what the target returned (null only when no response
arrived at all). Nobody knows whether the write was applied, and the honest report says so.A 2xx whose body does not parse is unknown, not a success: it usually means the request
never reached the service, and returning null there is how an unwritten record becomes a
written one in the report. An empty body on a 2xx is not unparseable and still returns
null, as several Wix deletes answer exactly that way.
describeError carries outcomeKnown: false through to the results ledger, so the
distinction survives being written down.
One exported test decides whether a failure is worth trying again:
isTransientWixError (with TRANSIENT_WIX_STATUSES), from lib/wix-writers.js. It keys
on the target’s numeric status (429, 500, 502, 503, 504) and on the
no-response-at-all marker, and on nothing else — never on the error’s message text, which is
truncated at 400 characters by design, and never on applicationErrorCode, in either
direction. 403 is excluded: it is one endpoint’s observed throttle and a real permission
failure everywhere else. No caller may define its own copy.
It answers “is this condition likely to clear”. It does not answer “is it safe to try
again” — only the call site knows that. Exactly two write paths retry (3 attempts, with 500 /
1500 ms between attempts): the order import and the reconcile-plus-payment-write pair, both inside
importOrderHistory, and both only because they reconcile against the target first. Nothing
else does, because a write that is not reconciled first and fails after the target committed
would be retried into a duplicate record.
A 429 is the one exception, and the client handles it, not the caller. Wix refuses a
rate-limited request before processing it, so createWixClient‘s send sends the same request
again, for a read or a write: it waits Retry-After (capped at 30 s, plus jitter), else
jittered exponential backoff from 1 s, up to RATE_LIMIT_POLICY.maxRetries (5) more tries. The
pacing it learns is per endpoint (site + method + path, ids folded) and shared by every client in
the process: a 429 widens that endpoint’s spacing, a Retry-After holds it shut for every caller,
and clean replies narrow it again (client.rateLimitStats counts waits per endpoint). Every Wix
API, single or bulk, gets this because every request goes through send. A few writers keep an
older retry of their own on top (Ricos conversion, plan-order create, product media rounds, the
read pacer, quick Shopify); their waits now add to the client’s. Only a 429 that outlasts every
retry reaches the caller. It carries requestApplied: false, so the raw-request journal records it
as refused, not unknown, and importProducts leaves that record retryable for the next run.
This adapter should define one shared retry/throttling contract rather than letting each migration invent its own.
It should classify, at minimum:
429 responses5xx responses4xx validation failures unless explicitly listed otherwiseWhen the server provides backoff hints such as Retry-After, the shared runtime should
honor them.
The shared runtime should know:
Do not treat all media the same. The target domain decides whether media must exist in Wix first or can be ingested through the entity API itself.
Wix Stores products: prefer external URLs on media.itemsInfo.items[] and let the
product API ingest them in the background. This is the default path when the URLs are
publicly reachable.
What one item accepts, from the machine-readable Catalog V3 spec (component
ProductMedia) — not from the prose article, which disagrees on the cap:
| Field | Direction | Constraint |
|---|---|---|
setBy.id or setBy.url | in | a oneOf — exactly one per item |
altText | in | 1–1000 characters |
displayName | in | max 80, and only accepted when the item is set by url |
mediaType, uploadId | out | read-only |
media.image, media.video | out | read-only; populated when the item is set by id |
thumbnail | out | Wix-generated; needs THUMBNAIL in the request’s fields array |
media.main (on the parent) | out | read-only; always the first entry of itemsInfo.items — reorder the array to change it |
⚠️ thumbnail is not an input. It looks like a second image URL you could supply and
it is not — fields is defined as “Fields to include in the response”, so THUMBNAIL
only asks Wix to return a derivative it generated from the one file you uploaded. There is
no input that influences it, and none that raises an already-ingested item’s quality: the
URL you send is that image’s permanent ceiling. Send the source’s original, maximum-
resolution file — the source adapter owns that choice (WordPress sources: wp-image-url.js).
⚠️ The cap is disputed by Wix’s own docs. The schema says maxItems: 50 on
itemsInfo.items; the About Product Media article says 15. Follow the schema and do not
design near either bound.
⚠️ The article also says width/height are not populated for URL-set media. Observed
behaviour contradicts it — a URL-set item read back live returned both — so reading
dimensions back is a usable post-ingest check. Confirm at first live run before reporting
it as a guarantee.
⚠️ The 200 is a queue acknowledgement, not a delivery — and a failed ingest empties the
gallery. This is the most expensive trap on this endpoint, so it gets its own paragraph.
The write returns 200 with the item echoed back as mediaType: "UNKNOWN_MEDIA_TYPE" and an
uploadId; Wix fetches the URL afterwards, on its own side, with no callback and no status
endpoint. media.itemsInfo.items is a full replace, so the product’s existing image is
discarded the moment the PATCH is accepted. When the later fetch fails, Wix drops the item
and the product is left with no images at all — 200 on the write, no error anywhere, and
the old picture already gone.
It is transient and unattributable: observed live on a valid, publicly reachable 2048×2048 JPEG that ingested fine on the very next identical attempt. Nothing about the file or the request predicts it, so there is nothing to validate up front.
| Observed live | Frequency |
|---|---|
| Items not ingested 60 s after an accepted write | a sizable minority |
| Of those, fixed by one identical retry | nearly all |
| Writes refused by an edge-level 429 whose body is an HTML page, not JSON | occasional |
So: never treat a 200 as done. Read the product back with ?fields=MEDIA_ITEMS_INFO
(a plain GET returns only media.main and looks empty even when healthy), and re-send
anything whose items lack an image.id. A miss is not yet known, never failed — only
re-sending distinguishes “still in flight” from “dropped and gone”. Use
patchStoresProductMediaVerified, which does this, rather than patchStoresProductMedia,
which returns on the 200. Re-read the revision each round: the accepted-but-not-ingested
write already incremented it.
⚠️ Two different failures, one retry list. A write refused with 429 leaves the OLD image in place; a write accepted but never ingested leaves NOTHING. Anything that did not reach the verified state goes into the next round, whatever went wrong — recording one of them as an error and dropping it out of the loop is how a run reports success over products it never fixed. Keep the write pool small (3 concurrent, not 6) so the edge limiter is not the thing the retry loop spends its rounds on.
WordPress-family URL provenance is enforced here. A generated importer uses the exact
confirmedPictures instance exported by wix-writers.js for declaration, source reads and
confirmation; a separately required toolkit or vendored copy does not activate this writer.
After declaring orchestration/decisions.json → sourcePlatform.value, guarded importers call
assertProductMediaGuardActive() at startup and stop if this writer’s own guard is inactive.
Under exact woocommerce or wordpress declarations, buildStoresProductMedia accepts URL
items only when the complete ordered list came from confirmPictures (or an exact
normalization registered by deriveConfirmed). Create, bulk create, general patch, media
patch and verified media patch all cross this boundary; the verified path checks before its
first read. Hand-built strings, objects, clones, subsets, extensions and reorders throw before
any Wix request. Wix media ids, other source identities and undeclared legacy callers retain
their current behavior.
⚠️ A round that failed must back off before the next one, and it is a different wait from
the settle wait. The settle wait comes after an accepted write, so a round that throws
never reaches it — retry immediately and the loop burns all its rounds in milliseconds against
a rate limit that lasts tens of seconds, which is a retry loop that only looks like one. Two
waits, two purposes: settleMs waits for an accepted write to finish ingesting, retryDelayMs
waits for a refusal to lift. Skip the delay after the final round — there is nothing left to
wait for and the caller should not pay for it.
Wix Blog cover images and other surfaces that require a Wix media id at create/update time: import media first, then pass the Wix media id into the entity payload.
Generic Media Manager import is a fallback/shared primitive, not the default for every entity carrying media.
The media primitive imports by URL: Wix servers fetch the provided sourceUrl. Public
HTTPS URLs are expected; localhost, 127.0.0.1, Docker-only hosts, and other
private-only URLs are not reachable by Wix during a live import. This is optional source
preparation and, as far as we know today, affects media import only.
If the source system is local, the migration should either:
Ngrok quick setup for macOS:
brew install ngrok
ngrok config add-authtoken "<YOUR_AUTHTOKEN>"
ngrok http 8090
export WP_BASE_URL=https://<id>.ngrok-free.appCodegen-time MCP doc checks confirm an endpoint exists; they do not confirm the request shape works. The live wporg-news import proved doc examples can be wrong (lowercase Ricos plugins → 400) or incomplete (featured image field, tag body). The rule for this adapter:
Treat a shape as verified only after a real call succeeds — encode the working
shape here with a // VERIFIED: (or // VERIFIED-TRAP:) note and a date.
A // UNVERIFIED: primitive is allowed as a bootstrap point for generated code, but it
is not a silent live-write permission. The execution plan must call it out, and setup
verification must either promote it with a sandbox/live validation or route to fallback.
Keep tests/target-wix/contract-test.js current: it issues one real call per primitive
against a sandbox site and is the single place schema drift surfaces. Tests live in the
repo’s tests/ tree rather than in this bundle, so the published product carries no test
harnesses. Run from the repo root:
bash tests/run-all.sh target-wix
WIX_AUTH_TOKEN=... WIX_SITE_ID=... bash tests/run-all.sh target-wixWithout credentials the shape checks still run and the live calls are skipped.
tests/target-wix/ndjson-contract-test.js covers lib/ndjson.js and never needs
credentials.
For live verification runs, pass --progress-log <path> and poll it per
CONVENTIONS.md#progress-log-polling.
Run on a cadence and after any Wix API change. A failing contract test — not a stranger’s broken import — is how we learn the surface moved.
A migration only ever writes to a V3_CATALOG site. Catalog V1 is not a supported
destination: there is no V1 write primitive here, no V1 fallback, and none should be added
(a former V1 fallback was removed — it only masked real V3 errors as spurious 428s). A V1
site is a blocker the run halts on, not a variant the adapter, the mapper, or codegen
accommodates. The V3 create traps are handled in lib/wix-writers.js
(normalizeStoresProductV3 + the top-level treeReference builder), so callers never
re-hit them.
On a site this run created, a Stores install is guaranteed Catalog V3. This section
used to require verifying that live, because a site scaffolded
from the blank headless template, with Stores installed afterwards through the App
Installation API, could come up V1_CATALOG — Catalog version is fixed at provisioning, so
every V3 write on such a site failed and the site had to be abandoned. The Wix platform has
since changed: Catalog V3 is now guaranteed at provisioning regardless of scaffold
template, so that failure mode can no longer occur for a newly-created site, and neither
the --site-template commerce requirement nor the pre-write version gate apply anymore.
This does not extend to an existing site this run did not create — rp-execute-setup
(“A V1_CATALOG verdict is terminal here”) still treats that case as a live risk and
halts on it, since a pre-existing site’s catalog version predates this guarantee.
Import Order creates no payment record — a freshly imported order reads back with
payments: [] — so payment history is a separate write, and refunds have nothing to reference
until it exists. And the order write itself has no idempotency unless it is given an id.
The contract is one call: importOrderHistory in lib/order-history.js. It owns
the per-order sequence — derive the order id, read or write the crosswalk, import, gate, one
reconciliation read, payment, refunds, invoice document — and returns every stage’s outcome:
const { importOrderHistory, createProjectOrderCrosswalk } = require('./lib/order-history.js');
const result = await importOrderHistory(wix, {
order, // mapped Import Order body, no `id`
sourceId, sourceSiteHost,
evidence, // { amount, paidDate, altPaidDate, currency, status, methodName, providerTransactionId,
// offlinePayment, cardDisplay, refunds: [{ sourceId, amount, reason }],
// invoice: { approval, sourceUrl, invoiceNumber, pendingMediaFileId },
// utcOffsetMinutes, // a fact about the SHOP
// paidDateZone, altPaidDateZone } // 'utc' | 'site-local', a fact about
// each source KEY. The offset is applied only to a stamp declared 'site-local'.
// Supplying utcOffsetMinutes beside a present stamp with no clock is REFUSED.
crosswalk, // createProjectOrderCrosswalk({ projectDir }) — required, persisted
setupVerification, // setup/extended-field-verification.json, read once per run
});
// result.outcomes = { order, payment, refunds: [{ sourceId, sourceOccurrence, outcome, refundId, paymentId }], invoice }
// result.findings, result.errors (partial failures carry a cause), result.orderId, result.paymentIdIts guarantees, each the answer to a failure mode seen in end-to-end testing:
sourceSiteHost and sourceId and the crosswalk row is
written before any further write. Hit or miss, the target is asked by id once — a read, not a
duplicated store, and not a phantom order either. A crosswalk row from before derived ids (a Wix-minted id) wins and
is counted as order-id-from-crosswalk. An existing order is never re-sent: Import Order’s
replace is silent and would overwrite a merchant’s edits.order.currency.payment-failed / refund-failed / invoice-failed with errors.<stage>.cause, so a resume
reconciles the order and retries only what failed. An order-stage failure fails the rest for the
cause order-not-imported; a target that cannot be read is order-target-read-failed and
writes nothing.buyer, never on the body, and the body’s buyerInfo.email must be the billing email the member was corroborated against.
lib/order-buyer.js resolveOrderBuyer({ sourceCustomerId, billingEmail, memberCrosswalk, contactCrosswalk }) links buyerInfo.memberId only when the member crosswalk row’s loginEmail
equals the order’s billing email; a guest, a missing row or a mismatch links nothing and reports
(buyer-* outcomes). The result is stamped; the composite sets buyerInfo from it and refuses a
body that carries memberId itself. Import Order stores ANY GUID there unvalidated (verified
live), so this is the only guard.approval goes to the writer unchanged. The merchant opt-in is applied when the
plan is built, nowhere else — and resolvePreservationPlan() stamps what it approves
(lib/preservation-approval-stamp.js), so the writer refuses an opt-in that did not come from
the plan. A READY Media file whose order patch failed comes back as
invoice-fields-write-failed with pendingMediaFileId; the composite remembers it in the
crosswalk (getInvoiceFile/setInvoiceFile) and the resume records that file instead of
importing another. The crosswalk contract is four methods, all required.order-reimported-after-deletion. One read per order per run, hit or
miss.Live: tests/target-wix/order-history-live-sentinel.js (credential-gated) — three runs against a
disposable site, one order and one payment afterwards, cleaned up through Bulk Delete Imported
Orders. Passed 2026-09-05.
The writers keep their contracts and remain callable; the composite is a new caller of them. This is what each one guarantees, kept here because the guarantees are the reason the sequence is safe:
evaluatePaymentEligibility() in lib/order-payment-mapping.js
requires a positive amount AND a source paid date. An order total is not evidence of payment;
neither is an order status, and neither is a transaction reference. Ineligible orders are
reported under a named reason and never reach the target — which is also what keeps target
reads proportional to evidenced payments rather than to the whole order population.buildPaymentRecord(). status sits at payment level, not inside
regularPaymentDetails. savedPaymentMethod is never set: the field is writable but no
reusable credential can accompany it, so setting it asserts a charging agreement that does not
exist. An unknown offline/online class is OMITTED, never guessed — that is how a card payment
ends up labelled as cash.writeOrderPayment(). It reads the order’s existing
payments every run and matches by provider reference, else by an exact fingerprint of the
payment facts. The migration’s own crosswalk is a hint, not proof of target state: it does not
survive “Wix write succeeded, crosswalk write failed”, and it is blind to payments the merchant
created by hand. Exactly one match reconciles, more than one is ambiguous and prohibits
creation, and a failed target read is its own outcome — never permission to create. Add
Payments fails the ENTIRE call if a duplicate external transaction id is present, so writing
blind breaks the run and can double recorded revenue.ensureOrderPaymentAndRefund(). Assign
occurrence numbers first and pass sourceOccurrence (the composite does this from the refunds’
source ids; a direct caller uses assignRefundOccurrences()): two
distinct source refunds can share a payment and an amount, and without it the second one
reconciles against the first and is silently dropped. It no longer
fabricates a payment to give a refund something to point at; a qualified refund whose order
evidences no payment is reported as refund-without-payment. externalRefund is a hardcoded
literal true — it defaults to false, which calls the payment provider for real. Omit
sideEffects entirely: that is what suppresses restock and the customer email. The refund date
cannot be preserved (read-only and immutable), so every written refund discloses that loss, and
the true date must not be smuggled into the customer-visible customerReason.preserveOrderInvoiceDocument(). Pass the
approval straight from resolvePreservationPlan(), and pass sourceSiteHost with it. The
writer refuses anything that is not an approval naming that exact URL, and it re-derives the
DECISION from its own classification rather than trusting the approval’s action: a document
that is not on the source site needs merchantOptedIn however the approval is labelled — and
the opt-in is believed only under the planner’s provenance stamp.
action is caller-supplied, and trusting it meant a caller could relabel a third-party
document preserve and have it imported on nobody’s authority. With no sourceSiteHost the
guard answers third-party, so omitting it fails closed. Pass the persisted
setup/extended-field-verification.json as setupVerification. When a previous run left an
import in flight, pass its pendingMediaFileId back so the import RESUMES instead of creating
another private orphan. It reads the
order itself — pass an orderId, not an order object — so an existing file id suppresses the
import and a re-run cannot import a second copy of a tax document. Pass the setup verification
receipt (setup/extended-field-verification.json): without it the write is refused as
invoice-fields-not-provisioned. The file is imported private: true; only the returned id is kept,
because the Import File response echoes sourceUrl and that URL is a bearer link. Update Order MERGES the extendedFields object it is given — verified live: a foreign
key survived a patch that never mentioned it. The write still sends the complete object, which
is precautionary rather than load-bearing. Do not describe it as preventing data loss; the API
does that itself. The Data Extension SCHEMA PUT is the opposite — there the merge is the only
thing preserving a merchant’s fields. Update Order also silently DROPS a value over the field’s
maxLength and still answers 200 (verified live 2026-10-27). The writer therefore leaves an
over-length invoice number unset, without truncating it, and reports invoice-number-over-length.
It reports any key the PATCH response does not carry back as invoice-field-dropped, and treats a
dropped file id as invoice-fields-write-failed, with pendingMediaFileId for the resume. These
findings arrive in the composite’s findings; count them like every other finding.Never call the invoicing service. Re-issuing a historical tax document mints a second legal
document under a different number, and whether publishing one emails the customer is undocumented
in either direction. The contract is non-use, and it is provable:
tests/target-wix/no-invoices-api-contract-test.js scans the published tree.
Extended fields must be provisioned and verified before any value is written — see
lib/data-extension-schema.js (orders, products, Contacts V5), lib/contact-extended-fields.js
(legacy Contacts V4, explicit opt-in only) and the provisioning section in rp-execute-setup. A
value write is blocked until setup verified that exact field. Contact values go under
extendedFields.namespaces._user_fields with V5 writers, or info.extendedFields.<verifiedKey>
with V4 writers — never both.
Four small target-side pieces, all pure except the writers named in the table above:
lib/coupon-redemption-drift.js — a bearer voucher is money, and its redeemability must be
decided at write time, not from the discovery snapshot. isBearerVoucher(coupon) narrows to
the money-instrument shape (a fixed amount, no scope, no minimum, usage_limit: 1);
classifySnapshot({ capturedAt, now, maxAgeMs }) refuses an undated or stale snapshot;
classifyPreWriteDrift refuses to write a voucher spent since capture (coupons-spent-after-capture)
and refuses to write one it cannot decide; classifyPostImportDrift + buildVoucherDriftPlan
produce the cutover remedy plan, with face value and affected orders per code;
verifyRemedyApplied insists on a post-settle read-back.
One measured fact drives all of it. Update Coupon WRITES when the specification carries
ONLY the changed fields plus a field mask — so a spent voucher is deactivated in place, keeping
its id, code, dates and amount. Send the FULL specification alongside a narrow mask and it
returns 200 with an empty body and writes nothing: the shape everyone reaches for first, and
a pass that counts 2xx responses reports a false pass on money. buildRemedyRequest can only
emit the minimal form; verifyRemedyApplied refuses to call any 2xx applied without a
post-settle read-back. specification.tags is the one usable marker field (every alternative is
silently dropped) and the vocabulary is frozen: Imported on everything a migration
writes, plus Already_Used or Disabled_At_Source on a disabled one. All recorded as pitfalls
on domains/stores/entities/coupon.json.lib/order-applied-discount-build.js — buildCouponAppliedDiscounts({ couponLines, resolveCoupon }) turns a source order’s coupon lines into appliedDiscounts[] entries of the
coupon variant ({ id, code, name, amount: { amount } }, discountType: GLOBAL) for the
Import Order body. There is no standalone write: the entity ecom/order-applied-discount is
written through importOrder. A code the coupon crosswalk cannot resolve produces NO entry and
an unresolved line — never a dangling coupon id. Import Order stores money as-is, so
priceSummary.discount must already agree with the entries.lib/pricing-plan-definition.js — evaluatePlanSources({ B1, B2, B3 }) (the row-count gate
and the “none found” wording), buildPlanDefinition(offer) (PRIVATE, unbuyable, ACTIVE; name
and description truncated WITH a finding; 7-day minimum cycle and 10-year maximum), and
assertInertPlan, which the request builder and writer both call.tests/target-wix/coupon-plan-live-sentinel.js (credential-gated, cleans up) — one coupon
of each mapped type including an expired and an exhausted one, one inert plan, one imported
order carrying a coupon usage. Its verdicts are recorded as pitfalls on the entity files.Per-project field maps and ordering (which source field → which data key, the
media/author/taxonomy ref maps, upsert-by-key) live in the generated transforms/write
specs. This adapter holds the invariant Wix request shapes, transport, and shared
execution mechanics. Collection names and schemas (PodcastEpisodes, …) are
project-specific and come from the mapping plan.
appDefId from the
official “Apps Created by Wix” table.WDE0110): install the Wix Data app appDefId e593b0bd-b783-45b8-97c2-873d42aacaf4 via the App Installation API; afterward POST /wix-data/v2/collections creates NATIVE collections with no WDE0110 (verified live).
Fallback: a custom app with a data-collections extension (declares collections at
install time, but can’t express REFERENCE fields).Wix has many apps/entities (Stores, Bookings, Events, Restaurants, Pricing Plans, CRM,
…). This adapter does not pre-build all of them. Coverage is demand-driven and
grows through reviewed releases. A migration that targets a native Wix entity before a
dedicated primitive exists writes it through guarded raw requests: the
records are written, the plan shows “raw request, no reviewed writer” before consent, and
the retro proposes a reviewed writer from the journaled calls. Generated code never writes
it through sendDirectRest.
Native target ladder when no dedicated writer exists:
rp-target-wix primitive when one exists.sendGuardedRawRequest; the client enforces the
URL rules, the journal and the first-record check. A reviewed writer, when one ships,
replaces the raw path automatically.The invariant: anything not backed by a verified primitive is surfaced to the user for consent before execution — never written silently.
This adapter should also define the shared setup-side runtime used by setup execution.
It should cover reusable mechanics for:
rp-execute-setup should consume setup artifacts through this runtime rather than
re-implementing setup mechanics in skill-local prose or one-off scripts.
Contract tests should validate not only request builders, but also the most important shared runtime invariants.
Examples:
Default-location reconcileInventory outcomes include catalogVerification: exact Catalog variant availability must agree even when no stock write is needed. Catalog reads are grouped per product with at most four concurrent reads and bounded retries. Non-default locations mark this check not-applicable; Inventory-only success is not a default-location Catalog completion verdict.
Use lib/contact-import.js importContacts and lib/product-import.js importProducts
for standard imports. Inside an import task, pass importContacts the task’s current
evaluation (from evaluateTask) with the task’s own client: it gates its rows and sends each
bulk upsert with withBulkReadinessGrant, one source key per contact. A bulk body sent with a
single record’s grant is refused. They reconcile source identities before writes, persist candidate
IDs in project-local state, and publish crosswalks only after identity/value read-back.
The request primitives do not themselves certify a mapping. lib/bulk-results.js selects
rules through explicit Contacts V5 / products-with-inventory / Inventory adapters; missing
indexes are unresolved, never positional fallbacks. Blog bulk remains outside those adapters.
Product SEO runs inside importProducts for rows carrying seo (a
lib/product-seo.js planProductSeo plan). It writes only proven or owner-materialized
title/description tags through product.seoData, verifies each field on the product and in
Item SEO resolvedTags, and reports report.seo.stageResiduals. Item SEO bulk set is refused
for STORES_PRODUCT. Verification is bounded: at most 3 products in flight, every read through
the shared sharedTargetReadPacer() (start slots reserved atomically and re-checked after a late timer wake, so actual starts
stay >=60 ms apart), an
immediate first resolvedTags read, and batch retry rounds whose settle wait stays within
31 s per stage. report.seo.timing reports settleWaitMs, pacingWaitMs and backoffWaitMs
separately; the last two are summed per-call waits, never added to wall-clock.
lib/write-verification.js forwards to the shared runtime comparators in
skills/wix-replatform/lib/write-verification.js. Contacts normalize only the
main email (trim/lowercase) and compare other mapped values exactly after the existing
per-source sanitizer. Phone-only identity and distinct source keys sharing a target block
and report. Product variant matching uses source-fixed projections and exact target IDs;
stock and default-location Catalog verification remain in reconcileInventory.
The existing subscription probe now records valueEvidence. Contract-ledger proposal
creation and promotion recheck those inputs; toggling status or supplying only present
paths cannot establish verified values. Existing published contracts remain in place.
These changes add no automatic probe or global canary gate. Schema fingerprints retained
as development evidence must be computed from saved docs-tool output, not authored claims.
Use scripts/multilingual-inventory.js to exhaust locale, schema, and translation-content
pagination; it normalizes Wix’s per-record schemaId/entityId/locale plus typed fields map
into deterministic per-field inventory rows. After the normal writer’s verified read-back,
scripts/multilingual-object-pairing.js records every source-object to Wix-object binding and
scripts/multilingual-member-pairing.js adds nested/repeated member bindings. Both accept only
API-supported stable IDs and emit no receipt when there are no additional locales. A top-level
field without a verified object receipt is unresolved; the source ID is never assumed to be the
Wix ID.
scripts/multilingual-execute.js applies the approved field-level sequences through a generated
adapter and versioned disposable-site proof file. It refuses unproved mutations, secures typed
prior values in ReplatformTranslationRecovery, verifies every value/publication state, and writes
per-route cost evidence. scripts/multilingual-decision.js is the sole writer of the scoped local
decision ledger, including durable owner restore requests. scripts/multilingual-restore.js
restores a verified journal row only while the live replacement digest still matches. The recovery
collection is administrator-only, stays on the destination, and is never exported.
scripts/multilingual-journal-removal.js opens the post-window action and deletes only after a
matching owner authorization; its absence read-back, not the authorization alone, closes the action.
Wix target adapter with verified write primitives, shared execution runtimes, and contract tests. Use when vendoring Wix writers, validating API shapes, or Wix provisioning mechanics.
The verbatim description from this skill’s front matter — the string an agent matches on to decide whether to load it.
main, last pushed 8 November 2026.SKILL.md, not by matching a directory convention. 5 distinct layouts observed: skills/*/SKILL.md, skills/wix-headless-replatform/resources/*/SKILL.md, skills/wix-replatform/resources/*/SKILL.md, */SKILL.md, wix-replatform/resources/*/SKILL.md.h1 and no skipped levels:.claude-plugin/marketplace.json by Wix, declaring 1 plugin. It is read for editorial metadata only — never as the skill index, which is always the repository tree./wix/skills.md, and each skill at its own .md URL.175 files · 2.4 MB
Everything this skill ships beside its prose. 174 of them are set here as subchapters of skill 41; the other 1 is described rather than reproduced.
Executable code the skill can run.
Everything else published alongside the skill.
domains/blog/2 files · 3 KB
domains/blog/entities/4 files · 10 KB
domains/bookings/2 files · 29 KB
domains/bookings/entities/3 files · 59 KB
domains/cms/2 files · 8 KB
domains/cms/entities/3 files · 5 KB
domains/crm/2 files · 10 KB
domains/crm/entities/4 files · 29 KB
domains/ecom/2 files · 18 KB
domains/ecom/entities/13 files · 196 KBdomains/events/2 files · 7 KB
domains/events/entities/5 files · 29 KB
domains/forms/2 files · 12 KB
domains/forms/entities/2 files · 37 KB
domains/gift-cards/2 files · 4 KB
domains/gift-cards/entities/2 files · 16 KB
domains/4 files · 99 KB
domains/media/2 files · 2 KB
domains/media/entities/2 files · 4 KB
domains/members/2 files · 5 KB
domains/members/entities/4 files · 25 KB
domains/pricing-plans/2 files · 4 KB
domains/pricing-plans/entities/2 files · 25 KB
domains/sales-channels/2 files · 2 KB
domains/sales-channels/entities/6 files · 20 KB
domains/seo/2 files · 12 KB
domains/seo/entities/3 files · 35 KB
domains/site/2 files · 5 KB
domains/site/entities/2 files · 13 KB
domains/stores/2 files · 10 KB
domains/stores/entities/13 files · 135 KBdomains/tax/2 files · 10 KB
domains/tax/entities/4 files · 25 KB
lib/54 files · 879 KB