Skip to content

Commit 8cba9de

Browse files
committed
Updated API from documentation release
1 parent 0d4223f commit 8cba9de

24 files changed

+45
-45
lines changed

api-specs/api/resources/customers.raml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ post:
9696
displayName: Verifies customer's email.
9797
description: |
9898
Use this method to verify a global Customer's email during their [email verification process](/../api/customers-overview#customer-email-verification).
99-
99+
100100
Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message.
101101
securedBy: [oauth_2_0: { scopes: ['manage_customers:{projectKey}'] }]
102102
body:
@@ -136,7 +136,7 @@ post:
136136
Use this method to reset a global Customer's password during their [password reset process](/../api/customers-overview#customer-password-reset).
137137
138138
After the password is reset, any previously issued access and/or refresh tokens created through the [password flow](/authorization#password-flow) or [refresh token flow](/authorization#refresh-token-flow) are invalidated.
139-
139+
140140
Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`.
141141
securedBy: [oauth_2_0: { scopes: ['manage_customers:{projectKey}'] }]
142142
body:
@@ -158,7 +158,7 @@ post:
158158
securedBy: [oauth_2_0: { scopes: ['manage_customers:{projectKey}'] }]
159159
description: |
160160
Use this method to create a password reset token for a global Customer during their [password reset process](/../api/customers-overview#customer-password-reset).
161-
161+
162162
Creating a password reset token does not invalidate existing tokens.
163163
body:
164164
application/json:

api-specs/api/types/cart/Cart.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ properties:
4040
businessUnit?:
4141
type: BusinessUnitKeyReference
4242
description: |
43-
[Reference](ctp:api:type:Reference) to a Business Unit the Cart belongs to.
43+
[Reference](ctp:api:type:Reference) to a Business Unit the Cart belongs to. Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
4444
store?:
4545
type: StoreKeyReference
4646
description: |

api-specs/api/types/cart/CartDraft.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ properties:
3636
businessUnit?:
3737
type: BusinessUnitResourceIdentifier
3838
description: |
39-
[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. When the `customerId` of the Cart is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
39+
[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. When the `customerId` of the Cart is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit. Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
4040
store?:
4141
type: StoreResourceIdentifier
4242
description: |

api-specs/api/types/common/ClientLogging.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ properties:
2727
associate?:
2828
type: CustomerReference
2929
description: |
30-
Indicates the [Customer](ctp:api:type:Customer) who created or modified the resource in the context of a [Business Unit](ctp:api:type:BusinessUnit). Only present when an Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).
30+
Indicates the [Customer](ctp:api:type:Customer) who created or modified the resource in the context of a [Business Unit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects when an Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).

api-specs/api/types/common/CreatedBy.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ properties:
2828
associate?:
2929
type: CustomerReference
3030
description: |
31-
Indicates the [Customer](ctp:api:type:Customer) who created the resource in the context of a [Business Unit](ctp:api:type:BusinessUnit). Only present when an Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).
31+
Indicates the [Customer](ctp:api:type:Customer) who created the resource in the context of a [Business Unit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Project when an Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).

api-specs/api/types/common/LastModifiedBy.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ properties:
2828
associate?:
2929
type: CustomerReference
3030
description: |
31-
Indicates the [Customer](ctp:api:type:Customer) who modified the resource in the context of a [Business Unit](ctp:api:type:BusinessUnit). Only present when an Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).
31+
Indicates the [Customer](ctp:api:type:Customer) who modified the resource in the context of a [Business Unit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects when an Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).

api-specs/api/types/common/ReferenceTypeId.raml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ enum:
4747
- zone
4848
(enumDescriptions):
4949
approval-flow: |
50-
References an [ApprovalFlow](ctp:api:type:ApprovalFlow).
50+
References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
5151
approval-rule: |
52-
References an [ApprovalRule](ctp:api:type:ApprovalRule).
52+
References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
5353
associate-role: |
54-
References an [AssociateRole](ctp:api:type:AssociateRole).
54+
References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
5555
attribute-group: |
5656
References an [AttributeGroup](ctp:api:type:AttributeGroup).
5757
business-unit: |
58-
References a [BusinessUnit](ctp:api:type:BusinessUnit).
58+
References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
5959
cart: |
6060
References a [Cart](ctp:api:type:Cart).
6161
cart-discount: |

api-specs/api/types/me/MyCartDraft.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ properties:
1919
businessUnit?:
2020
type: BusinessUnitResourceIdentifier
2121
description: |
22-
[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. The [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
22+
[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. The [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit. Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
2323
store?:
2424
type: StoreResourceIdentifier
2525
description: |

api-specs/api/types/order/Order.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ properties:
4545
businessUnit?:
4646
type: BusinessUnitKeyReference
4747
description: |
48-
[Reference](ctp:api:type:Reference) to a Business Unit the Order belongs to.
48+
[Reference](ctp:api:type:Reference) to a Business Unit the Order belongs to. Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
4949
store?:
5050
type: StoreKeyReference
5151
description: |

api-specs/api/types/order/OrderImportDraft.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ properties:
3030
type: BusinessUnitResourceIdentifier
3131
description: |
3232
[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Order should belong to.
33-
When the `customerId` of the Order is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
33+
When the `customerId` of the Order is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit. Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
3434
store?:
3535
type: StoreResourceIdentifier
3636
description: |

0 commit comments

Comments
 (0)