@spree/docs 0.1.0 → 0.1.2
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/dist/api-reference/store-api/errors.md +2 -2
- package/dist/api-reference/store-api/idempotency.md +1 -1
- package/dist/api-reference/store-api/localization.md +4 -4
- package/dist/api-reference/store-api/metadata.md +2 -2
- package/dist/api-reference/store.yaml +10599 -0
- package/dist/api-reference/storefront/authentication.md +2 -2
- package/dist/api-reference/tutorials/adyen-integration-guide-for-android.md +2 -2
- package/dist/api-reference/tutorials/adyen-integration-guide-for-ios.md +2 -2
- package/dist/api-reference/tutorials/quick-checkout-with-stripe.md +8 -8
- package/dist/api-reference/v2/introduction.md +2 -2
- package/dist/api-reference/webhooks-events.md +2 -2
- package/dist/developer/admin/admin.md +18 -18
- package/dist/developer/admin/components.md +1 -1
- package/dist/developer/admin/extending-ui.md +26 -26
- package/dist/developer/admin/helper-methods.md +2 -2
- package/dist/developer/admin/navigation.md +5 -5
- package/dist/developer/admin/tables.md +4 -4
- package/dist/developer/cli/quickstart.md +2 -2
- package/dist/developer/contributing/creating-an-extension.md +12 -12
- package/dist/developer/contributing/quickstart.md +1 -1
- package/dist/developer/core-concepts/addresses.md +11 -11
- package/dist/developer/core-concepts/adjustments.md +8 -8
- package/dist/developer/core-concepts/architecture.md +21 -21
- package/dist/developer/core-concepts/calculators.md +4 -4
- package/dist/developer/core-concepts/customers.md +9 -9
- package/dist/developer/core-concepts/events.md +5 -5
- package/dist/developer/core-concepts/inventory.md +5 -5
- package/dist/developer/core-concepts/markets.md +10 -10
- package/dist/developer/core-concepts/media.md +3 -3
- package/dist/developer/core-concepts/metafields.md +6 -6
- package/dist/developer/core-concepts/orders.md +14 -14
- package/dist/developer/core-concepts/payments.md +9 -9
- package/dist/developer/core-concepts/pricing.md +10 -10
- package/dist/developer/core-concepts/products.md +10 -10
- package/dist/developer/core-concepts/promotions.md +5 -5
- package/dist/developer/core-concepts/reports.md +2 -2
- package/dist/developer/core-concepts/search-filtering.md +7 -7
- package/dist/developer/core-concepts/shipments.md +13 -13
- package/dist/developer/core-concepts/slugs.md +3 -3
- package/dist/developer/core-concepts/staff-roles.md +7 -7
- package/dist/developer/core-concepts/store-credits-gift-cards.md +4 -4
- package/dist/developer/core-concepts/stores.md +15 -15
- package/dist/developer/core-concepts/taxes.md +11 -11
- package/dist/developer/core-concepts/translations.md +6 -6
- package/dist/developer/core-concepts/users.md +12 -12
- package/dist/developer/core-concepts/webhooks.md +8 -8
- package/dist/developer/create-spree-app/quickstart.md +5 -5
- package/dist/developer/customization/api.md +2 -2
- package/dist/developer/customization/authentication.md +2 -2
- package/dist/developer/customization/checkout.md +7 -7
- package/dist/developer/customization/decorators.md +24 -24
- package/dist/developer/customization/dependencies.md +1 -1
- package/dist/developer/customization/metadata.md +3 -3
- package/dist/developer/customization/permissions.md +1 -1
- package/dist/developer/customization/quickstart.md +9 -9
- package/dist/developer/customization/v4/checkout.md +3 -3
- package/dist/developer/customization/v4/deface.md +1 -1
- package/dist/developer/deployment/assets.md +1 -1
- package/dist/developer/deployment/aws.md +5 -5
- package/dist/developer/deployment/docker.md +2 -2
- package/dist/developer/deployment/environment_variables.md +1 -1
- package/dist/developer/deployment/render.md +5 -5
- package/dist/developer/getting-started/quickstart.md +2 -2
- package/dist/developer/how-to/custom-payment-method.md +6 -6
- package/dist/developer/how-to/custom-promotion.md +7 -7
- package/dist/developer/how-to/custom-report.md +3 -3
- package/dist/developer/how-to/custom-search-provider.md +7 -7
- package/dist/developer/multi-store/quickstart.md +1 -1
- package/dist/developer/multi-tenant/quickstart.md +1 -1
- package/dist/developer/sdk/authentication.md +1 -1
- package/dist/developer/sdk/configuration.md +1 -1
- package/dist/developer/sdk/store/markets.md +3 -3
- package/dist/developer/storefront/nextjs/customization.md +1 -1
- package/dist/developer/storefront/nextjs/quickstart.md +2 -2
- package/dist/developer/tutorial/admin.md +2 -2
- package/dist/developer/tutorial/extending-models.md +15 -15
- package/dist/developer/tutorial/file-uploads.md +1 -1
- package/dist/developer/tutorial/introduction.md +7 -7
- package/dist/developer/tutorial/rich-text.md +1 -1
- package/dist/developer/tutorial/testing.md +5 -61
- package/dist/developer/upgrades/3.7-to-4.0.md +1 -1
- package/dist/developer/upgrades/4.0-to-4.1.md +1 -1
- package/dist/developer/upgrades/4.10-to-5.0.md +1 -1
- package/dist/developer/upgrades/4.5-to-4.6.md +4 -4
- package/dist/developer/upgrades/4.8-to-4.9.md +1 -1
- package/dist/developer/upgrades/4.9-to-4.10.md +1 -1
- package/dist/developer/upgrades/5.0-to-5.1.md +1 -1
- package/dist/developer/upgrades/5.1-to-5.2.md +2 -2
- package/dist/developer/upgrades/5.2-to-5.3.md +2 -2
- package/dist/developer/upgrades/5.3-to-5.4.md +5 -5
- package/dist/developer/upgrades/quickstart.md +1 -1
- package/dist/integrations/integrations.md +10 -10
- package/dist/integrations/payments/adyen.md +1 -1
- package/dist/integrations/search/meilisearch.md +2 -2
- package/package.json +7 -2
- package/dist/developer/storefront/blocks.md +0 -285
- package/dist/developer/storefront/custom-css.md +0 -260
- package/dist/developer/storefront/custom-javascript.md +0 -166
- package/dist/developer/storefront/helper-methods.md +0 -1288
- package/dist/developer/storefront/links.md +0 -298
- package/dist/developer/storefront/pages.md +0 -163
- package/dist/developer/storefront/sections.md +0 -569
- package/dist/developer/storefront/storefront.md +0 -56
- package/dist/developer/storefront/themes.md +0 -161
- package/dist/developer/tutorial/page-builder.md +0 -487
- package/dist/developer/tutorial/seo.md +0 -332
- package/dist/developer/tutorial/storefront.md +0 -352
|
@@ -51,7 +51,7 @@ Validation errors include an additional `details` field with per-field error mes
|
|
|
51
51
|
| `404` | Not Found | Resource doesn't exist or isn't accessible |
|
|
52
52
|
| `409` | Conflict | Resource was modified by another request (concurrent update) |
|
|
53
53
|
| `422` | Unprocessable Content | Validation failed, invalid state transition, payment error |
|
|
54
|
-
| `429` | Too Many Requests | Rate limit exceeded (see [Rate Limiting](
|
|
54
|
+
| `429` | Too Many Requests | Rate limit exceeded (see [Rate Limiting](rate-limitting.md)) |
|
|
55
55
|
|
|
56
56
|
## Error Codes
|
|
57
57
|
|
|
@@ -128,7 +128,7 @@ Validation errors include an additional `details` field with per-field error mes
|
|
|
128
128
|
| Code | Status | Description |
|
|
129
129
|
|------|--------|-------------|
|
|
130
130
|
| `order_already_updated` | 409 | Order was modified by another concurrent request. Retry with fresh data. |
|
|
131
|
-
| `idempotency_key_reused` | 422 | Idempotency key was already used with different request parameters. See [Idempotency](
|
|
131
|
+
| `idempotency_key_reused` | 422 | Idempotency key was already used with different request parameters. See [Idempotency](idempotency.md). |
|
|
132
132
|
|
|
133
133
|
### Other Errors
|
|
134
134
|
|
|
@@ -119,7 +119,7 @@ await client.carts.items.create(cartId, {
|
|
|
119
119
|
|
|
120
120
|
## Relationship with Optimistic Locking
|
|
121
121
|
|
|
122
|
-
The Store API also uses [optimistic locking](
|
|
122
|
+
The Store API also uses [optimistic locking](introduction.md) via the `state_lock_version` field on orders. These mechanisms complement each other:
|
|
123
123
|
|
|
124
124
|
| Mechanism | Prevents | Scope |
|
|
125
125
|
|-----------|----------|-------|
|
|
@@ -64,7 +64,7 @@ curl -G 'http://localhost:3000/api/v3/store/products' \
|
|
|
64
64
|
|
|
65
65
|
## Country and Markets
|
|
66
66
|
|
|
67
|
-
The `X-Spree-Country` header resolves the customer's [market](
|
|
67
|
+
The `X-Spree-Country` header resolves the customer's [market](../../developer/core-concepts/markets.md), which influences default locale and currency. Markets allow you to configure different pricing, languages, and product availability per region.
|
|
68
68
|
|
|
69
69
|
|
|
70
70
|
```typescript SDK
|
|
@@ -85,7 +85,7 @@ When a market is resolved from the country:
|
|
|
85
85
|
1. The market's default locale is used (unless overridden by `X-Spree-Locale`)
|
|
86
86
|
2. The market's default currency is used (unless overridden by `X-Spree-Currency`)
|
|
87
87
|
|
|
88
|
-
You can also resolve the market explicitly using the [Markets API](
|
|
88
|
+
You can also resolve the market explicitly using the [Markets API](../../developer/sdk/store/markets.md):
|
|
89
89
|
|
|
90
90
|
|
|
91
91
|
```typescript SDK
|
|
@@ -130,7 +130,7 @@ Each value is resolved in the following order:
|
|
|
130
130
|
|
|
131
131
|
## Translated Content
|
|
132
132
|
|
|
133
|
-
When a locale is set, all translatable fields are returned in the requested language. This includes product names, descriptions, category names, and other content managed through [translations](
|
|
133
|
+
When a locale is set, all translatable fields are returned in the requested language. This includes product names, descriptions, category names, and other content managed through [translations](../../developer/core-concepts/translations.md).
|
|
134
134
|
|
|
135
135
|
|
|
136
136
|
```typescript SDK
|
|
@@ -194,7 +194,7 @@ curl 'http://localhost:3000/api/v3/store/products/spree-tote' \
|
|
|
194
194
|
|
|
195
195
|
## Discovering Available Options
|
|
196
196
|
|
|
197
|
-
Use the dedicated endpoints to discover which markets, countries, locales, and currencies are available. These are derived from your store's [markets](
|
|
197
|
+
Use the dedicated endpoints to discover which markets, countries, locales, and currencies are available. These are derived from your store's [markets](../../developer/core-concepts/markets.md) configuration.
|
|
198
198
|
|
|
199
199
|
### Markets
|
|
200
200
|
|
|
@@ -6,7 +6,7 @@ description: "How to store and retrieve custom metadata on carts, orders, and li
|
|
|
6
6
|
|
|
7
7
|
The Store API supports storing arbitrary key-value **metadata** on carts (orders) and line items. Metadata is useful for tracking custom information like gift messages, attribution data, or integration-specific fields.
|
|
8
8
|
|
|
9
|
-
> **NOTE:** Metadata is different from [metafields](
|
|
9
|
+
> **NOTE:** Metadata is different from [metafields](../../developer/core-concepts/metafields.md). Metadata is simple JSON storage (untyped, no schema), while metafields are structured, typed, and schema-defined. Use metadata for integration data and internal tracking. Use metafields for customer-facing custom attributes.
|
|
10
10
|
|
|
11
11
|
## Cart Metadata
|
|
12
12
|
|
|
@@ -157,4 +157,4 @@ Metadata is stored as a flat JSON object. You can use any keys and values:
|
|
|
157
157
|
| **Best for** | Integration data, tracking, attribution | Product specs, custom fields, customer-facing data |
|
|
158
158
|
| **API access** | Write via Store API, read via Admin API | Read/write via both APIs |
|
|
159
159
|
|
|
160
|
-
For more details on metafields, see the [Metafields guide](
|
|
160
|
+
For more details on metafields, see the [Metafields guide](../../developer/core-concepts/metafields.md).
|