SDK Curated

1{
2  "schemaVersion": 1,
3  "about": "Choices no SDK index can make. sdk-lookup.cjs prints a rule when one of its entities matches. `choice: site` means the namespace depends on the site, not on the install.",
4  "rules": [
5    {
6      "entities": ["product", "products", "catalog"],
7      "namespaces": ["products", "productsV3"],
8      "choice": "site",
9      "note": "Call catalogVersioning.getCatalogVersion() first: V3 sites use productsV3, V1 sites use products. Support both paths, and request both scope sets plus SCOPE.STORES.CATALOG_READ_LIMITED. To search by name, V3 has productsV3.searchProducts() (queryProducts cannot filter on name); V1 has no search method, and its builder takes name only with startsWith.",
10      "source": "SKILL.md (Stores), references/STORES_VERSIONING.md, references/stores/QUERY.md"
11    },
12    {
13      "entities": ["inventory"],
14      "namespaces": ["inventory", "inventoryItemsV3"],
15      "choice": "site",
16      "note": "Call catalogVersioning.getCatalogVersion() first: V3 sites use inventoryItemsV3, V1 sites use inventory. Request both scope sets.",
17      "source": "references/STORES_VERSIONING.md"
18    },
19    {
20      "entities": ["refund", "refunds"],
21      "namespaces": ["orders", "orderTransactions", "refunds"],
22      "choice": { "prefer": "orders", "intents": ["search", "read"] },
23      "note": "Refunded orders: orders.searchOrders with a paymentStatus filter, then orderTransactions.listTransactionsForMultipleOrders(ids) once for the visible page. Refund events are the exception: they live in @wix/payments (namespace refunds), not in @wix/ecom.",
24      "source": "references/dashboard-page/DATA_SOURCES.md, references/backend-event/COMMON-EVENTS.md"
25    },
26    {
27      "entities": ["location", "locations"],
28      "namespaces": ["locations"],
29      "note": "queryLocations is admin-only although its scope is SCOPE.DC-MULTILOCATION.READ-LOCATIONS: route it to a backend endpoint and elevate it there.",
30      "source": "moved from SKILL.md (Identity and Elevation Requirement), which links here"
31    },
32    {
33      "entities": ["member", "members"],
34      "namespaces": ["members"],
35      "note": "getMember and queryMembers withhold PRIVATE members from visitor and member callers: never elevate them to fill a sparse result.",
36      "source": "SKILL.md (Identity and Elevation Requirement)"
37    },
38    {
39      "entities": ["cart", "currentcart"],
40      "namespaces": ["currentCartV2", "cartV2"],
41      "note": "currentCartV2.addLineItemsToCurrentCart is visitor-callable although its scope is SCOPE.ECOM.MANAGE-ADMIN. Never elevate it.",
42      "source": "moved from SKILL.md (Identity and Elevation Requirement), which links here"
43    }
44  ]
45}