u
This commit is contained in:
38
docs/api/routes/article/_sku/attributevalue.get.md
Normal file
38
docs/api/routes/article/_sku/attributevalue.get.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# `GET /article/{sku}/attributevalue`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List article attribute values
|
||||
|
||||
Fetches all attribute values assigned to an article.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `sku` | yes | string | Article SKU |
|
||||
|
||||
## Response `200`
|
||||
|
||||
List of attribute values assigned to this article
|
||||
|
||||
```json
|
||||
{
|
||||
"attributevalues": [
|
||||
{
|
||||
"id": 1,
|
||||
"articleId": 1,
|
||||
"attributeId": 1,
|
||||
"attributeName": "…",
|
||||
"exclusive": true,
|
||||
"attributeValueId": 1,
|
||||
"value": "…",
|
||||
"sort": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
48
docs/api/routes/article/_sku/attributevalue.put.md
Normal file
48
docs/api/routes/article/_sku/attributevalue.put.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# `PUT /article/{sku}/attributevalue`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Bulk set article attribute values
|
||||
|
||||
Replaces all attribute values for an article. Enforces exclusive constraint (max one value per exclusive attribute).
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `sku` | yes | string | Article SKU |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"attributevalues": [
|
||||
"…"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Updated article attribute values
|
||||
|
||||
```json
|
||||
{
|
||||
"attributevalues": [
|
||||
{
|
||||
"id": 1,
|
||||
"articleId": 1,
|
||||
"attributeId": 1,
|
||||
"attributeName": "…",
|
||||
"exclusive": true,
|
||||
"attributeValueId": 1,
|
||||
"value": "…",
|
||||
"sort": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
36
docs/api/routes/article/_sku/property.get.md
Normal file
36
docs/api/routes/article/_sku/property.get.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# `GET /article/{sku}/property`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List article properties
|
||||
|
||||
Fetches all free-form properties set on an article.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `sku` | yes | string | Article SKU |
|
||||
|
||||
## Response `200`
|
||||
|
||||
List of properties for this article
|
||||
|
||||
```json
|
||||
{
|
||||
"properties": [
|
||||
{
|
||||
"id": 1,
|
||||
"articleId": 1,
|
||||
"propertyId": 1,
|
||||
"name": "…",
|
||||
"value": "…",
|
||||
"sort": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
50
docs/api/routes/article/_sku/property.put.md
Normal file
50
docs/api/routes/article/_sku/property.put.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# `PUT /article/{sku}/property`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Bulk set article properties
|
||||
|
||||
Replaces all properties for an article.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `sku` | yes | string | Article SKU |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"properties": [
|
||||
{
|
||||
"propertyId": 1,
|
||||
"value": "…",
|
||||
"sort": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Updated article properties
|
||||
|
||||
```json
|
||||
{
|
||||
"properties": [
|
||||
{
|
||||
"id": 1,
|
||||
"articleId": 1,
|
||||
"propertyId": 1,
|
||||
"name": "…",
|
||||
"value": "…",
|
||||
"sort": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
22
docs/api/routes/article/_sku/property/_propertyId.md
Normal file
22
docs/api/routes/article/_sku/property/_propertyId.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# `DELETE /article/{sku}/property/{propertyId}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Delete article property
|
||||
|
||||
Removes a single property from an article.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `sku` | yes | string | |
|
||||
| `propertyId` | yes | integer | |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Deleted successfully
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user