Skip to content

Commit 807064f

Browse files
author
github-actions
committed
feat: Update OpenAPI file replicated from CMS4
1 parent b8e3240 commit 807064f

1 file changed

Lines changed: 57 additions & 4 deletions

File tree

openapi/openapi.yaml

Lines changed: 57 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1326,6 +1326,9 @@ tags:
13261326
-
13271327
name: 'Customer delivery addresses'
13281328
description: 'Managing customer delivery addresses.'
1329+
-
1330+
name: 'Customer groups'
1331+
description: 'Managing customer groups in the e-shop.'
13291332
-
13301333
name: 'Customer remarks'
13311334
description: 'Managing customer remarks.'
@@ -29889,6 +29892,8 @@ paths:
2988929892
- wholesale
2989029893
- tableLayout
2989129894
- fullProfileRequired
29895+
- defaultDueDays
29896+
- defaultOrderStatusId
2989229897
properties:
2989329898
id:
2989429899
type: integer
@@ -29974,6 +29979,13 @@ paths:
2997429979
description: 'Default maturity for documents in days'
2997529980
examples:
2997629981
- 14
29982+
defaultOrderStatusId:
29983+
type:
29984+
- integer
29985+
- 'null'
29986+
description: 'ID of the default order status for orders placed by customers in this group.'
29987+
examples:
29988+
- -2
2997729989
errors:
2997829990
$ref: '#/components/schemas/Errors'
2997929991
metadata:
@@ -29987,7 +29999,7 @@ paths:
2998729999
operationId: getListOfCustomerGroups
2998830000
description: 'Returns list of customer groups ordered by priority. List is not paginated.'
2998930001
tags:
29990-
- Customers
30002+
- 'Customer groups'
2999130003
parameters:
2999230004
-
2999330005
$ref: '#/components/parameters/DefaultContentType'
@@ -30025,6 +30037,8 @@ paths:
3002530037
- wholesale
3002630038
- tableLayout
3002730039
- fullProfileRequired
30040+
- defaultDueDays
30041+
- defaultOrderStatusId
3002830042
properties:
3002930043
id:
3003030044
type: integer
@@ -30110,6 +30124,13 @@ paths:
3011030124
description: 'Default maturity for documents in days'
3011130125
examples:
3011230126
- 14
30127+
defaultOrderStatusId:
30128+
type:
30129+
- integer
30130+
- 'null'
30131+
description: 'ID of the default order status for orders placed by customers in this group.'
30132+
examples:
30133+
- -2
3011330134
errors:
3011430135
$ref: '#/components/schemas/Errors'
3011530136
required:
@@ -30168,14 +30189,18 @@ paths:
3016830189
errorCode: invalid-request-data
3016930190
message: 'Email notification can only be enabled when wholesale module is active.'
3017030191
instance: data.emailNotification
30192+
-
30193+
errorCode: invalid-request-data
30194+
message: 'Invalid statusId "999".'
30195+
instance: data.defaultOrderStatusId
3017130196
summary: 'Creation of customer group'
3017230197
operationId: createCustomerGroup
3017330198
description: |-
3017430199
Creates a new customer group with specified settings. The customer group name must be unique. Returns the full list of customer groups including the newly created one.
3017530200

3017630201
**Note:** To use wholesale features (`registrationAllowed`, `wholesale`, `tableLayout`, `fullProfileRequired`), the `wholesale` module must be active in the e-shop.
3017730202
tags:
30178-
- Customers
30203+
- 'Customer groups'
3017930204
requestBody:
3018030205
content:
3018130206
application/json:
@@ -30265,6 +30290,13 @@ paths:
3026530290
default: false
3026630291
examples:
3026730292
- true
30293+
defaultOrderStatusId:
30294+
type:
30295+
- integer
30296+
- 'null'
30297+
description: 'Default order status ID for orders placed by customers in this group.'
30298+
examples:
30299+
- -2
3026830300
parameters:
3026930301
-
3027030302
$ref: '#/components/parameters/DefaultContentType'
@@ -30333,7 +30365,7 @@ paths:
3033330365
operationId: deleteCustomerGroup
3033430366
description: 'Is not possible to delete default customer group. Deletion of customer group will not delete customers assigned to this group, but they will be assigned to default customer group.'
3033530367
tags:
30336-
- Customers
30368+
- 'Customer groups'
3033730369
parameters:
3033830370
-
3033930371
name: id
@@ -30379,6 +30411,8 @@ paths:
3037930411
- wholesale
3038030412
- tableLayout
3038130413
- fullProfileRequired
30414+
- defaultDueDays
30415+
- defaultOrderStatusId
3038230416
properties:
3038330417
id:
3038430418
type: integer
@@ -30464,6 +30498,13 @@ paths:
3046430498
description: 'Default maturity for documents in days'
3046530499
examples:
3046630500
- 14
30501+
defaultOrderStatusId:
30502+
type:
30503+
- integer
30504+
- 'null'
30505+
description: 'ID of the default order status for orders placed by customers in this group.'
30506+
examples:
30507+
- -2
3046730508
errors:
3046830509
$ref: '#/components/schemas/Errors'
3046930510
required:
@@ -30542,14 +30583,18 @@ paths:
3054230583
errorCode: invalid-request-data
3054330584
message: 'Default customer group must be allowed for registration.'
3054430585
instance: data.registrationAllowed
30586+
-
30587+
errorCode: invalid-request-data
30588+
message: 'Invalid statusId "999".'
30589+
instance: data.defaultOrderStatusId
3054530590
summary: 'Update of customer group'
3054630591
operationId: updateCustomerGroup
3054730592
description: |-
3054830593
Updates an existing customer group with specified settings. Returns the full list of customer groups including the updated one.
3054930594

3055030595
**Note:** To use wholesale features (`registrationAllowed`, `wholesale`, `tableLayout`, `fullProfileRequired`), the `Wholesale` module must be active in the e-shop.
3055130596
tags:
30552-
- Customers
30597+
- 'Customer groups'
3055330598
requestBody:
3055430599
content:
3055530600
application/json:
@@ -30632,6 +30677,13 @@ paths:
3063230677
description: 'Whether full profile (billing information and address) is needed for customer. Requires `Wholesale` module to be active.'
3063330678
examples:
3063430679
- true
30680+
defaultOrderStatusId:
30681+
type:
30682+
- integer
30683+
- 'null'
30684+
description: 'ID of the default order status for orders placed by customers in this group.'
30685+
examples:
30686+
- -2
3063530687
parameters:
3063630688
-
3063730689
$ref: '#/components/parameters/DefaultContentType'
@@ -51260,6 +51312,7 @@ x-tagGroups:
5126051312
- Customers
5126151313
- 'Customer accounts'
5126251314
- 'Customer delivery addresses'
51315+
- 'Customer groups'
5126351316
- 'Customer remarks'
5126451317
-
5126551318
name: Content

0 commit comments

Comments
 (0)