Skip to content

Commit 8f3d4c3

Browse files
committed
Updated API from documentation release
1 parent bc8c75b commit 8f3d4c3

File tree

316 files changed

+4310
-514
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

316 files changed

+4310
-514
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ properties:
4747
createdAt:
4848
type: datetime
4949
description: |
50-
Date and time (UTC) the Return Item was intitially created.
50+
Date and time (UTC) the Return Item was initially created.

api-specs/history/api.raml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ annotationTypes:
1515
allowedTargets:
1616
- API
1717
type: object
18+
markDeprecated:
19+
type: boolean
20+
allowedTargets: TypeDeclaration
1821
products:
1922
allowedTargets:
2023
- API

api-specs/history/ruleset.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
<option type="exclude">previousValue</option>
5656
<option type="exclude">triggerPattern</option>
5757
<option type="exclude">targetPattern</option>
58+
<option type="exclude">perMethodTaxRate</option>
5859
</options>
5960
</rule>
6061
<rule>
@@ -123,6 +124,7 @@
123124
<option type="exclude">ProductVariantChannelAvailability:isOnStock</option>
124125
<option type="exclude">ShippingRate:isMatching</option>
125126
<option type="exclude">TrackingData:isReturn</option>
127+
<option type="exclude">ProductVariant:isMatchingVariant</option>
126128
</options>
127129
</rule>
128130
</rules>

api-specs/history/types/PlatformInitiatedChange.raml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,21 @@ displayName: PlatformInitiatedChange
55
description: Updates that are triggered automatically as a result of a user-initiated change.
66
enum:
77
- excludeAll
8+
- addInheritedAssociate
9+
- changeIncludedInStatistics
10+
- changeInheritedAssociate
11+
- changeLastVariantId
812
- changeLineItemName
13+
- changeLineItemPublished
914
- changeReviewRatingStatistics
15+
- changeTopLevelUnit
16+
- removeInheritedAssociate
17+
- setAncestors
1018
- setApplicationVersion
19+
- setInheritedAssociates
20+
- setInheritedStores
1121
- setIsValid
22+
- setLineItemDeactivatedAt
23+
- setProductCount
24+
- setReservations
1225
- setVariantAvailability

api-specs/history/types/UpdateType.raml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ enum:
3636
- 'addTransaction'
3737
- 'addVariant'
3838
- 'changeAddress'
39-
- 'changeAmountAuthorized'
4039
- 'changeAmountPlanned'
4140
- 'changeAssetName'
4241
- 'changeAssetOrder'

api-specs/history/types/change/AddAssetChange.raml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,16 @@ properties:
2323
nextValue:
2424
type: Asset
2525
description: Value after the change.
26+
catalogData:
27+
type: string
28+
description: |
29+
Product data that was updated.
30+
31+
- `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
32+
- `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
33+
variant:
34+
type: string
35+
description: |
36+
Identifier of the updated Product Variant.
37+
38+
This field holds the SKU, if defined; otherwise the key; otherwise the ID.

api-specs/history/types/change/AddAssociateChange.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
#%RAML 1.0 DataType
22
(package): Change
3+
(markDeprecated): true
34
type: Change
45
displayName: AddAssociateChange
56
description: Change triggered by the [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action.

api-specs/history/types/change/AddEnumValueChange.raml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,11 @@ properties:
1414
enum:
1515
- addEnumValue
1616
nextValue:
17-
type: EnumValue
17+
type: CustomFieldEnumValue
1818
description: Value after the change.
1919
fieldName:
2020
type: string
2121
description: Name of the updated [FieldDefinition](ctp:api:type:FieldDefinition).
22+
attributeName:
23+
type: string
24+
description: Name of the updated [AttributeDefinition](ctp:api:type:AttributeDefinition).

api-specs/history/types/change/AddExternalImageChange.raml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,13 @@ properties:
2626
catalogData:
2727
type: string
2828
description: |
29+
Product data that was updated.
30+
2931
- `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
3032
- `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
33+
variant:
34+
type: string
35+
description: |
36+
Identifier of the updated Product Variant.
37+
38+
This field holds the SKU, if defined; otherwise the key; otherwise the ID.

api-specs/history/types/change/AddInheritedAssociateChange.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
(package): Change
33
type: Change
44
displayName: AddInheritedAssociateChange
5-
description: Change triggered by the [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action on a parent of a Business Unit in cases where [inheritance applies](/../api/associates-overview#conditions-for-inheritance).
5+
description: This change is initiated by background processes after the [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action is performed (if [Associates are inherited](/../api/associates-overview#inheritance-of-associates-and-their-roles)).
66
discriminatorValue: AddInheritedAssociateChange
77
properties:
88
change:

0 commit comments

Comments
 (0)