@wix/agent-skills 1.5.0 → 1.7.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/README.md +2 -2
- package/package.json +1 -1
- package/skills/wix-app/SKILL.md +49 -42
- package/skills/wix-app/references/BACKEND_EVENT.md +10 -65
- package/skills/wix-app/references/CUSTOM_ELEMENT_WIDGET.md +101 -406
- package/skills/wix-app/references/DASHBOARD_MENU_PLUGIN.md +14 -111
- package/skills/wix-app/references/DASHBOARD_MODAL.md +56 -205
- package/skills/wix-app/references/DASHBOARD_PAGE.md +19 -98
- package/skills/wix-app/references/DASHBOARD_PLUGIN.md +6 -108
- package/skills/wix-app/references/DATA_COLLECTION.md +113 -198
- package/skills/wix-app/references/EDITOR_REACT_COMPONENT.md +15 -1
- package/skills/wix-app/references/EMBEDDED_SCRIPT.md +41 -268
- package/skills/wix-app/references/EXTENSION_REGISTRATION.md +27 -76
- package/skills/wix-app/references/SERVICE_PLUGIN.md +35 -188
- package/skills/wix-app/references/SITE_PLUGIN.md +8 -92
- package/skills/wix-app/references/backend-event/COMMON-EVENTS.md +0 -44
- package/skills/wix-app/references/custom-element-widget/SETTINGS_PANEL.md +19 -330
- package/skills/wix-app/references/dashboard-menu-plugin/bookings-slots.md +0 -12
- package/skills/wix-app/references/dashboard-menu-plugin/ecommerce-slots.md +7 -0
- package/skills/wix-app/references/dashboard-menu-plugin/restaurants-slots.md +0 -12
- package/skills/wix-app/references/dashboard-plugin/SLOTS.md +3 -15
- package/skills/wix-app/references/data-collection/WIX_DATA.md +1 -1
- package/skills/wix-app/references/editor-react-component/COMPONENT-API.md +1 -1
- package/skills/wix-app/references/service-plugin/ADDITIONAL-FEES.md +2 -18
- package/skills/wix-app/references/service-plugin/BOOKINGS-STAFF-SORTING.md +2 -42
- package/skills/wix-app/references/service-plugin/DISCOUNT-TRIGGERS.md +1 -11
- package/skills/wix-app/references/service-plugin/GIFT-CARDS.md +1 -11
- package/skills/wix-app/references/service-plugin/PAYMENT-SETTINGS.md +2 -40
- package/skills/wix-app/references/service-plugin/SHIPPING-RATES.md +2 -19
- package/skills/wix-app/references/service-plugin/VALIDATIONS.md +2 -18
- package/skills/wix-app/references/site-plugin/SLOTS.md +17 -68
- package/skills/wix-headless/SKILL.md +112 -368
- package/skills/wix-headless/references/BUILD.md +307 -0
- package/skills/wix-headless/references/DESIGN_SYSTEM.md +115 -0
- package/skills/wix-headless/references/DISCOVERY.md +237 -112
- package/skills/wix-headless/references/PLAN.md +82 -0
- package/skills/wix-headless/references/SEED.md +205 -0
- package/skills/wix-headless/references/SETUP.md +250 -94
- package/skills/wix-headless/references/astro/COMPOSE.md +142 -0
- package/skills/wix-headless/references/{blog → astro/blog}/BLOG_PAGES.md +1 -1
- package/skills/wix-headless/references/{blog → astro/blog}/BLOG_SETUP.md +2 -2
- package/skills/wix-headless/references/astro/cms/CMS_FOUNDATIONS.md +214 -0
- package/skills/wix-headless/references/{cms → astro/cms}/FAQ_KNOWLEDGE_BASE.md +6 -4
- package/skills/wix-headless/references/{cms → astro/cms}/PORTFOLIO.md +5 -5
- package/skills/wix-headless/references/{cms → astro/cms}/RESOURCE_LIBRARY.md +5 -5
- package/skills/wix-headless/references/{cms → astro/cms}/TEAM_DIRECTORY.md +5 -5
- package/skills/wix-headless/references/astro/designer/INSTRUCTIONS.md +331 -0
- package/skills/wix-headless/references/{ecom → astro/ecom}/CART_PAGES.md +1 -1
- package/skills/wix-headless/references/{ecom → astro/ecom}/CART_WIRING.md +1 -1
- package/skills/wix-headless/references/{ecom → astro/ecom}/COMPONENTS_CSS.md +3 -3
- package/skills/wix-headless/references/{forms → astro/forms}/CONTACT_FORM.md +13 -13
- package/skills/wix-headless/references/{gift-cards → astro/gift-cards}/COMPONENTS.md +1 -1
- package/skills/wix-headless/references/{gift-cards → astro/gift-cards}/PAGES.md +1 -1
- package/skills/wix-headless/references/{stores → astro/stores}/BACK_IN_STOCK.md +1 -1
- package/skills/wix-headless/references/{stores → astro/stores}/CATEGORY_PAGES.md +12 -13
- package/skills/wix-headless/references/{stores → astro/stores}/COMPONENTS_CSS.md +4 -4
- package/skills/wix-headless/references/{stores → astro/stores}/HOME_AND_NAV.md +11 -9
- package/skills/wix-headless/references/{stores → astro/stores}/PRODUCT_PAGES.md +5 -3
- package/skills/wix-headless/references/{stores → astro/stores}/SHARED_WIRING.md +3 -3
- package/skills/wix-headless/references/astro/templates/Footer.astro +27 -0
- package/skills/wix-headless/references/astro/templates/Layout.astro +132 -0
- package/skills/wix-headless/references/astro/templates/Navigation.astro +38 -0
- package/skills/wix-headless/references/astro/templates/astro.config.mjs +41 -0
- package/skills/wix-headless/references/astro/templates/ecom/components-ecom.css +302 -0
- package/skills/wix-headless/references/astro/templates/global.css +286 -0
- package/skills/wix-headless/references/astro/templates/index.astro +56 -0
- package/skills/wix-headless/{templates → references/astro/templates}/stores/back-in-stock.ts +1 -1
- package/skills/wix-headless/{templates → references/astro/templates}/stores/components-stores.css +138 -33
- package/skills/wix-headless/references/blog/BLOG_CONTENT.md +10 -11
- package/skills/wix-headless/references/blog/INSTRUCTIONS.md +5 -5
- package/skills/wix-headless/references/cms/CMS_FOUNDATIONS.md +31 -230
- package/skills/wix-headless/references/cms/INSTRUCTIONS.md +13 -8
- package/skills/wix-headless/references/custom/INSTRUCTIONS.md +38 -0
- package/skills/wix-headless/references/ecom/INSTRUCTIONS.md +10 -10
- package/skills/wix-headless/references/forms/INSTRUCTIONS.md +5 -5
- package/skills/wix-headless/references/gift-cards/INSTRUCTIONS.md +11 -11
- package/skills/wix-headless/references/images/INSTRUCTIONS.md +47 -50
- package/skills/wix-headless/references/seed-recipes.md +49 -0
- package/skills/wix-headless/references/shared/AUTHENTICATION.md +110 -0
- package/skills/wix-headless/references/shared/BUILD_NOISE.md +2 -2
- package/skills/wix-headless/references/shared/DOCS_SEARCH.md +41 -0
- package/skills/wix-headless/references/shared/IMAGE_GENERATION.md +17 -17
- package/skills/wix-headless/references/shared/IMPLEMENTER.md +20 -29
- package/skills/wix-headless/references/shared/PRODUCTION_SHARP_EDGES.md +1 -1
- package/skills/wix-headless/references/shared/RETURN_CONTRACT.md +25 -16
- package/skills/wix-headless/references/shared/STYLING.md +47 -10
- package/skills/wix-headless/references/stores/INSTRUCTIONS.md +25 -25
- package/skills/wix-headless/references/stores/PRODUCT_CATALOG_DATA.md +17 -17
- package/skills/wix-headless/references/verticals/_schema.json +31 -117
- package/skills/wix-headless/references/verticals/_schema.md +60 -150
- package/skills/wix-headless/references/verticals/blog.md +5 -99
- package/skills/wix-headless/references/verticals/cms.md +9 -100
- package/skills/wix-headless/references/verticals/ecom.md +5 -76
- package/skills/wix-headless/references/verticals/forms.md +5 -85
- package/skills/wix-headless/references/verticals/gift-cards.md +6 -103
- package/skills/wix-headless/references/verticals/stores.md +10 -144
- package/skills/wix-headless/scripts/check-manifest.mjs +5 -5
- package/skills/wix-headless/scripts/emit-design-tokens.mjs +29 -23
- package/skills/wix-headless/scripts/init-site-json.mjs +59 -21
- package/skills/wix-headless/scripts/patch-decorative-slots.mjs +67 -43
- package/skills/wix-headless/scripts/plan-entity-image-waves.mjs +3 -3
- package/skills/wix-headless/scripts/preview.sh +3 -3
- package/skills/wix-headless/scripts/release.sh +4 -4
- package/skills/wix-headless/scripts/scaffold.sh +75 -20
- package/skills/wix-headless/scripts/seed-utilities.sh +50 -12
- package/skills/wix-manage/SKILL.md +4 -8
- package/skills/wix-manage/references/blog/how-to-create-blog-posts.md +70 -1
- package/skills/wix-manage/references/cms/cms-data-items-crud.md +4 -0
- package/skills/wix-manage/references/cms/cms-references-and-relationships.md +2 -0
- package/skills/wix-manage/references/cms/cms-schema-management.md +4 -0
- package/skills/wix-manage/references/ecommerce/api-shipping.md +443 -0
- package/skills/wix-manage/references/ecommerce/flow-add-free-shipping.md +5 -6
- package/skills/wix-manage/references/ecommerce/flow-fix-coverage-gaps.md +4 -5
- package/skills/wix-manage/references/ecommerce/flow-optimize-shipping-rates.md +4 -5
- package/skills/wix-manage/references/ecommerce/goal-increase-aov.md +1 -1
- package/skills/wix-manage/references/ecommerce/goal-reduce-cart-abandonment.md +1 -2
- package/skills/wix-manage/references/ecommerce/guardrail-shipping-health.md +2 -2
- package/skills/wix-manage/references/ecommerce/recipe-apply-shipping-recommendations.md +4 -5
- package/skills/wix-manage/references/ecommerce/recommend-ecommerce-strategy.md +7 -7
- package/skills/wix-manage/references/ecommerce/setup-discount-rules.md +209 -72
- package/skills/wix-manage/references/ecommerce/setup-store-pickup-location.md +9 -10
- package/skills/wix-manage/references/ecommerce/skill-graph.md +4 -4
- package/skills/wix-manage/references/forms/create-form.md +2 -0
- package/skills/wix-manage/references/stores/bulk-create-products-with-options.md +2 -0
- package/skills/wix-manage/references/stores/create-product-from-image.md +91 -38
- package/skills/wix-manage/references/stores/setup-online-store-catalog-v3.md +14 -7
- package/skills/wix-app/references/data-collection/extension-template.ts +0 -107
- package/skills/wix-headless/references/ORCHESTRATION.md +0 -269
- package/skills/wix-headless/references/commands/install-app.md +0 -42
- package/skills/wix-headless/references/commands/mcp-bootstrap.md +0 -28
- package/skills/wix-headless/references/designer/INSTRUCTIONS.md +0 -828
- package/skills/wix-headless/references/shared/MCP_PREFIX.md +0 -105
- package/skills/wix-headless/scripts/copy-utility-templates.mjs +0 -153
- package/skills/wix-headless/templates/ecom/components-ecom.css +0 -215
- package/skills/wix-manage/references/events/list-events.md +0 -203
- /package/skills/wix-headless/{templates → references/astro/templates}/ecom/CartBadge.tsx +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/ecom/CartView.tsx +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/ecom/cart.astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/ecom/discounts.ts +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/ecom/thank-you.astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/gift-cards/GiftCardPurchase.tsx +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/gift-cards/_home-teaser-snippet.astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/gift-cards/_nav-snippet.astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/gift-cards/components-gift-cards.css +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/gift-cards/gift-cards.astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/gift-cards/gift-cards.ts +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/AddToCartButton.tsx +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/BackInStockForm.tsx +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/CategoryRail.astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/ProductCard.astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/ProductPurchase.tsx +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/SeoTags.astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/categories.ts +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/category/[slug].astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/products/[slug].astro +0 -0
- /package/skills/wix-headless/{templates → references/astro/templates}/stores/products/index.astro +0 -0
|
@@ -0,0 +1,443 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "API: Shipping Delivery"
|
|
3
|
+
description: REST API reference for Shipping Options and Delivery Profiles. Covers CRUD operations, region/carrier management, and query patterns for both services. Internal reference — these APIs are not yet published in public docs.
|
|
4
|
+
layer: config
|
|
5
|
+
---
|
|
6
|
+
# API: Shipping Delivery
|
|
7
|
+
|
|
8
|
+
Two services govern the shipping configuration of a Wix eCommerce store:
|
|
9
|
+
|
|
10
|
+
- **Delivery Profiles** — define geographic regions and which carriers serve each region. Each site has a default profile. Regions contain destinations (countries/subdivisions) and carriers.
|
|
11
|
+
- **Shipping Options** — define the rate entries customers see at checkout (flat, tiered, free). Each option is scoped to one or more delivery regions.
|
|
12
|
+
|
|
13
|
+
**Base URL**: `https://www.wixapis.com/ecom`
|
|
14
|
+
|
|
15
|
+
**How to call these APIs**: Use `CallWixSiteAPI`.
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Shipping Options
|
|
20
|
+
|
|
21
|
+
### Query Shipping Options
|
|
22
|
+
|
|
23
|
+
Retrieves all shipping options for the site. Up to 1,000 per request (cursor paging).
|
|
24
|
+
|
|
25
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/shipping-options/query`
|
|
26
|
+
|
|
27
|
+
**Request**:
|
|
28
|
+
```json
|
|
29
|
+
{
|
|
30
|
+
"query": {
|
|
31
|
+
"cursorPaging": { "limit": 100 }
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**Filterable fields**: `id`, `delivery_region_id`, `delivery_region_ids`, `estimated_delivery_time`, `created_date`, `updated_date`
|
|
37
|
+
|
|
38
|
+
**Response**:
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"shippingOptions": [
|
|
42
|
+
{
|
|
43
|
+
"id": "abc123",
|
|
44
|
+
"revision": "1",
|
|
45
|
+
"deliveryRegionId": "region-guid",
|
|
46
|
+
"deliveryRegionIds": ["region-guid"],
|
|
47
|
+
"title": "Standard Shipping",
|
|
48
|
+
"category": "STANDARD",
|
|
49
|
+
"estimatedDeliveryTime": "3-5 business days",
|
|
50
|
+
"rates": [
|
|
51
|
+
{
|
|
52
|
+
"id": "rate-guid",
|
|
53
|
+
"title": "Standard Shipping",
|
|
54
|
+
"amount": "5.99",
|
|
55
|
+
"multiplyByQuantity": false,
|
|
56
|
+
"active": true,
|
|
57
|
+
"conditions": []
|
|
58
|
+
}
|
|
59
|
+
]
|
|
60
|
+
}
|
|
61
|
+
],
|
|
62
|
+
"pagingMetadata": { "count": 1, "hasNext": false }
|
|
63
|
+
}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
### Create Shipping Option
|
|
69
|
+
|
|
70
|
+
Creates a new shipping option and associates it with one or more delivery regions.
|
|
71
|
+
|
|
72
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/shipping-options`
|
|
73
|
+
|
|
74
|
+
**Required fields**: `shippingOption.deliveryRegionId` (or `deliveryRegionIds`), `shippingOption.title`, `shippingOption.rates[]`
|
|
75
|
+
|
|
76
|
+
**Request**:
|
|
77
|
+
```json
|
|
78
|
+
{
|
|
79
|
+
"shippingOption": {
|
|
80
|
+
"deliveryRegionId": "region-guid",
|
|
81
|
+
"title": "Free Shipping Over $75",
|
|
82
|
+
"category": "FREE",
|
|
83
|
+
"estimatedDeliveryTime": "5-7 business days",
|
|
84
|
+
"rates": [
|
|
85
|
+
{
|
|
86
|
+
"title": "Free Shipping",
|
|
87
|
+
"amount": "0",
|
|
88
|
+
"multiplyByQuantity": false,
|
|
89
|
+
"active": true,
|
|
90
|
+
"conditions": [
|
|
91
|
+
{
|
|
92
|
+
"type": "BY_TOTAL_PRICE",
|
|
93
|
+
"operator": "GTE",
|
|
94
|
+
"value": "75"
|
|
95
|
+
}
|
|
96
|
+
]
|
|
97
|
+
}
|
|
98
|
+
]
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
**Response**: `{ "shippingOption": { ... } }` — the created option with `id` and `revision`.
|
|
104
|
+
|
|
105
|
+
**Error**: `INVALID_QUANTITY_VALUE` (400) — condition value cannot be fractional.
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
### Get Shipping Option
|
|
110
|
+
|
|
111
|
+
Retrieves a single shipping option by ID.
|
|
112
|
+
|
|
113
|
+
**Endpoint**: `GET https://www.wixapis.com/ecom/v1/shipping-options/{shippingOptionId}`
|
|
114
|
+
|
|
115
|
+
**Response**: `{ "shippingOption": { ... } }`
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
### Update Shipping Option
|
|
120
|
+
|
|
121
|
+
Updates a shipping option. Requires `id` and the current `revision`. Each update increments `revision`.
|
|
122
|
+
|
|
123
|
+
**Endpoint**: `PATCH https://www.wixapis.com/ecom/v1/shipping-options/{shippingOption.id}`
|
|
124
|
+
|
|
125
|
+
**Required fields**: `shippingOption.id`, `shippingOption.revision`
|
|
126
|
+
|
|
127
|
+
**Request**:
|
|
128
|
+
```json
|
|
129
|
+
{
|
|
130
|
+
"shippingOption": {
|
|
131
|
+
"id": "abc123",
|
|
132
|
+
"revision": "1",
|
|
133
|
+
"rates": [
|
|
134
|
+
{
|
|
135
|
+
"id": "rate-guid",
|
|
136
|
+
"title": "Free Shipping",
|
|
137
|
+
"amount": "0",
|
|
138
|
+
"multiplyByQuantity": false,
|
|
139
|
+
"active": true,
|
|
140
|
+
"conditions": [
|
|
141
|
+
{
|
|
142
|
+
"type": "BY_TOTAL_PRICE",
|
|
143
|
+
"operator": "GTE",
|
|
144
|
+
"value": "85"
|
|
145
|
+
}
|
|
146
|
+
]
|
|
147
|
+
}
|
|
148
|
+
]
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
**Response**: `{ "shippingOption": { ... } }` with updated `revision`.
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
### Delete Shipping Option
|
|
158
|
+
|
|
159
|
+
Permanently deletes a shipping option.
|
|
160
|
+
|
|
161
|
+
**Endpoint**: `DELETE https://www.wixapis.com/ecom/v1/shipping-options/{shippingOptionId}`
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
### Add Delivery Region (to Shipping Option)
|
|
166
|
+
|
|
167
|
+
Associates an additional delivery region with an existing shipping option.
|
|
168
|
+
|
|
169
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/shipping-options/{shippingOptionId}/add-delivery-region`
|
|
170
|
+
|
|
171
|
+
**Required fields**: `deliveryRegionId`, `revision`
|
|
172
|
+
|
|
173
|
+
**Request**:
|
|
174
|
+
```json
|
|
175
|
+
{
|
|
176
|
+
"deliveryRegionId": "region-guid",
|
|
177
|
+
"revision": "2"
|
|
178
|
+
}
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
### Remove Delivery Region (from Shipping Option)
|
|
184
|
+
|
|
185
|
+
Removes a delivery region association from a shipping option.
|
|
186
|
+
|
|
187
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/shipping-options/{shippingOptionId}/remove-delivery-region`
|
|
188
|
+
|
|
189
|
+
**Required fields**: `deliveryRegionId`, `revision`
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## Rate Configuration
|
|
194
|
+
|
|
195
|
+
Rate types are determined by the `conditions` array, not an explicit field:
|
|
196
|
+
|
|
197
|
+
| Rate Type | `amount` | `conditions` |
|
|
198
|
+
|-----------|---------|-------------|
|
|
199
|
+
| Flat rate | any | empty `[]` |
|
|
200
|
+
| Free shipping | `"0"` | optional `BY_TOTAL_PRICE GTE <threshold>` |
|
|
201
|
+
| Price-based tiers | any | one or more `BY_TOTAL_PRICE` conditions |
|
|
202
|
+
| Weight-based tiers | any | `BY_TOTAL_WEIGHT` conditions |
|
|
203
|
+
| Quantity-based | any | `BY_TOTAL_QUANTITY` conditions |
|
|
204
|
+
|
|
205
|
+
**Condition operators**: `EQ`, `GT`, `GTE`, `LT`, `LTE`
|
|
206
|
+
|
|
207
|
+
Multiple conditions in one rate combine with AND logic.
|
|
208
|
+
|
|
209
|
+
**`multiplyByQuantity: true`** charges `amount × cart quantity`. Flag this configuration — it penalizes large orders and should be replaced with flat or tiered pricing.
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## Delivery Profiles
|
|
214
|
+
|
|
215
|
+
### Query Delivery Profiles
|
|
216
|
+
|
|
217
|
+
Retrieves all delivery profiles for the site. Typically one default profile exists.
|
|
218
|
+
|
|
219
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/delivery-profiles/query`
|
|
220
|
+
|
|
221
|
+
**Request**: `{}`
|
|
222
|
+
|
|
223
|
+
**Response**:
|
|
224
|
+
```json
|
|
225
|
+
{
|
|
226
|
+
"deliveryProfiles": [
|
|
227
|
+
{
|
|
228
|
+
"id": "profile-guid",
|
|
229
|
+
"revision": "3",
|
|
230
|
+
"name": "General profile",
|
|
231
|
+
"default": true,
|
|
232
|
+
"deliveryRegions": [
|
|
233
|
+
{
|
|
234
|
+
"id": "region-guid",
|
|
235
|
+
"name": "United States",
|
|
236
|
+
"active": true,
|
|
237
|
+
"destinations": [
|
|
238
|
+
{ "countryCode": "US", "subdivisions": [] }
|
|
239
|
+
],
|
|
240
|
+
"deliveryCarriers": [
|
|
241
|
+
{
|
|
242
|
+
"appId": "45c44b27-ca7b-4891-8c0d-1747d588b835",
|
|
243
|
+
"backupRate": {
|
|
244
|
+
"title": "Standard Shipping",
|
|
245
|
+
"amount": "5.99",
|
|
246
|
+
"active": true
|
|
247
|
+
},
|
|
248
|
+
"additionalCharges": []
|
|
249
|
+
}
|
|
250
|
+
]
|
|
251
|
+
}
|
|
252
|
+
]
|
|
253
|
+
}
|
|
254
|
+
]
|
|
255
|
+
}
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
---
|
|
259
|
+
|
|
260
|
+
### Get Delivery Profile
|
|
261
|
+
|
|
262
|
+
Retrieves a single delivery profile by ID.
|
|
263
|
+
|
|
264
|
+
**Endpoint**: `GET https://www.wixapis.com/ecom/v1/delivery-profiles/{deliveryProfileId}`
|
|
265
|
+
|
|
266
|
+
**Response**: `{ "deliveryProfile": { ... } }`
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
### Get Delivery Profile by Region
|
|
271
|
+
|
|
272
|
+
Retrieves the profile that contains a given delivery region.
|
|
273
|
+
|
|
274
|
+
**Endpoint**: `GET https://www.wixapis.com/ecom/v1/delivery-profiles/delivery-regions/{deliveryRegionId}`
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
### Create Delivery Profile
|
|
279
|
+
|
|
280
|
+
Creates a new delivery profile (rarely needed — most sites use the default profile).
|
|
281
|
+
|
|
282
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/delivery-profiles`
|
|
283
|
+
|
|
284
|
+
---
|
|
285
|
+
|
|
286
|
+
### Update Delivery Profile
|
|
287
|
+
|
|
288
|
+
Updates profile-level fields (name, etc.). Requires current `revision`.
|
|
289
|
+
|
|
290
|
+
**Endpoint**: `PATCH https://www.wixapis.com/ecom/v1/delivery-profiles/{deliveryProfile.id}`
|
|
291
|
+
|
|
292
|
+
---
|
|
293
|
+
|
|
294
|
+
### Add Delivery Region
|
|
295
|
+
|
|
296
|
+
Adds a geographic region to a delivery profile. Returns the updated profile with the new region's `id`.
|
|
297
|
+
|
|
298
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/delivery-profiles/{deliveryProfileId}/delivery-region`
|
|
299
|
+
|
|
300
|
+
**Required fields**: `deliveryRegion.name`, `deliveryRegion.destinations[]`, `revision`
|
|
301
|
+
|
|
302
|
+
**Request**:
|
|
303
|
+
```json
|
|
304
|
+
{
|
|
305
|
+
"deliveryRegion": {
|
|
306
|
+
"name": "United States",
|
|
307
|
+
"active": true,
|
|
308
|
+
"destinations": [
|
|
309
|
+
{ "countryCode": "US" }
|
|
310
|
+
]
|
|
311
|
+
},
|
|
312
|
+
"revision": "3"
|
|
313
|
+
}
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
**Response**: `{ "deliveryProfile": { ... } }` — full updated profile with new region `id`.
|
|
317
|
+
|
|
318
|
+
**Error**: `DESTINATIONS_COLLISION` — country already assigned to another region in this profile. Use the existing region instead.
|
|
319
|
+
|
|
320
|
+
---
|
|
321
|
+
|
|
322
|
+
### Update Delivery Region
|
|
323
|
+
|
|
324
|
+
Updates name, active status, or destinations of an existing region.
|
|
325
|
+
|
|
326
|
+
**Endpoint**: `PATCH https://www.wixapis.com/ecom/v1/delivery-profiles/{deliveryProfileId}/delivery-region/{deliveryRegion.id}`
|
|
327
|
+
|
|
328
|
+
---
|
|
329
|
+
|
|
330
|
+
### Remove Delivery Region
|
|
331
|
+
|
|
332
|
+
Removes a delivery region from a profile.
|
|
333
|
+
|
|
334
|
+
**Endpoint**: `DELETE https://www.wixapis.com/ecom/v1/delivery-profiles/{deliveryProfileId}/delivery-region/{deliveryRegionId}`
|
|
335
|
+
|
|
336
|
+
---
|
|
337
|
+
|
|
338
|
+
### List Installed Delivery Carriers
|
|
339
|
+
|
|
340
|
+
Returns all carriers installed on the site (both built-in and third-party apps). Use this to find the `id` of a specific carrier (e.g., Pickup, Basic Shipping) before calling Add Delivery Carrier.
|
|
341
|
+
|
|
342
|
+
**Endpoint**: `GET https://www.wixapis.com/ecom/v1/delivery-profiles/installed-carriers`
|
|
343
|
+
|
|
344
|
+
**Response**:
|
|
345
|
+
```json
|
|
346
|
+
{
|
|
347
|
+
"installedDeliveryCarriers": [
|
|
348
|
+
{
|
|
349
|
+
"id": "50d8c12f-715e-41ad-be25-d0f61375dbee",
|
|
350
|
+
"displayName": "Pickup",
|
|
351
|
+
"fallbackDefinitionMandatory": false,
|
|
352
|
+
"toggleGetCarrierSettingsEnabled": true
|
|
353
|
+
},
|
|
354
|
+
{
|
|
355
|
+
"id": "45c44b27-ca7b-4891-8c0d-1747d588b835",
|
|
356
|
+
"displayName": "Basic Shipping",
|
|
357
|
+
"description": "Manage shipping rates and options for this region",
|
|
358
|
+
"fallbackDefinitionMandatory": false,
|
|
359
|
+
"toggleGetCarrierSettingsEnabled": true
|
|
360
|
+
}
|
|
361
|
+
]
|
|
362
|
+
}
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
---
|
|
366
|
+
|
|
367
|
+
### List Delivery Carriers (in a Profile)
|
|
368
|
+
|
|
369
|
+
Lists the carriers configured within a specific delivery profile.
|
|
370
|
+
|
|
371
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/delivery-profiles/{deliveryProfileId}/delivery-carriers`
|
|
372
|
+
|
|
373
|
+
---
|
|
374
|
+
|
|
375
|
+
### Add Delivery Carrier
|
|
376
|
+
|
|
377
|
+
Adds a carrier to a delivery region within a profile. The carrier appears as a shipping option to customers in that region.
|
|
378
|
+
|
|
379
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/delivery-profiles/add-delivery-carrier`
|
|
380
|
+
|
|
381
|
+
**Request**:
|
|
382
|
+
```json
|
|
383
|
+
{
|
|
384
|
+
"deliveryRegionId": "region-guid",
|
|
385
|
+
"deliveryCarrier": {
|
|
386
|
+
"appId": "50d8c12f-715e-41ad-be25-d0f61375dbee",
|
|
387
|
+
"backupRate": {
|
|
388
|
+
"title": "Pickup at 123 Main St",
|
|
389
|
+
"amount": "0",
|
|
390
|
+
"active": true
|
|
391
|
+
}
|
|
392
|
+
}
|
|
393
|
+
}
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
**Response**: `{ "deliveryProfile": { ... } }` — full updated profile.
|
|
397
|
+
|
|
398
|
+
**Errors**:
|
|
399
|
+
| Error | Cause |
|
|
400
|
+
|-------|-------|
|
|
401
|
+
| `CARRIER_ALREADY_EXISTS_IN_REGION` | Carrier already in this region |
|
|
402
|
+
| `DELIVERY_CARRIER_MISSING_BACKUP_RATE` | `backupRate` or `backupRate.amount` missing |
|
|
403
|
+
|
|
404
|
+
---
|
|
405
|
+
|
|
406
|
+
### Remove Delivery Carrier
|
|
407
|
+
|
|
408
|
+
Removes a carrier from a delivery region.
|
|
409
|
+
|
|
410
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/delivery-profiles/remove-delivery-carrier`
|
|
411
|
+
|
|
412
|
+
**Request**:
|
|
413
|
+
```json
|
|
414
|
+
{
|
|
415
|
+
"deliveryRegionId": "region-guid",
|
|
416
|
+
"appId": "carrier-app-id"
|
|
417
|
+
}
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
---
|
|
421
|
+
|
|
422
|
+
### Update Delivery Carrier
|
|
423
|
+
|
|
424
|
+
Updates `backupRate` or `additionalCharges` for a carrier in a region.
|
|
425
|
+
|
|
426
|
+
**Endpoint**: `PATCH https://www.wixapis.com/ecom/v1/delivery-profiles/update-delivery-carrier`
|
|
427
|
+
|
|
428
|
+
---
|
|
429
|
+
|
|
430
|
+
### Set Delivery Carrier Active Status
|
|
431
|
+
|
|
432
|
+
Activates or deactivates a carrier in a delivery region.
|
|
433
|
+
|
|
434
|
+
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/delivery-profiles/delivery-carriers/set-active-status`
|
|
435
|
+
|
|
436
|
+
---
|
|
437
|
+
|
|
438
|
+
## Known Carrier IDs
|
|
439
|
+
|
|
440
|
+
| Carrier | App ID |
|
|
441
|
+
|---------|--------|
|
|
442
|
+
| Basic Shipping | `45c44b27-ca7b-4891-8c0d-1747d588b835` |
|
|
443
|
+
| Pickup | `50d8c12f-715e-41ad-be25-d0f61375dbee` |
|
|
@@ -27,10 +27,10 @@ Adds a free shipping option with an optimal threshold calibrated against the sit
|
|
|
27
27
|
|
|
28
28
|
## Required APIs
|
|
29
29
|
|
|
30
|
-
- [Query Shipping Options](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
31
|
-
- [Create Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
32
|
-
- [Update Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
33
|
-
- [Query Delivery Profiles](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
30
|
+
- [Query Shipping Options](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#query-shipping-options)
|
|
31
|
+
- [Create Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#create-shipping-option)
|
|
32
|
+
- [Update Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#update-shipping-option)
|
|
33
|
+
- [Query Delivery Profiles](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#query-delivery-profiles)
|
|
34
34
|
|
|
35
35
|
---
|
|
36
36
|
|
|
@@ -263,5 +263,4 @@ Report to the merchant:
|
|
|
263
263
|
|
|
264
264
|
## References
|
|
265
265
|
|
|
266
|
-
- [
|
|
267
|
-
- [Shipping Options API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/shipping-options/introduction)
|
|
266
|
+
- [API: Shipping Delivery](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping)
|
|
@@ -26,9 +26,9 @@ Detects delivery regions where customers cannot see any shipping options at chec
|
|
|
26
26
|
|
|
27
27
|
## Required APIs
|
|
28
28
|
|
|
29
|
-
- [Query Delivery Profiles](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
30
|
-
- [Query Shipping Options](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
31
|
-
- [Create Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
29
|
+
- [Query Delivery Profiles](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#query-delivery-profiles)
|
|
30
|
+
- [Query Shipping Options](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#query-shipping-options)
|
|
31
|
+
- [Create Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#create-shipping-option)
|
|
32
32
|
|
|
33
33
|
---
|
|
34
34
|
|
|
@@ -296,5 +296,4 @@ Use the same request from Step 2 and verify the count now covers all active, non
|
|
|
296
296
|
|
|
297
297
|
## References
|
|
298
298
|
|
|
299
|
-
- [
|
|
300
|
-
- [Shipping Options API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/shipping-options/introduction)
|
|
299
|
+
- [API: Shipping Delivery](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping)
|
|
@@ -27,9 +27,9 @@ Analyzes the site's catalog price distribution and current shipping rate structu
|
|
|
27
27
|
|
|
28
28
|
## Required APIs
|
|
29
29
|
|
|
30
|
-
- [Query Shipping Options](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
31
|
-
- [Update Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
32
|
-
- [Create Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
30
|
+
- [Query Shipping Options](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#query-shipping-options)
|
|
31
|
+
- [Update Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#update-shipping-option)
|
|
32
|
+
- [Create Shipping Option](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#create-shipping-option)
|
|
33
33
|
|
|
34
34
|
---
|
|
35
35
|
|
|
@@ -360,5 +360,4 @@ Verify:
|
|
|
360
360
|
|
|
361
361
|
## References
|
|
362
362
|
|
|
363
|
-
- [Shipping
|
|
364
|
-
- [Delivery Profiles API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/introduction)
|
|
363
|
+
- [API: Shipping Delivery](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping)
|
|
@@ -25,7 +25,7 @@ references:
|
|
|
25
25
|
> - [Flow: Upsell Boost](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/flow-upsell-boost)
|
|
26
26
|
> - [Flow: Bundle and Save](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/flow-bundle-and-save)
|
|
27
27
|
>
|
|
28
|
-
> **Shipping flows that also serve AOV goals** (
|
|
28
|
+
> **Shipping flows that also serve AOV goals** (load if shipping domain is active):
|
|
29
29
|
> - [Flow: Add Free Shipping](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/flow-add-free-shipping) — free shipping threshold pushes carts above AOV
|
|
30
30
|
> - [Flow: Optimize Shipping Rates](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/flow-optimize-shipping-rates) — rate optimization improves conversion on higher-value orders
|
|
31
31
|
>
|
|
@@ -15,11 +15,10 @@ references:
|
|
|
15
15
|
---
|
|
16
16
|
# Goal: Reduce Cart Abandonment
|
|
17
17
|
|
|
18
|
-
> **Related skills
|
|
18
|
+
> **Related skills**:
|
|
19
19
|
> - [Flow: Fix Coverage Gaps](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/flow-fix-coverage-gaps) — shipping coverage gaps block checkout entirely
|
|
20
20
|
> - [Recipe: Apply Shipping Recommendations](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/recipe-apply-shipping-recommendations)
|
|
21
21
|
> - [Setup Store Pickup Location](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/setup-store-pickup-location)
|
|
22
|
-
> - [Setup Store Pickup Location](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/setup-store-pickup-location)
|
|
23
22
|
|
|
24
23
|
Reduce checkout abandonment caused by shipping friction — coverage gaps, unexpected costs, and missing free shipping options — by optimizing the delivery step of the checkout funnel.
|
|
25
24
|
|
|
@@ -9,8 +9,8 @@ references:
|
|
|
9
9
|
---
|
|
10
10
|
# Guardrail: Shipping Health
|
|
11
11
|
|
|
12
|
-
> **Related skills
|
|
13
|
-
> - [Troubleshoot: Checkout Delivery Drop-off](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/troubleshoot-checkout-delivery-
|
|
12
|
+
> **Related skills**:
|
|
13
|
+
> - [Troubleshoot: Checkout Delivery Drop-off](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/troubleshoot-checkout-delivery-dropoff)
|
|
14
14
|
|
|
15
15
|
## When to use
|
|
16
16
|
|
|
@@ -11,14 +11,14 @@ description: Applies AI-generated shipping recommendations to a Wix e-commerce s
|
|
|
11
11
|
|
|
12
12
|
## Required APIs
|
|
13
13
|
|
|
14
|
-
- [Query Delivery Profiles](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
15
|
-
- [Get Delivery Profile](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
14
|
+
- [Query Delivery Profiles](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#query-delivery-profiles)
|
|
15
|
+
- [Get Delivery Profile](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#get-delivery-profile)
|
|
16
16
|
|
|
17
17
|
---
|
|
18
18
|
|
|
19
19
|
## Step 1: Query the current shipping configuration
|
|
20
20
|
|
|
21
|
-
Call [Query Delivery Profiles](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/
|
|
21
|
+
Call [Query Delivery Profiles](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping#query-delivery-profiles) to understand the site's delivery setup — profiles, regions, carriers, and backup rates.
|
|
22
22
|
|
|
23
23
|
**Endpoint**: `POST https://www.wixapis.com/ecom/v1/delivery-profiles/query`
|
|
24
24
|
|
|
@@ -295,5 +295,4 @@ After applying recommendations, query shipping options again (Step 2) to confirm
|
|
|
295
295
|
|
|
296
296
|
## References
|
|
297
297
|
|
|
298
|
-
- [
|
|
299
|
-
- [Shipping Options API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/shipping-options/introduction)
|
|
298
|
+
- [API: Shipping Delivery](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/skills/api-shipping)
|
|
@@ -106,9 +106,9 @@ CallWixSiteAPI(
|
|
|
106
106
|
"fields": [
|
|
107
107
|
"language",
|
|
108
108
|
"merchant_business_country",
|
|
109
|
-
"
|
|
110
|
-
"
|
|
111
|
-
"
|
|
109
|
+
"suggested_main_industry",
|
|
110
|
+
"suggested_sub_industry",
|
|
111
|
+
"last_30_days_distinct_visitors",
|
|
112
112
|
"last_30_days_orders_count",
|
|
113
113
|
"online_gpv_last_30_days",
|
|
114
114
|
"payment_currency"
|
|
@@ -123,9 +123,9 @@ CallWixSiteAPI(
|
|
|
123
123
|
|---|---|---|---|
|
|
124
124
|
| `language` | STRING | Wix site language code | Locale-aware recommendations |
|
|
125
125
|
| `merchant_business_country` | STRING | Merchant's business country (ISO alpha-2) | Holiday detection, region analysis, shipping |
|
|
126
|
-
| `
|
|
127
|
-
| `
|
|
128
|
-
| `
|
|
126
|
+
| `suggested_main_industry` | STRING | Dominant industry in last 30 days (user growth model) | Domain classification, goal selection |
|
|
127
|
+
| `suggested_sub_industry` | STRING | Dominant sub-industry in last 30 days | Domain classification |
|
|
128
|
+
| `last_30_days_distinct_visitors` | LONG | Distinct visitors in last 30 days (incl. app sessions) | Traffic-based thresholds |
|
|
129
129
|
| `last_30_days_orders_count` | LONG | Order count in last 30 days | AOV calculation, goal selection |
|
|
130
130
|
| `online_gpv_last_30_days` | LONG | Online Gross Payment Volume in last 30 days (site currency units) | Revenue analysis, AOV calculation |
|
|
131
131
|
| `payment_currency` | STRING | Store payment currency code (ISO-4217) | Discount/shipping amount formatting |
|
|
@@ -153,7 +153,7 @@ Extracting values:
|
|
|
153
153
|
|
|
154
154
|
**Currency rule:** All monetary values (`online_gpv_last_30_days`, `aov`, discount thresholds, shipping amounts) are in the site's `payment_currency`. Never assume USD. Always display and compute amounts using `payment_currency`.
|
|
155
155
|
|
|
156
|
-
**STOP if `merchant_business_country`, `
|
|
156
|
+
**STOP if `merchant_business_country`, `suggested_main_industry`, or `online_gpv_last_30_days` are missing or null.** Report: "Cannot generate recommendations — missing required site data: {fields}."
|
|
157
157
|
|
|
158
158
|
---
|
|
159
159
|
|