Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit 12c86075166f · 2025-08-27T12:45:12.000Z
diff --git a/api-specs/api/examples/DiscountGroup/DiscountGroupSetIsActiveAction.json b/api-specs/api/examples/DiscountGroup/DiscountGroupSetIsActiveAction.json
@@ -0,0 +1,4 @@
+{
+  "action": "setIsActive",
+  "isActive": false
+}
diff --git a/api-specs/api/examples/discount-group-create.example.json b/api-specs/api/examples/discount-group-create.example.json
@@ -6,5 +6,6 @@
   "description": {
     "en": "10% discount on all items in cart"
   },
-  "sortOrder": "0.01"
+  "sortOrder": "0.01",
+  "isActive": true
 }
diff --git a/api-specs/api/examples/discount-group-updated.example.json b/api-specs/api/examples/discount-group-updated.example.json
@@ -1,6 +1,6 @@
 {
   "id": "{{discount-group-id}}",
-  "version": 1,
+  "version": 2,
   "key": "black-friday-sale",
   "name": {
     "en": "Black Friday Sale"
@@ -9,6 +9,7 @@
     "en": "10% discount on all items in cart"
   },
   "sortOrder": "0.01",
+  "isActive": false,
   "createdAt": "2024-11-21T13:08:15.962Z",
   "lastModifiedAt": "2024-11-21T13:08:15.962Z",
   "lastModifiedBy": {
diff --git a/api-specs/api/examples/discount-group.example.json b/api-specs/api/examples/discount-group.example.json
@@ -9,6 +9,7 @@
     "en": "10% discount on all items in cart"
   },
   "sortOrder": "0.01",
+  "isActive": true,
   "createdAt": "2024-11-21T13:08:15.962Z",
   "lastModifiedAt": "2024-11-21T13:08:15.962Z",
   "lastModifiedBy": {
diff --git a/api-specs/api/examples/discount-groups.example.json b/api-specs/api/examples/discount-groups.example.json
@@ -11,6 +11,7 @@
       "name": {"en": "Black Friday Sale"},
       "description": {"en": "10% discount on all items in cart"},
       "sortOrder": "0.01",
+      "isActive": true,
       "createdAt": "2024-11-21T13:08:15.962Z",
       "lastModifiedAt": "2024-11-21T13:08:15.962Z",
       "lastModifiedBy": {
diff --git a/api-specs/api/resources/discount-groups.raml b/api-specs/api/resources/discount-groups.raml
@@ -33,6 +33,8 @@ post:
   description: |
     Creates a DiscountGroup in the Project.
     This request generates the [DiscountGroupCreated](ctp:api:type:DiscountGroupCreatedMessage) Message.
+
+    If the [limit](/../api/limits#discount-groups) for active Discount Groups has been reached, a [MaxDiscountGroupsReached](ctp:api:type:MaxDiscountGroupsReachedError) error is returned.
   securedBy: [oauth_2_0: { scopes: ['manage_cart_discounts:{projectKey}'] }]
   body:
     application/json:
diff --git a/api-specs/api/ruleset.xml b/api-specs/api/ruleset.xml
@@ -132,6 +132,11 @@
           <option type="exclude">DiscountCode:isActive</option>
           <option type="exclude">DiscountCodeDraft:isActive</option>
           <option type="exclude">DiscountCodeChangeIsActiveAction:isActive</option>
+          <option type="exclude">DiscountGroup:isActive</option>
+          <option type="exclude">DiscountGroupDraft:isActive</option>
+          <option type="exclude">DiscountGroupSetIsActiveAction:isActive</option>
+          <option type="exclude">DiscountGroupIsActiveSetMessage:isActive</option>
+          <option type="exclude">DiscountGroupIsActiveSetMessagePayload:isActive</option>
           <option type="exclude">TrackingData:isReturn</option>
           <option type="exclude">ProductDiscount:isActive</option>
           <option type="exclude">ProductDiscountDraft:isActive</option>
diff --git a/api-specs/api/types/discount-group/DiscountGroup.raml b/api-specs/api/types/discount-group/DiscountGroup.raml
@@ -37,6 +37,11 @@ properties:
       Value between `0` and `1` that determines the order in which the CartDiscount from the DiscountGroup is applied; a CartDiscount with a higher value is prioritized.
 
       The sort order is unique among all DiscountGroups and CartDiscounts.
+  isActive:
+    type: boolean
+    description: |
+      A DiscountGroup must be active for its CartDiscounts to be considered during discount application.
+    default: true
   createdAt:
     type: datetime
     description: |
diff --git a/api-specs/api/types/discount-group/DiscountGroupDraft.raml b/api-specs/api/types/discount-group/DiscountGroupDraft.raml
@@ -26,3 +26,8 @@ properties:
       Value between `0` and `1` that determines the order in which the CartDiscount from the DiscountGroup will be applied; a CartDiscount with a higher value will be prioritized.
 
       The sort order must be unique among all DiscountGroups and CartDiscounts.
+  isActive?:
+    type: boolean
+    description: |
+      A DiscountGroup must be active for its CartDiscounts to be considered during discount application.
+    default: true
diff --git a/api-specs/api/types/discount-group/updates/DiscountGroupSetIsActiveAction.raml b/api-specs/api/types/discount-group/updates/DiscountGroupSetIsActiveAction.raml
@@ -0,0 +1,18 @@
+#%RAML 1.0 DataType
+(package): DiscountGroup
+type: DiscountGroupUpdateAction
+displayName: DiscountGroupSetIsActiveAction
+discriminatorValue: setIsActive
+example: !include ../../../examples/DiscountGroup/DiscountGroupSetIsActiveAction.json
+(beta): true
+description: |
+  This action generates the [DiscountGroupIsActiveSet](ctp:api:type:DiscountGroupIsActiveSetMessage) Message.
+
+  If the [limit](/../api/limits#discount-groups) for active Discount Groups has been reached, a [MaxDiscountGroupsReached](ctp:api:type:MaxDiscountGroupsReachedError) error is returned.
+properties:
+  isActive:
+    type: boolean
+    description: |
+      New value to set.
+
+      A DiscountGroup must be active for its CartDiscounts to be considered during discount application.
diff --git a/api-specs/api/types/error/MaxDiscountGroupsReachedError.raml b/api-specs/api/types/error/MaxDiscountGroupsReachedError.raml
@@ -0,0 +1,20 @@
+#%RAML 1.0 DataType
+(package): Error
+type: ErrorObject
+displayName: MaxDiscountGroupsReachedError
+discriminatorValue: MaxDiscountGroupsReached
+(beta): true
+description: |
+  Returned when a Discount Group cannot be created or activated as the [limit](/../api/limits#discount-groups) for active Discount Groups has been reached.
+
+  The error is returned as a failed response to:
+
+  - [Create DiscountGroup](ctp:api:endpoint:/{projectKey}/discount-groups:POST) request
+  - [Set IsActive](ctp:api:type:DiscountGroupSetIsActiveAction) update action
+properties:
+  code:
+    type: string
+  message:
+    type: string
+    description: |
+      `"Maximum number of active discount groups reached ($max)."`
diff --git a/api-specs/api/types/error/graphql/GraphQLMaxDiscountGroupsReachedError.raml b/api-specs/api/types/error/graphql/GraphQLMaxDiscountGroupsReachedError.raml
@@ -0,0 +1,16 @@
+#%RAML 1.0 DataType
+(package): Error
+type: GraphQLErrorObject
+displayName: GraphQLMaxDiscountGroupsReachedError
+discriminatorValue: MaxDiscountGroupsReached
+(beta): true
+description: |
+  Returned when a Discount Group cannot be created or activated as the [limit](/../api/limits#discount-groups) for active Discount Groups has been reached.
+
+  The error is returned as a failed response to:
+
+  - [Create DiscountGroup](ctp:api:endpoint:/{projectKey}/discount-groups:POST) request
+  - [Set IsActive](ctp:api:type:DiscountGroupSetIsActiveAction) update action
+properties:
+  code:
+    type: string
diff --git a/api-specs/api/types/message/DiscountGroupIsActiveSetMessage.raml b/api-specs/api/types/message/DiscountGroupIsActiveSetMessage.raml
@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(package): Message
+type: Message
+displayName: DiscountGroupIsActiveSetMessage
+discriminatorValue: DiscountGroupIsActiveSet
+(beta): true
+description: |
+  Generated after a successful [Set IsActive](ctp:api:type:DiscountGroupSetIsActiveAction) update action.
+properties:
+  isActive?:
+    type: boolean
+    description: |
+      `isActive` value of the [DiscountGroup](ctp:api:type:DiscountGroup) after the [Set IsActive](ctp:api:type:DiscountGroupSetIsActiveAction) update action.
+  oldIsActive?:
+    type: boolean
+    description: |
+      `isActive` value of the [DiscountGroup](ctp:api:type:DiscountGroup) before the [Set IsActive](ctp:api:type:DiscountGroupSetIsActiveAction) update action.
diff --git a/api-specs/api/types/message/payload/DiscountGroupIsActiveSetMessagePayload.raml b/api-specs/api/types/message/payload/DiscountGroupIsActiveSetMessagePayload.raml
@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(package): Message
+type: MessagePayload
+displayName: DiscountGroupIsActiveSetMessagePayload
+discriminatorValue: DiscountGroupIsActiveSet
+(beta): true
+description: |
+  Generated after a successful [Set IsActive](ctp:api:type:DiscountGroupSetIsActiveAction) update action.
+properties:
+  isActive?:
+    type: boolean
+    description: |
+      `isActive` value of the [DiscountGroup](ctp:api:type:DiscountGroup) after the [Set IsActive](ctp:api:type:DiscountGroupSetIsActiveAction) update action.
+  oldIsActive?:
+    type: boolean
+    description: |
+      `isActive` value of the [DiscountGroup](ctp:api:type:DiscountGroup) before the [Set IsActive](ctp:api:type:DiscountGroupSetIsActiveAction) update action.
diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml
@@ -523,6 +523,7 @@ DiscountGroupResourceIdentifier: !include discount-group/DiscountGroupResourceId
 DiscountGroupUpdate: !include discount-group/DiscountGroupUpdate.raml
 DiscountGroupUpdateAction: !include discount-group/DiscountGroupUpdateAction.raml
 DiscountGroupSetDescriptionAction: !include discount-group/updates/DiscountGroupSetDescriptionAction.raml
+DiscountGroupSetIsActiveAction: !include discount-group/updates/DiscountGroupSetIsActiveAction.raml
 DiscountGroupSetKeyAction: !include discount-group/updates/DiscountGroupSetKeyAction.raml
 DiscountGroupSetNameAction: !include discount-group/updates/DiscountGroupSetNameAction.raml
 DiscountGroupSetSortOrderAction: !include discount-group/updates/DiscountGroupSetSortOrderAction.raml
@@ -579,6 +580,7 @@ LanguageUsedInStoresError: !include error/LanguageUsedInStoresError.raml
 LockedFieldError: !include error/LockedFieldError.raml
 MatchingPriceNotFoundError: !include error/MatchingPriceNotFoundError.raml
 MaxCartDiscountsReachedError: !include error/MaxCartDiscountsReachedError.raml
+MaxDiscountGroupsReachedError: !include error/MaxDiscountGroupsReachedError.raml
 MaxResourceLimitExceededError: !include error/MaxResourceLimitExceededError.raml
 MaxStoreReferencesReachedError: !include error/MaxStoreReferencesReachedError.raml
 MissingRoleOnChannelError: !include error/MissingRoleOnChannelError.raml
@@ -662,6 +664,7 @@ GraphQLLanguageUsedInStoresError: !include error/graphql/GraphQLLanguageUsedInSt
 GraphQLLockedFieldError: !include error/graphql/GraphQLLockedFieldError.raml
 GraphQLMatchingPriceNotFoundError: !include error/graphql/GraphQLMatchingPriceNotFoundError.raml
 GraphQLMaxCartDiscountsReachedError: !include error/graphql/GraphQLMaxCartDiscountsReachedError.raml
+GraphQLMaxDiscountGroupsReachedError: !include error/graphql/GraphQLMaxDiscountGroupsReachedError.raml
 GraphQLMaxResourceLimitExceededError: !include error/graphql/GraphQLMaxResourceLimitExceededError.raml
 GraphQLMaxStoreReferencesReachedError: !include error/graphql/GraphQLMaxStoreReferencesReachedError.raml
 GraphQLMissingRoleOnChannelError: !include error/graphql/GraphQLMissingRoleOnChannelError.raml
@@ -1012,6 +1015,7 @@ DiscountCodeDeletedMessage: !include message/DiscountCodeDeletedMessage.raml
 DiscountCodeKeySetMessage: !include message/DiscountCodeKeySetMessage.raml
 DiscountGroupCreatedMessage: !include message/DiscountGroupCreatedMessage.raml
 DiscountGroupDeletedMessage: !include message/DiscountGroupDeletedMessage.raml
+DiscountGroupIsActiveSetMessage: !include message/DiscountGroupIsActiveSetMessage.raml
 DiscountGroupKeySetMessage: !include message/DiscountGroupKeySetMessage.raml
 DiscountGroupSortOrderSetMessage: !include message/DiscountGroupSortOrderSetMessage.raml
 InventoryEntryCreatedMessage: !include message/InventoryEntryCreatedMessage.raml
@@ -1339,6 +1343,7 @@ DiscountCodeDeletedMessagePayload: !include message/payload/DiscountCodeDeletedM
 DiscountCodeKeySetMessagePayload: !include message/payload/DiscountCodeKeySetMessagePayload.raml
 DiscountGroupCreatedMessagePayload: !include message/payload/DiscountGroupCreatedMessagePayload.raml
 DiscountGroupDeletedMessagePayload: !include message/payload/DiscountGroupDeletedMessagePayload.raml
+DiscountGroupIsActiveSetMessagePayload: !include message/payload/DiscountGroupIsActiveSetMessagePayload.raml
 DiscountGroupKeySetMessagePayload: !include message/payload/DiscountGroupKeySetMessagePayload.raml
 DiscountGroupSortOrderSetMessagePayload: !include message/payload/DiscountGroupSortOrderSetMessagePayload.raml
 InventoryEntryCreatedMessagePayload: !include message/payload/InventoryEntryCreatedMessagePayload.raml
diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl
@@ -4336,18 +4336,46 @@ type DiscountCodeDeleted implements MessagePayload {
 }
 
 input DiscountCodeDraft {
+  """
+  User-defined unique identifier for the DiscountCode that can be added to the Cart to apply the related CartDiscounts.
+  It cannot be modified after the DiscountCode is created.
+  """
   code: String!
+
+  "Name of the DiscountCode."
   name: [LocalizedStringItemInputType!]
+
+  "User-defined unique identifier for the DiscountCode."
   key: String
+
+  "The description of the DiscountCode."
   description: [LocalizedStringItemInputType!]
+
+  "Specify what CartDiscounts the API applies when you add the DiscountCode to the Cart."
   cartDiscounts: [ResourceIdentifierInput!]!
+
+  "Only active DiscountCodes can be applied to the Cart."
   isActive: Boolean = true
+
+  "Number of times the DiscountCode can be applied. If not set, the DiscountCode can be applied any number of times."
   maxApplications: Long
+
+  "Number of times the DiscountCode can be applied per Customer. If not set, the DiscountCode can be applied any number of times."
   maxApplicationsPerCustomer: Long
+
+  "DiscountCode can only be applied to Carts that match this predicate."
   cartPredicate: String
+
+  "Custom Fields for the DiscountCode."
   custom: CustomFieldsDraft
+
+  "Date and time (UTC) from which the DiscountCode is effective. Must be earlier than `validUntil`."
   validFrom: DateTime
+
+  "Date and time (UTC) until which the DiscountCode is effective. Must be later than `validFrom`."
   validUntil: DateTime
+
+  "Groups to which the DiscountCode will belong to."
   groups: [String!] = []
 }
 
@@ -4416,6 +4444,7 @@ type DiscountGroup implements Versioned {
   version: Long!
   key: String!
   sortOrder: String!
+  isActive: Boolean!
   name(
     "String is defined for different locales. This argument specifies the desired locale."
     locale: Locale,
@@ -4451,9 +4480,16 @@ input DiscountGroupDraft {
   key: String!
   sortOrder: String!
   name: [LocalizedStringItemInputType!]
+  isActive: Boolean = true
   description: [LocalizedStringItemInputType!]
 }
 
+type DiscountGroupIsActiveSet implements MessagePayload {
+  isActive: Boolean!
+  discountGroupId: String!
+  type: String!
+}
+
 type DiscountGroupKeySet implements MessagePayload {
   key: String!
   discountGroupId: String!
@@ -4490,6 +4526,7 @@ input DiscountGroupUpdateAction {
   setKey: SetDiscountGroupKey
   setSortOrder: SetDiscountGroupSortOrder
   setName: SetDiscountGroupName
+  setIsActive: SetDiscountGroupIsActive
   setDescription: SetDiscountGroupDescription
 }
 
@@ -8677,14 +8714,34 @@ type ProductDiscount implements Versioned & ReferenceExpandable {
 }
 
 input ProductDiscountDraft {
+  "Type of Discount and its corresponding value."
   value: ProductDiscountValueInput!
+
+  "A valid ProductDiscount Predicate."
   predicate: String!
+
+  """
+  Decimal value between 0 and 1 (passed as String literal) that defines the order of ProductDiscounts to apply in case more than one is applicable and active. A ProductDiscount with a higher `sortOrder` is prioritized.
+  The value must be **unique** among all ProductDiscounts in the Project.
+  """
   sortOrder: String!
+
+  "Name of the ProductDiscount."
   name: [LocalizedStringItemInputType!]!
+
+  "Description of the ProductDiscount."
   description: [LocalizedStringItemInputType!]
+
+  "Date and time (UTC) from which the Discount is effective."
   validFrom: DateTime
+
+  "Date and time (UTC) until which the Discount is effective."
   validUntil: DateTime
+
+  "Set to `true` to activate the ProductDiscount, set to `false` to deactivate it (even though the `predicate` matches)."
   isActive: Boolean = true
+
+  "User-defined unique identifier for the ProductDiscount."
   key: String
 }
 
@@ -12513,6 +12570,11 @@ input SetDiscountGroupDescription {
   description: [LocalizedStringItemInputType!]
 }
 
+"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
+input SetDiscountGroupIsActive {
+  isActive: Boolean!
+}
+
 "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
 input SetDiscountGroupKey {
   key: String!
@@ -14821,8 +14883,8 @@ input ShippingTargetDraft {
 }
 
 input ShippingTargetDraftType {
-  addressKey: String!
   quantity: Long!
+  addressKey: String!
   shippingMethodKey: String
 }
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "action": "setIsActive",
 +  "isActive": false
 +}
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,6 @@`
`6`	`6`	`"description": {`
`7`	`7`	`"en": "10% discount on all items in cart"`
`8`	`8`	`},`
`9`		`- "sortOrder": "0.01"`
	`9`	`+ "sortOrder": "0.01",`
	`10`	`+ "isActive": true`
`10`	`11`	`}`