Skip to content

Commit 3ee2d90

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent b73499a commit 3ee2d90

24 files changed

+215
-5
lines changed

‎api-specs/api/examples/Customer/CustomerAddCustomerGroupAssignmentAction.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"action": "addCustomerGroupAssignment",
3+
"customerGroupAssignment": {
4+
"customerGroup": {
5+
"id": "{{customer-group-id}}",
6+
"typeId": "customer-group"
7+
}
8+
}
9+
}

‎api-specs/api/examples/Customer/CustomerGroupAssignment.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"customerGroup": {
3+
"typeId": "customer-group",
4+
"id": "customer-group-1"
5+
}
6+
}

‎api-specs/api/examples/Customer/CustomerRemoveCustomerGroupAssignmentAction.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"action": "removeCustomerGroupAssignment",
3+
"customerGroup": {
4+
"id": "{{customer-group-id}}",
5+
"typeId": "customer-group"
6+
}
7+
}

‎api-specs/api/examples/Customer/CustomerSetCustomerGroupAssignmentsAction.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"action": "setCustomerGroupAssignments",
3+
"customerGroupAssignments": [
4+
{
5+
"customerGroup": {
6+
"id": "{{customer-group-id-1}}",
7+
"typeId": "customer-group"
8+
}
9+
},
10+
{
11+
"customerGroup": {
12+
"id": "{{customer-group-id-2}}",
13+
"typeId": "customer-group"
14+
}
15+
}
16+
]
17+
}

‎api-specs/api/traits/price-selecting.raml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ queryParameters:
1515
required: false
1616
description: |
1717
`id` of an existing [CustomerGroup](ctp:api:type:CustomerGroup) used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection). Can only be used **in conjunction with** the `priceCurrency` parameter.
18+
priceCustomerGroupAssignments?:
19+
type: string[]
20+
description: |
21+
IDs of existing [CustomerGroups](ctp:api:type:CustomerGroup) used for [Product price selection](/../api/pricing-and-discounts-overview#product-price-selection), when using [multiple Customer Groups](/../api/customers-overview#multiple-customer-groups). Can only be used **in conjunction with** the `priceCurrency` parameter.
1822
priceChannel:
1923
type: string
2024
required: false

‎api-specs/api/types/customer/Customer.raml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,3 +140,8 @@ properties:
140140
description: |
141141
Indicates whether the `password` is required for the Customer.
142142
default: Password
143+
customerGroupAssignments?:
144+
type: CustomerGroupAssignment[]
145+
(beta): true
146+
description: |
147+
Customer Groups of the Customer.

‎api-specs/api/types/customer/CustomerDraft.raml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,3 +137,8 @@ properties:
137137
- Set to `Password` to make the `password` field required for the Customer.
138138
- Set to `ExternalAuth` when the password is not required for the Customer.
139139
default: Password
140+
customerGroupAssignments?:
141+
type: CustomerGroupAssignmentDraft[]
142+
(beta): true
143+
description: |
144+
Customer Groups to assign to the Customer.

‎api-specs/api/types/customer/CustomerGroupAssignment.raml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#%RAML 1.0 DataType
2+
(package): Customer
3+
type: object
4+
(beta): true
5+
displayName: CustomerGroupAssignment
6+
example: !include ../../examples/Customer/CustomerGroupAssignment.json
7+
description: |
8+
Represents an individual Customer Group assignment as a [Reference](ctp:api:type:Reference) to a [CustomerGroup](ctp:api:type:CustomerGroup).
9+
properties:
10+
customerGroup:
11+
type: CustomerGroupReference
12+
description: |
13+
Reference to a Customer Group.

‎api-specs/api/types/customer/CustomerGroupAssignmentDraft.raml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#%RAML 1.0 DataType
2+
(package): Customer
3+
displayName: CustomerGroupAssignmentDraft
4+
type: object
5+
(beta): true
6+
properties:
7+
customerGroup:
8+
type: CustomerGroupResourceIdentifier
9+
description: |
10+
ResourceIdentifier of a Customer Group.

‎api-specs/api/types/customer/updates/CustomerAddCustomerGroupAssignmentAction.raml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#%RAML 1.0 DataType
2+
(package): Customer
3+
type: CustomerUpdateAction
4+
(beta): true
5+
displayName: CustomerAddCustomerGroupAssignmentAction
6+
discriminatorValue: addCustomerGroupAssignment
7+
example: !include ../../../examples/Customer/CustomerAddCustomerGroupAssignmentAction.json
8+
description: |
9+
Adds a single Customer Group to the Customer's list of `customerGroupAssignments`. Adding a Customer Group generates the [CustomerGroupAssignmentAdded](ctp:api:type:CustomerGroupAssignmentAddedMessage) Message.
10+
properties:
11+
customerGroupAssignment:
12+
type: CustomerGroupAssignmentDraft
13+
description: |
14+
Customer Group to assign to the Customer.

0 commit comments

Comments
 (0)