@spree/docs 0.1.114 → 0.1.115
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.
|
@@ -6,7 +6,7 @@ description: "Every Spree Admin API v3 endpoint at a glance — method, path, re
|
|
|
6
6
|
|
|
7
7
|
{/* Generated from docs/api-reference/admin.yaml by packages/cli/scripts/generate-endpoints-doc.mjs — do not edit by hand. */}
|
|
8
8
|
|
|
9
|
-
All
|
|
9
|
+
All 209 Admin API operations, with the [scope](authentication.md) a secret API key needs for each. JWT-authenticated admin users are governed by their roles instead of scopes. The same index is available offline via the CLI: `spree api endpoints`.
|
|
10
10
|
|
|
11
11
|
Endpoints marked — are exempt from scope checks (authentication and session endpoints) or resolve their scope at request time.
|
|
12
12
|
|
|
@@ -36,7 +36,9 @@ Endpoints marked — are exempt from scope checks (authentication and session en
|
|
|
36
36
|
| `GET` | `/api_keys` | `read_api_keys` | List API keys |
|
|
37
37
|
| `POST` | `/api_keys` | `write_api_keys` | Create an API key |
|
|
38
38
|
| `GET` | `/api_keys/{id}` | `read_api_keys` | Show an API key |
|
|
39
|
+
| `PATCH` | `/api_keys/{id}` | `write_api_keys` | Update an API key |
|
|
39
40
|
| `DELETE` | `/api_keys/{id}` | `write_api_keys` | Delete an API key |
|
|
41
|
+
| `GET` | `/api_keys/current` | *none* | Describe the current API key |
|
|
40
42
|
| `PATCH` | `/api_keys/{id}/revoke` | `write_api_keys` | Revoke an API key |
|
|
41
43
|
|
|
42
44
|
## Auth
|
|
@@ -47,6 +49,20 @@ Endpoints marked — are exempt from scope checks (authentication and session en
|
|
|
47
49
|
| `POST` | `/auth/refresh` | — | Refresh token |
|
|
48
50
|
| `POST` | `/auth/logout` | — | Logout |
|
|
49
51
|
|
|
52
|
+
## Categories
|
|
53
|
+
|
|
54
|
+
| Method | Path | Required scope | Summary |
|
|
55
|
+
|---|---|---|---|
|
|
56
|
+
| `GET` | `/categories` | `read_categories` | List categories |
|
|
57
|
+
| `POST` | `/categories` | `write_categories` | Create a category |
|
|
58
|
+
| `GET` | `/categories/{id}` | `read_categories` | Get a category |
|
|
59
|
+
| `PATCH` | `/categories/{id}` | `write_categories` | Update a category |
|
|
60
|
+
| `DELETE` | `/categories/{id}` | `write_categories` | Delete a category |
|
|
61
|
+
| `PATCH` | `/categories/{id}/reposition` | `write_categories` | Reposition a category |
|
|
62
|
+
| `GET` | `/categories/{category_id}/products` | `read_categories` | List category products |
|
|
63
|
+
| `POST` | `/categories/{category_id}/products` | `write_categories` | Add a product to a category |
|
|
64
|
+
| `PATCH` | `/categories/{category_id}/products/{id}/reposition` | `write_categories` | Reposition a category product |
|
|
65
|
+
|
|
50
66
|
## Channels
|
|
51
67
|
|
|
52
68
|
| Method | Path | Required scope | Summary |
|
|
@@ -141,6 +157,12 @@ Endpoints marked — are exempt from scope checks (authentication and session en
|
|
|
141
157
|
| `DELETE` | `/invitations/{id}` | `write_settings` | Revoke an invitation |
|
|
142
158
|
| `PATCH` | `/invitations/{id}/resend` | `write_settings` | Resend an invitation |
|
|
143
159
|
|
|
160
|
+
## Locales
|
|
161
|
+
|
|
162
|
+
| Method | Path | Required scope | Summary |
|
|
163
|
+
|---|---|---|---|
|
|
164
|
+
| `GET` | `/locales` | `read_settings` | List supported locales |
|
|
165
|
+
|
|
144
166
|
## Markets
|
|
145
167
|
|
|
146
168
|
| Method | Path | Required scope | Summary |
|
|
@@ -156,6 +178,7 @@ Endpoints marked — are exempt from scope checks (authentication and session en
|
|
|
156
178
|
| Method | Path | Required scope | Summary |
|
|
157
179
|
|---|---|---|---|
|
|
158
180
|
| `GET` | `/me` | — | Get current admin user and permissions |
|
|
181
|
+
| `PATCH` | `/me` | — | Update the current admin profile |
|
|
159
182
|
|
|
160
183
|
## Option types
|
|
161
184
|
|
|
@@ -172,6 +195,7 @@ Endpoints marked — are exempt from scope checks (authentication and session en
|
|
|
172
195
|
| Method | Path | Required scope | Summary |
|
|
173
196
|
|---|---|---|---|
|
|
174
197
|
| `GET` | `/orders/{order_id}/fulfillments` | `read_fulfillments` | List fulfillments |
|
|
198
|
+
| `POST` | `/orders/{order_id}/fulfillments` | `write_fulfillments` | Create a fulfillment |
|
|
175
199
|
| `GET` | `/orders/{order_id}/fulfillments/{id}` | `read_fulfillments` | Show a shipment |
|
|
176
200
|
| `PATCH` | `/orders/{order_id}/fulfillments/{id}` | `write_fulfillments` | Update a shipment |
|
|
177
201
|
| `PATCH` | `/orders/{order_id}/fulfillments/{id}/fulfill` | `write_fulfillments` | Fulfill a fulfillment |
|
|
@@ -246,6 +270,7 @@ Endpoints marked — are exempt from scope checks (authentication and session en
|
|
|
246
270
|
| `GET` | `/products/{product_id}/custom_fields/{id}` | `read_products` | Show a product custom field |
|
|
247
271
|
| `PATCH` | `/products/{product_id}/custom_fields/{id}` | `write_products` | Update a product custom field |
|
|
248
272
|
| `DELETE` | `/products/{product_id}/custom_fields/{id}` | `write_products` | Delete a product custom field |
|
|
273
|
+
| `GET` | `/products/{product_id}/translations` | `read_products` | List product translations |
|
|
249
274
|
| `GET` | `/products` | `read_products` | List products |
|
|
250
275
|
| `POST` | `/products` | `write_products` | Create a product |
|
|
251
276
|
| `GET` | `/products/{id}` | `read_products` | Get a product |
|
|
@@ -331,6 +356,18 @@ Endpoints marked — are exempt from scope checks (authentication and session en
|
|
|
331
356
|
|---|---|---|---|
|
|
332
357
|
| `GET` | `/tags` | — | List tags |
|
|
333
358
|
|
|
359
|
+
## Translatable resources
|
|
360
|
+
|
|
361
|
+
| Method | Path | Required scope | Summary |
|
|
362
|
+
|---|---|---|---|
|
|
363
|
+
| `GET` | `/translatable_resources` | `read_settings` | List translatable resources |
|
|
364
|
+
|
|
365
|
+
## Translations
|
|
366
|
+
|
|
367
|
+
| Method | Path | Required scope | Summary |
|
|
368
|
+
|---|---|---|---|
|
|
369
|
+
| `POST` | `/translations/batch` | *write_<resource> for every resource type in the batch (for API-key authentication)* | Batch upsert translations |
|
|
370
|
+
|
|
334
371
|
## Webhook endpoints
|
|
335
372
|
|
|
336
373
|
| Method | Path | Required scope | Summary |
|