Skip to content

Commit 0eb82a3

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent fea3fbf commit 0eb82a3

File tree

8 files changed

+44
-0
lines changed

8 files changed

+44
-0
lines changed

‎api-specs/api/types/cart/updates/CartFreezeCartAction.raml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@ example: !include ../../../examples/Cart/CartFreezeCartAction.json
77
description: |
88
Changes the [CartState](ctp:api:type:CartState) from `Active` to `Frozen`. Results in a [Frozen Cart](ctp:api:type:FrozenCarts).
99
Fails with [InvalidOperation](ctp:api:type:InvalidOperationError) error when the Cart is empty.
10+
11+
Freezing a Cart produces the [CartFrozen](ctp:api:type:CartFrozenMessage) Message.

‎api-specs/api/types/cart/updates/CartUnfreezeCartAction.raml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@ example: !include ../../../examples/Cart/CartUnfreezeCartAction.json
77
description: |
88
Changes the [CartState](ctp:api:type:CartState) from `Frozen` to `Active`. Reactivates a [Frozen Cart](ctp:api:type:FrozenCarts).
99
This action updates all prices in the Cart according to latest Prices on related Product Variants and Shipping Methods and by applying all discounts currently being active and applicable for the Cart.
10+
11+
Unfreezing a Cart produces the [CartUnfrozen](ctp:api:type:CartUnfrozenMessage) Message.

‎api-specs/api/types/message/CartFrozenMessage.raml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: Message
4+
displayName: CartFrozenMessage
5+
discriminatorValue: CartFrozen
6+
description: |
7+
Generated after a successful [Freeze Cart](ctp:api:type:CartFreezeCartAction) update action.

‎api-specs/api/types/message/CartUnfrozenMessage.raml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: Message
4+
displayName: CartUnfrozenMessage
5+
discriminatorValue: CartUnfrozen
6+
description: |
7+
Generated after a successful [Unfreeze Cart](ctp:api:type:CartUnfreezeCartAction) update action.

‎api-specs/api/types/message/payload/CartFrozenMessagePayload.raml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: MessagePayload
4+
displayName: CartFrozenMessagePayload
5+
discriminatorValue: CartFrozen
6+
description: |
7+
Generated after a successful [Freeze Cart](ctp:api:type:CartFreezeCartAction) update action.

‎api-specs/api/types/message/payload/CartUnfrozenMessagePayload.raml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: MessagePayload
4+
displayName: CartUnfrozenMessagePayload
5+
discriminatorValue: CartUnfrozen
6+
description: |
7+
Generated after a successful [Unfreeze Cart](ctp:api:type:CartUnfreezeCartAction) update action.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -964,6 +964,8 @@ CartDiscountDeletedMessage: !include message/CartDiscountDeletedMessage.raml
964964
CartDiscountStoreAddedMessage: !include message/CartDiscountStoreAddedMessage.raml
965965
CartDiscountStoreRemovedMessage: !include message/CartDiscountStoreRemovedMessage.raml
966966
CartDiscountStoresSetMessage: !include message/CartDiscountStoresSetMessage.raml
967+
CartFrozenMessage: !include message/CartFrozenMessage.raml
968+
CartUnfrozenMessage: !include message/CartUnfrozenMessage.raml
967969
CategoryCreatedMessage: !include message/CategoryCreatedMessage.raml
968970
CategorySlugChangedMessage: !include message/CategorySlugChangedMessage.raml
969971
ContainerAndKey: !include message/ContainerAndKey.raml
@@ -1287,6 +1289,8 @@ CartDiscountDeletedMessagePayload: !include message/payload/CartDiscountDeletedM
12871289
CartDiscountStoreAddedMessagePayload: !include message/payload/CartDiscountStoreAddedMessagePayload.raml
12881290
CartDiscountStoreRemovedMessagePayload: !include message/payload/CartDiscountStoreRemovedMessagePayload.raml
12891291
CartDiscountStoresSetMessagePayload: !include message/payload/CartDiscountStoresSetMessagePayload.raml
1292+
CartFrozenMessagePayload: !include message/payload/CartFrozenMessagePayload.raml
1293+
CartUnfrozenMessagePayload: !include message/payload/CartUnfrozenMessagePayload.raml
12901294
CategoryCreatedMessagePayload: !include message/payload/CategoryCreatedMessagePayload.raml
12911295
CategorySlugChangedMessagePayload: !include message/payload/CategorySlugChangedMessagePayload.raml
12921296
CustomLineItemStateTransitionMessagePayload: !include message/payload/CustomLineItemStateTransitionMessagePayload.raml

‎api-specs/graphql/schema.sdl‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2048,6 +2048,10 @@ input CartDraft {
20482048
origin: CartOrigin = Customer
20492049
}
20502050

2051+
type CartFrozen implements MessagePayload {
2052+
type: String!
2053+
}
2054+
20512055
type CartLimitWithCurrent implements LimitWithCurrent {
20522056
limit: Long
20532057
current: Long!
@@ -2123,6 +2127,10 @@ enum CartState {
21232127
Ordered
21242128
}
21252129

2130+
type CartUnfrozen implements MessagePayload {
2131+
type: String!
2132+
}
2133+
21262134
input CartUpdateAction {
21272135
addCustomShippingMethod: AddCartCustomShippingMethod
21282136
addDiscountCode: AddCartDiscountCode

0 commit comments

Comments
 (0)