@wix/agent-skills 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +111 -0
- package/package.json +29 -0
- package/skills/wix-app/SKILL.md +344 -0
- package/skills/wix-app/references/APP_IDENTIFIERS.md +35 -0
- package/skills/wix-app/references/APP_MARKET_REVIEW.md +311 -0
- package/skills/wix-app/references/APP_VALIDATION.md +171 -0
- package/skills/wix-app/references/BACKEND_API.md +233 -0
- package/skills/wix-app/references/BACKEND_EVENT.md +116 -0
- package/skills/wix-app/references/CODE_QUALITY.md +33 -0
- package/skills/wix-app/references/CUSTOM_ELEMENT_WIDGET.md +587 -0
- package/skills/wix-app/references/DASHBOARD_MENU_PLUGIN.md +157 -0
- package/skills/wix-app/references/DASHBOARD_MODAL.md +283 -0
- package/skills/wix-app/references/DASHBOARD_PAGE.md +403 -0
- package/skills/wix-app/references/DASHBOARD_PLUGIN.md +205 -0
- package/skills/wix-app/references/DATA_COLLECTION.md +451 -0
- package/skills/wix-app/references/DOCUMENTATION.md +42 -0
- package/skills/wix-app/references/EDITOR_REACT_COMPONENT.md +65 -0
- package/skills/wix-app/references/EMBEDDED_SCRIPT.md +468 -0
- package/skills/wix-app/references/EXTENSION_REGISTRATION.md +96 -0
- package/skills/wix-app/references/SERVICE_PLUGIN.md +235 -0
- package/skills/wix-app/references/SITE_PLUGIN.md +436 -0
- package/skills/wix-app/references/STORES_VERSIONING.md +334 -0
- package/skills/wix-app/references/backend-event/COMMON-EVENTS.md +84 -0
- package/skills/wix-app/references/custom-element-widget/SETTINGS_PANEL.md +345 -0
- package/skills/wix-app/references/dashboard-menu-plugin/blog-slots.md +71 -0
- package/skills/wix-app/references/dashboard-menu-plugin/bookings-slots.md +58 -0
- package/skills/wix-app/references/dashboard-menu-plugin/crm-slots.md +8 -0
- package/skills/wix-app/references/dashboard-menu-plugin/ecommerce-slots.md +17 -0
- package/skills/wix-app/references/dashboard-menu-plugin/events-slots.md +29 -0
- package/skills/wix-app/references/dashboard-menu-plugin/restaurants-slots.md +27 -0
- package/skills/wix-app/references/dashboard-menu-plugin/stores-slots.md +35 -0
- package/skills/wix-app/references/dashboard-page/API_SPEC.md +138 -0
- package/skills/wix-app/references/dashboard-page/DASHBOARD_API.md +573 -0
- package/skills/wix-app/references/dashboard-page/DYNAMIC_PARAMETERS.md +269 -0
- package/skills/wix-app/references/dashboard-page/ECOM_NAVIGATION.md +164 -0
- package/skills/wix-app/references/dashboard-plugin/SLOTS.md +294 -0
- package/skills/wix-app/references/data-collection/WIX_DATA.md +270 -0
- package/skills/wix-app/references/data-collection/extension-template.ts +107 -0
- package/skills/wix-app/references/editor-react-component/ACCESSIBILITY.md +138 -0
- package/skills/wix-app/references/editor-react-component/COMPONENT-API.md +454 -0
- package/skills/wix-app/references/editor-react-component/COMPONENT-CONFIGURATION.md +165 -0
- package/skills/wix-app/references/editor-react-component/CSS-GUIDELINES.md +576 -0
- package/skills/wix-app/references/editor-react-component/DIRECTIONALITY.md +170 -0
- package/skills/wix-app/references/editor-react-component/EDIT-FLOW.md +6 -0
- package/skills/wix-app/references/editor-react-component/PARTS.md +25 -0
- package/skills/wix-app/references/editor-react-component/PROPS-VS-CSS.md +203 -0
- package/skills/wix-app/references/editor-react-component/REACT-GUIDELINES.md +167 -0
- package/skills/wix-app/references/editor-react-component/REACT-PATTERNS.md +137 -0
- package/skills/wix-app/references/service-plugin/ADDITIONAL-FEES.md +112 -0
- package/skills/wix-app/references/service-plugin/BOOKINGS-STAFF-SORTING.md +118 -0
- package/skills/wix-app/references/service-plugin/DISCOUNT-TRIGGERS.md +87 -0
- package/skills/wix-app/references/service-plugin/GIFT-CARDS.md +86 -0
- package/skills/wix-app/references/service-plugin/PAYMENT-SETTINGS.md +135 -0
- package/skills/wix-app/references/service-plugin/SHIPPING-RATES.md +79 -0
- package/skills/wix-app/references/service-plugin/VALIDATIONS.md +68 -0
- package/skills/wix-app/references/site-plugin/EXAMPLES.md +311 -0
- package/skills/wix-app/references/site-plugin/SLOTS.md +263 -0
- package/skills/wix-design-system/SKILL.md +129 -0
- package/skills/wix-design-system/references/file-structure.md +56 -0
- package/skills/wix-design-system/scripts/wds.cjs +531 -0
- package/skills/wix-headless/SKILL.md +418 -0
- package/skills/wix-headless/references/DISCOVERY.md +332 -0
- package/skills/wix-headless/references/ORCHESTRATION.md +269 -0
- package/skills/wix-headless/references/SETUP.md +154 -0
- package/skills/wix-headless/references/blog/BLOG_CONTENT.md +152 -0
- package/skills/wix-headless/references/blog/BLOG_PAGES.md +299 -0
- package/skills/wix-headless/references/blog/BLOG_SETUP.md +218 -0
- package/skills/wix-headless/references/blog/INSTRUCTIONS.md +32 -0
- package/skills/wix-headless/references/cms/CMS_FOUNDATIONS.md +373 -0
- package/skills/wix-headless/references/cms/FAQ_KNOWLEDGE_BASE.md +229 -0
- package/skills/wix-headless/references/cms/INSTRUCTIONS.md +40 -0
- package/skills/wix-headless/references/cms/PORTFOLIO.md +454 -0
- package/skills/wix-headless/references/cms/RESOURCE_LIBRARY.md +356 -0
- package/skills/wix-headless/references/cms/TEAM_DIRECTORY.md +299 -0
- package/skills/wix-headless/references/commands/install-app.md +42 -0
- package/skills/wix-headless/references/commands/known-apps.json +5 -0
- package/skills/wix-headless/references/commands/mcp-bootstrap.md +28 -0
- package/skills/wix-headless/references/designer/INSTRUCTIONS.md +828 -0
- package/skills/wix-headless/references/ecom/CART_PAGES.md +120 -0
- package/skills/wix-headless/references/ecom/CART_WIRING.md +103 -0
- package/skills/wix-headless/references/ecom/COMPONENTS_CSS.md +132 -0
- package/skills/wix-headless/references/ecom/INSTRUCTIONS.md +59 -0
- package/skills/wix-headless/references/forms/CONTACT_FORM.md +477 -0
- package/skills/wix-headless/references/forms/INSTRUCTIONS.md +43 -0
- package/skills/wix-headless/references/gift-cards/COMPONENTS.md +119 -0
- package/skills/wix-headless/references/gift-cards/INSTRUCTIONS.md +51 -0
- package/skills/wix-headless/references/gift-cards/PAGES.md +129 -0
- package/skills/wix-headless/references/images/INSTRUCTIONS.md +359 -0
- package/skills/wix-headless/references/shared/BUILD_NOISE.md +8 -0
- package/skills/wix-headless/references/shared/IMAGE_GENERATION.md +185 -0
- package/skills/wix-headless/references/shared/IMPLEMENTER.md +155 -0
- package/skills/wix-headless/references/shared/MCP_PREFIX.md +105 -0
- package/skills/wix-headless/references/shared/PRODUCTION_SHARP_EDGES.md +97 -0
- package/skills/wix-headless/references/shared/RETURN_CONTRACT.md +423 -0
- package/skills/wix-headless/references/shared/STYLING.md +117 -0
- package/skills/wix-headless/references/stores/BACK_IN_STOCK.md +178 -0
- package/skills/wix-headless/references/stores/CATEGORY_PAGES.md +86 -0
- package/skills/wix-headless/references/stores/COMPONENTS_CSS.md +129 -0
- package/skills/wix-headless/references/stores/HOME_AND_NAV.md +227 -0
- package/skills/wix-headless/references/stores/INSTRUCTIONS.md +96 -0
- package/skills/wix-headless/references/stores/PRODUCT_CATALOG_DATA.md +249 -0
- package/skills/wix-headless/references/stores/PRODUCT_PAGES.md +213 -0
- package/skills/wix-headless/references/stores/SHARED_WIRING.md +164 -0
- package/skills/wix-headless/references/verticals/_schema.json +160 -0
- package/skills/wix-headless/references/verticals/_schema.md +185 -0
- package/skills/wix-headless/references/verticals/blog.md +125 -0
- package/skills/wix-headless/references/verticals/cms.md +121 -0
- package/skills/wix-headless/references/verticals/ecom.md +96 -0
- package/skills/wix-headless/references/verticals/forms.md +106 -0
- package/skills/wix-headless/references/verticals/gift-cards.md +121 -0
- package/skills/wix-headless/references/verticals/stores.md +167 -0
- package/skills/wix-headless/scripts/check-manifest.mjs +198 -0
- package/skills/wix-headless/scripts/copy-utility-templates.mjs +153 -0
- package/skills/wix-headless/scripts/emit-design-tokens.mjs +77 -0
- package/skills/wix-headless/scripts/finalize-run-json.mjs +141 -0
- package/skills/wix-headless/scripts/init-site-json.mjs +63 -0
- package/skills/wix-headless/scripts/patch-decorative-slots.mjs +124 -0
- package/skills/wix-headless/scripts/plan-entity-image-waves.mjs +190 -0
- package/skills/wix-headless/scripts/preview.sh +45 -0
- package/skills/wix-headless/scripts/release.sh +73 -0
- package/skills/wix-headless/scripts/scaffold.sh +53 -0
- package/skills/wix-headless/scripts/seed-utilities.sh +55 -0
- package/skills/wix-headless/shared-utilities/analytics.ts +40 -0
- package/skills/wix-headless/shared-utilities/ricos.ts +179 -0
- package/skills/wix-headless/shared-utilities/wix-image.ts +72 -0
- package/skills/wix-headless/templates/ecom/CartBadge.tsx +84 -0
- package/skills/wix-headless/templates/ecom/CartView.tsx +543 -0
- package/skills/wix-headless/templates/ecom/cart.astro +13 -0
- package/skills/wix-headless/templates/ecom/components-ecom.css +215 -0
- package/skills/wix-headless/templates/ecom/discounts.ts +71 -0
- package/skills/wix-headless/templates/ecom/thank-you.astro +24 -0
- package/skills/wix-headless/templates/gift-cards/GiftCardPurchase.tsx +172 -0
- package/skills/wix-headless/templates/gift-cards/_home-teaser-snippet.astro +42 -0
- package/skills/wix-headless/templates/gift-cards/_nav-snippet.astro +11 -0
- package/skills/wix-headless/templates/gift-cards/components-gift-cards.css +219 -0
- package/skills/wix-headless/templates/gift-cards/gift-cards.astro +51 -0
- package/skills/wix-headless/templates/gift-cards/gift-cards.ts +75 -0
- package/skills/wix-headless/templates/stores/AddToCartButton.tsx +77 -0
- package/skills/wix-headless/templates/stores/BackInStockForm.tsx +176 -0
- package/skills/wix-headless/templates/stores/CategoryRail.astro +69 -0
- package/skills/wix-headless/templates/stores/ProductCard.astro +79 -0
- package/skills/wix-headless/templates/stores/ProductPurchase.tsx +397 -0
- package/skills/wix-headless/templates/stores/SeoTags.astro +21 -0
- package/skills/wix-headless/templates/stores/back-in-stock.ts +67 -0
- package/skills/wix-headless/templates/stores/categories.ts +155 -0
- package/skills/wix-headless/templates/stores/category/[slug].astro +130 -0
- package/skills/wix-headless/templates/stores/components-stores.css +295 -0
- package/skills/wix-headless/templates/stores/products/[slug].astro +128 -0
- package/skills/wix-headless/templates/stores/products/index.astro +101 -0
- package/skills/wix-manage/SKILL.md +280 -0
- package/skills/wix-manage/references/app-installation/install-wix-apps.md +155 -0
- package/skills/wix-manage/references/app-installation/list-installed-apps.md +124 -0
- package/skills/wix-manage/references/blog/how-to-create-blog-posts.md +226 -0
- package/skills/wix-manage/references/bookings/booking-service-policy-setup.md +95 -0
- package/skills/wix-manage/references/bookings/booking-system-integration-gaps.md +416 -0
- package/skills/wix-manage/references/bookings/bookings-staff-setup.md +255 -0
- package/skills/wix-manage/references/bookings/create-and-update-booking-services.md +462 -0
- package/skills/wix-manage/references/bookings/end-to-end-booking-flow.md +278 -0
- package/skills/wix-manage/references/bookings/external-calendar-integration.md +258 -0
- package/skills/wix-manage/references/bookings/multi-resource-service-creation.md +231 -0
- package/skills/wix-manage/references/calendar/configure-default-business-hours.md +226 -0
- package/skills/wix-manage/references/cms/cms-data-items-crud.md +422 -0
- package/skills/wix-manage/references/cms/cms-data-operations-extended.md +263 -0
- package/skills/wix-manage/references/cms/cms-ecommerce-catalog-integration.md +136 -0
- package/skills/wix-manage/references/cms/cms-references-and-relationships.md +160 -0
- package/skills/wix-manage/references/cms/cms-schema-management.md +143 -0
- package/skills/wix-manage/references/contacts/bulk-delete-contacts.md +73 -0
- package/skills/wix-manage/references/contacts/bulk-label-and-unlabel-contacts.md +67 -0
- package/skills/wix-manage/references/domains/domain-search-and-purchase.md +434 -0
- package/skills/wix-manage/references/ecommerce/api-recommendation-tracking.md +420 -0
- package/skills/wix-manage/references/ecommerce/flow-add-free-shipping.md +267 -0
- package/skills/wix-manage/references/ecommerce/flow-bundle-and-save.md +290 -0
- package/skills/wix-manage/references/ecommerce/flow-fix-coverage-gaps.md +300 -0
- package/skills/wix-manage/references/ecommerce/flow-optimize-shipping-rates.md +364 -0
- package/skills/wix-manage/references/ecommerce/flow-seasonal-promotion.md +315 -0
- package/skills/wix-manage/references/ecommerce/flow-stock-mover.md +308 -0
- package/skills/wix-manage/references/ecommerce/flow-upsell-boost.md +271 -0
- package/skills/wix-manage/references/ecommerce/goal-clear-inventory.md +118 -0
- package/skills/wix-manage/references/ecommerce/goal-drive-cross-sells.md +122 -0
- package/skills/wix-manage/references/ecommerce/goal-increase-aov.md +132 -0
- package/skills/wix-manage/references/ecommerce/goal-reduce-cart-abandonment.md +148 -0
- package/skills/wix-manage/references/ecommerce/goal-seasonal-revenue.md +146 -0
- package/skills/wix-manage/references/ecommerce/guardrail-discount-conflicts.md +118 -0
- package/skills/wix-manage/references/ecommerce/guardrail-margin-protection.md +88 -0
- package/skills/wix-manage/references/ecommerce/guardrail-rate-pricing-sanity.md +108 -0
- package/skills/wix-manage/references/ecommerce/guardrail-shipping-health.md +124 -0
- package/skills/wix-manage/references/ecommerce/recipe-apply-shipping-recommendations.md +299 -0
- package/skills/wix-manage/references/ecommerce/recommend-ecommerce-strategy.md +582 -0
- package/skills/wix-manage/references/ecommerce/setup-coupons.md +338 -0
- package/skills/wix-manage/references/ecommerce/setup-discount-rules.md +444 -0
- package/skills/wix-manage/references/ecommerce/setup-shipping-rates.md +86 -0
- package/skills/wix-manage/references/ecommerce/setup-shipping-regions.md +56 -0
- package/skills/wix-manage/references/ecommerce/setup-store-pickup-location.md +209 -0
- package/skills/wix-manage/references/ecommerce/skill-graph.md +139 -0
- package/skills/wix-manage/references/ecommerce/troubleshoot-checkout-delivery-dropoff.md +124 -0
- package/skills/wix-manage/references/ecommerce/troubleshoot-discount-not-applying.md +95 -0
- package/skills/wix-manage/references/events/list-events.md +203 -0
- package/skills/wix-manage/references/forms/create-form.md +260 -0
- package/skills/wix-manage/references/get-paid/create-payment-links.md +212 -0
- package/skills/wix-manage/references/get-paid/how-to-setup-wix-payments.md +57 -0
- package/skills/wix-manage/references/get-paid/payment-links-for-bookings.md +101 -0
- package/skills/wix-manage/references/media/upload-media-to-wix.md +216 -0
- package/skills/wix-manage/references/pricing-plans/create-and-update-pricing-plans.md +77 -0
- package/skills/wix-manage/references/pricing-plans/pricing-plans-bookings-integration.md +166 -0
- package/skills/wix-manage/references/restaurants/wix-restaurants-setup.md +336 -0
- package/skills/wix-manage/references/rich-content/ricos-converter-service.md +295 -0
- package/skills/wix-manage/references/site-properties/change-payment-currency-site-properties.md +59 -0
- package/skills/wix-manage/references/sites/create-site-from-template.md +183 -0
- package/skills/wix-manage/references/sites/query-sites.md +125 -0
- package/skills/wix-manage/references/stores/add-store-pages-to-site.md +57 -0
- package/skills/wix-manage/references/stores/bulk-create-products-with-options.md +1041 -0
- package/skills/wix-manage/references/stores/create-product-catalog-v1.md +125 -0
- package/skills/wix-manage/references/stores/create-product-from-image.md +824 -0
- package/skills/wix-manage/references/stores/create-product-with-options-catalog-v3.md +566 -0
- package/skills/wix-manage/references/stores/find-products-query-and-search-catalog-v3.md +194 -0
- package/skills/wix-manage/references/stores/query-products-catalog-v1.md +80 -0
- package/skills/wix-manage/references/stores/setup-online-store-catalog-v3.md +99 -0
- package/skills/wix-manage/references/stores/update-product-pre-order.md +213 -0
- package/skills/wix-manage/references/stores/update-product-with-options.md +318 -0
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Create Site from Template"
|
|
3
|
+
description: Creates new Wix sites from templates using account-level APIs. Covers template search, site creation, headless site setup, OAuth app creation, and publishing.
|
|
4
|
+
---
|
|
5
|
+
# Create Site from Template
|
|
6
|
+
|
|
7
|
+
This recipe guides you through creating a new Wix site from a template, including template selection and optional publishing.
|
|
8
|
+
|
|
9
|
+
## Prerequisites
|
|
10
|
+
|
|
11
|
+
- Wix account with site creation permissions
|
|
12
|
+
- Account-level API access
|
|
13
|
+
|
|
14
|
+
## Required APIs
|
|
15
|
+
|
|
16
|
+
- **Templates Search API**: `GET https://www.wix.com/_api/template-cms-view-service/view/v2/templates/search`
|
|
17
|
+
- **Create Site API**: `POST https://www.wixapis.com/msm/v1/meta-site/create-from-template`
|
|
18
|
+
- **Publish Site API**: `POST https://www.wixapis.com/site-publisher/v1/site/publish`
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Step 1: Understand User Requirements
|
|
23
|
+
|
|
24
|
+
Before searching templates, gather information:
|
|
25
|
+
|
|
26
|
+
1. **Ask the user** to describe the site they want in a few sentences
|
|
27
|
+
2. **Ask if they want** Wix Editor or Wix Studio
|
|
28
|
+
3. **Identify main apps** needed (Stores, Bookings, Blog, etc.)
|
|
29
|
+
|
|
30
|
+
### Quick Start (Skip Template Search)
|
|
31
|
+
|
|
32
|
+
If user wants an empty/blank site:
|
|
33
|
+
- **Wix Studio blank**: `fe86a14e-ef67-49b4-a409-d086f3abaa1a`
|
|
34
|
+
- **Wix Editor blank**: `b55bdf43-95e0-4cef-b9bb-92dcc7af2742`
|
|
35
|
+
|
|
36
|
+
Skip to Step 3 with these template IDs.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Step 2: Search for Templates
|
|
41
|
+
|
|
42
|
+
**Endpoint**: `GET https://www.wix.com/_api/template-cms-view-service/view/v2/templates/search`
|
|
43
|
+
|
|
44
|
+
**Query Parameters**:
|
|
45
|
+
| Parameter | Description | Values |
|
|
46
|
+
|-----------|-------------|--------|
|
|
47
|
+
| `language` | Always use | `en` |
|
|
48
|
+
| `limit` | Results per page | `24` |
|
|
49
|
+
| `offset` | Pagination offset | Start at `0`, increment by 24 |
|
|
50
|
+
| `bookType` | Editor type | `studio` or `main-v2` |
|
|
51
|
+
| `query` | Search keywords | `yoga+studio`, `ecommerce`, etc. |
|
|
52
|
+
|
|
53
|
+
**Example Request**:
|
|
54
|
+
```bash
|
|
55
|
+
curl -X GET \
|
|
56
|
+
'https://www.wix.com/_api/template-cms-view-service/view/v2/templates/search?language=en&limit=24&offset=0&bookType=studio&query=yoga+studio' \
|
|
57
|
+
-H 'Authorization: <AUTH>'
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
**Response** includes for each template:
|
|
61
|
+
- `metaSiteId` - Template ID for creation
|
|
62
|
+
- `templateSlug` - For preview URL
|
|
63
|
+
- Template name and description
|
|
64
|
+
- Color scheme
|
|
65
|
+
|
|
66
|
+
### Present Templates to User
|
|
67
|
+
|
|
68
|
+
For each relevant template, show:
|
|
69
|
+
- Template name
|
|
70
|
+
- Description (without "Click Edit" text)
|
|
71
|
+
- "Good for" description
|
|
72
|
+
- Color scheme
|
|
73
|
+
- Preview link: `https://www.wix.com/website-template/view/html/{templateSlug}`
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Step 3: Create the Site
|
|
78
|
+
|
|
79
|
+
**Endpoint**: `POST https://www.wixapis.com/msm/v1/meta-site/create-from-template`
|
|
80
|
+
|
|
81
|
+
**Request Body**:
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"originTemplateId": "<TEMPLATE_METASITE_ID>",
|
|
85
|
+
"siteName": "my-new-site"
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**Request**:
|
|
90
|
+
```bash
|
|
91
|
+
curl -X POST \
|
|
92
|
+
'https://www.wixapis.com/msm/v1/meta-site/create-from-template' \
|
|
93
|
+
-H 'Authorization: <AUTH>' \
|
|
94
|
+
-H 'Content-Type: application/json' \
|
|
95
|
+
-d '{
|
|
96
|
+
"originTemplateId": "<TEMPLATE_ID>",
|
|
97
|
+
"siteName": "my-new-site"
|
|
98
|
+
}'
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Site Name Requirements
|
|
102
|
+
|
|
103
|
+
The `siteName` must follow these rules:
|
|
104
|
+
- 4-20 characters
|
|
105
|
+
- Only lowercase letters, numbers, hyphens, underscores
|
|
106
|
+
- Pattern: `[a-z0-9_-]{4,20}`
|
|
107
|
+
- Must be unique
|
|
108
|
+
|
|
109
|
+
If `siteName` is not provided, one is generated automatically.
|
|
110
|
+
|
|
111
|
+
### For Headless Sites
|
|
112
|
+
|
|
113
|
+
Add `"namespace": "HEADLESS"` to the request body:
|
|
114
|
+
|
|
115
|
+
```json
|
|
116
|
+
{
|
|
117
|
+
"originTemplateId": "<TEMPLATE_ID>",
|
|
118
|
+
"siteName": "my-headless-site",
|
|
119
|
+
"namespace": "HEADLESS"
|
|
120
|
+
}
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
**Response** includes the new site's `metaSiteId`.
|
|
124
|
+
|
|
125
|
+
### IMPORTANT NOTES:
|
|
126
|
+
- Only mention headless if user specifically requests it
|
|
127
|
+
- If user doesn't ask for headless, do NOT include the `namespace` field
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## Step 4: Publish the Site (Optional)
|
|
132
|
+
|
|
133
|
+
**Ask the user** if they want to publish their site before proceeding.
|
|
134
|
+
|
|
135
|
+
**Endpoint**: `POST https://www.wixapis.com/site-publisher/v1/site/publish`
|
|
136
|
+
|
|
137
|
+
This is a **site-level API** - use the site ID from the creation response.
|
|
138
|
+
|
|
139
|
+
**Request**:
|
|
140
|
+
```bash
|
|
141
|
+
curl -X POST \
|
|
142
|
+
'https://www.wixapis.com/site-publisher/v1/site/publish' \
|
|
143
|
+
-H 'Authorization: <AUTH>' \
|
|
144
|
+
-H 'Content-Type: application/json' \
|
|
145
|
+
-d '{}'
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### IMPORTANT NOTES:
|
|
149
|
+
- NEVER publish without asking the user first
|
|
150
|
+
- This makes the site publicly accessible
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
## Step 5: For Headless Sites - Create OAuth App
|
|
155
|
+
|
|
156
|
+
If the site was created as headless, you MUST create an OAuth app for authentication.
|
|
157
|
+
|
|
158
|
+
See [Create OAuth App](https://dev.wix.com/docs/api-reference/business-management/headless/oauth-apps/create-oauth-app) documentation.
|
|
159
|
+
|
|
160
|
+
This is a site-level call in the context of the newly created site.
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## Common Template IDs
|
|
165
|
+
|
|
166
|
+
For quick access without searching:
|
|
167
|
+
|
|
168
|
+
| Type | Template ID |
|
|
169
|
+
|------|-------------|
|
|
170
|
+
| Blank (Studio) | `fe86a14e-ef67-49b4-a409-d086f3abaa1a` |
|
|
171
|
+
| Blank (Editor) | `b55bdf43-95e0-4cef-b9bb-92dcc7af2742` |
|
|
172
|
+
| Store | `b783f9f9-4f4d-4139-9659-cc95a51b9ee5` |
|
|
173
|
+
| Bookings/Services | `17b2bf9e-8661-4c92-973c-67502b415e58` |
|
|
174
|
+
| Beauty | `0281d415-0682-42ac-b35e-49b349f19332` |
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## Next Steps
|
|
179
|
+
|
|
180
|
+
After creating the site:
|
|
181
|
+
- Install required apps using [Install Wix Apps](../app-installation/install-wix-apps.md)
|
|
182
|
+
- Configure site settings
|
|
183
|
+
- Add content (products, services, blog posts, etc.)
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Query Sites"
|
|
3
|
+
description: Lists and queries all sites associated with a Wix account using Sites API. Covers pagination with cursor-based navigation.
|
|
4
|
+
---
|
|
5
|
+
# Query Sites
|
|
6
|
+
|
|
7
|
+
This recipe demonstrates how to list and query all sites associated with a Wix account.
|
|
8
|
+
|
|
9
|
+
## Prerequisites
|
|
10
|
+
|
|
11
|
+
- Account-level API access
|
|
12
|
+
- Authorization for site listing permissions
|
|
13
|
+
|
|
14
|
+
## Required APIs
|
|
15
|
+
|
|
16
|
+
- **Query Sites API**: [REST](https://dev.wix.com/docs/api-reference/account-level/sites/sites/query-sites)
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Query All Sites
|
|
21
|
+
|
|
22
|
+
**Endpoint**: `POST https://www.wixapis.com/site-list/v2/sites/query`
|
|
23
|
+
|
|
24
|
+
**Request Body**:
|
|
25
|
+
```json
|
|
26
|
+
{
|
|
27
|
+
"query": {
|
|
28
|
+
"cursorPaging": {
|
|
29
|
+
"limit": 50
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Request**:
|
|
36
|
+
```bash
|
|
37
|
+
curl -X POST \
|
|
38
|
+
'https://www.wixapis.com/site-list/v2/sites/query' \
|
|
39
|
+
-H 'Authorization: <AUTH>' \
|
|
40
|
+
-H 'Content-Type: application/json' \
|
|
41
|
+
-d '{
|
|
42
|
+
"query": {
|
|
43
|
+
"cursorPaging": {
|
|
44
|
+
"limit": 50
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}'
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Response Structure
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
{
|
|
56
|
+
"sites": [
|
|
57
|
+
{
|
|
58
|
+
"id": "site-id-123",
|
|
59
|
+
"name": "My Website",
|
|
60
|
+
"displayName": "My Website",
|
|
61
|
+
"siteUrl": "https://username.wixsite.com/mywebsite",
|
|
62
|
+
"published": true,
|
|
63
|
+
"createdDate": "2024-01-15T10:30:00Z",
|
|
64
|
+
"updatedDate": "2024-06-20T14:45:00Z"
|
|
65
|
+
}
|
|
66
|
+
],
|
|
67
|
+
"pagingMetadata": {
|
|
68
|
+
"count": 50,
|
|
69
|
+
"cursors": {
|
|
70
|
+
"next": "cursor-for-next-page"
|
|
71
|
+
},
|
|
72
|
+
"hasNext": true
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Pagination
|
|
80
|
+
|
|
81
|
+
For accounts with many sites, use cursor-based pagination:
|
|
82
|
+
|
|
83
|
+
**First Request**:
|
|
84
|
+
```json
|
|
85
|
+
{
|
|
86
|
+
"query": {
|
|
87
|
+
"cursorPaging": {
|
|
88
|
+
"limit": 50
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
**Next Page** (using cursor from response):
|
|
95
|
+
```json
|
|
96
|
+
{
|
|
97
|
+
"query": {
|
|
98
|
+
"cursorPaging": {
|
|
99
|
+
"limit": 50,
|
|
100
|
+
"cursor": "<cursor-from-previous-response>"
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Continue until `hasNext` is `false`.
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## Common Use Cases
|
|
111
|
+
|
|
112
|
+
### List All Sites
|
|
113
|
+
Retrieve all sites without filtering - useful for account dashboards or site selection interfaces.
|
|
114
|
+
|
|
115
|
+
### Find a Specific Site
|
|
116
|
+
After querying, filter results by name or ID to locate a specific site.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Next Steps
|
|
121
|
+
|
|
122
|
+
After finding a site:
|
|
123
|
+
- Use the site ID for site-level API calls
|
|
124
|
+
- Create new sites using [Create Site from Template](create-site-from-template.md)
|
|
125
|
+
- Manage site settings and content
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Add Store Pages to Site"
|
|
3
|
+
description: Adds missing checkout and cart pages to a site when Stores app is installed. Used when store pages are missing after migration or setup issues.
|
|
4
|
+
---
|
|
5
|
+
# Add Store Pages to Site
|
|
6
|
+
|
|
7
|
+
This recipe demonstrates how to add checkout and cart pages to a Wix site when the Stores app is installed but pages are missing.
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
When Wix Stores is installed on a site, it should automatically create cart and checkout pages. However, in some cases these pages may be missing. This recipe provides a way to add them programmatically.
|
|
12
|
+
|
|
13
|
+
## Prerequisites
|
|
14
|
+
|
|
15
|
+
- Wix Stores app installed on the site
|
|
16
|
+
- API access with site management permissions
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Step 1: Add Pages to Site
|
|
21
|
+
|
|
22
|
+
**Endpoint**: `POST https://www.wix.com/_api/add-pages-to-site/install`
|
|
23
|
+
|
|
24
|
+
**Request**:
|
|
25
|
+
```bash
|
|
26
|
+
curl -X POST \
|
|
27
|
+
'https://www.wix.com/_api/add-pages-to-site/install' \
|
|
28
|
+
-H 'Authorization: <AUTH>' \
|
|
29
|
+
-H 'Content-Type: application/json' \
|
|
30
|
+
-d '{}'
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
**Response**: Empty body on success.
|
|
34
|
+
|
|
35
|
+
### IMPORTANT NOTES:
|
|
36
|
+
- This endpoint adds missing store pages (cart, checkout) if they don't exist
|
|
37
|
+
- The request body is empty - no parameters needed
|
|
38
|
+
- Only required Authorization header
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## When to Use This Recipe
|
|
43
|
+
|
|
44
|
+
Use this recipe when:
|
|
45
|
+
- Checkout flow fails because checkout page is missing
|
|
46
|
+
- Cart functionality doesn't work
|
|
47
|
+
- Store was migrated or had page issues
|
|
48
|
+
- You receive errors about missing store pages
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Next Steps
|
|
53
|
+
|
|
54
|
+
After adding pages:
|
|
55
|
+
- Verify checkout flow works by creating a test order
|
|
56
|
+
- Customize page designs if needed via the Editor
|
|
57
|
+
- Set up payment methods if not already configured
|