Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit aa83bf0cb274 · 2026-01-26T14:26:44.000Z
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountSetRecurringOrderScopeAction.json b/api-specs/api/examples/CartDiscount/CartDiscountSetRecurringOrderScopeAction.json
@@ -0,0 +1,12 @@
+{
+  "action": "setRecurringOrderScope",
+  "recurringOrderScope": {
+    "type": "ApplicableRecurrencePolicies",
+    "recurrencePolicies": [
+      {
+        "typeId": "recurrence-policy",
+        "id": "{{recurrence-policy-id}}"
+      }
+    ]
+  }
+}
diff --git a/api-specs/api/examples/cart-discount-updated.example.json b/api-specs/api/examples/cart-discount-updated.example.json
@@ -32,6 +32,9 @@
     }
   ],
   "stackingMode": "Stacking",
+  "recurringOrderScope": {
+    "type": "NonRecurringOrdersOnly"
+  },
   "requiresDiscountCode": true,
   "createdAt": "2024-11-21T13:08:15.962Z",
   "lastModifiedAt": "2024-12-21T13:08:15.962Z",
diff --git a/api-specs/api/examples/cart-discount.example.json b/api-specs/api/examples/cart-discount.example.json
@@ -32,6 +32,9 @@
     }
   ],
   "stackingMode": "Stacking",
+  "recurringOrderScope": {
+    "type": "NonRecurringOrdersOnly"
+  },
   "requiresDiscountCode": true,
   "createdAt": "2024-11-21T13:08:15.962Z",
   "lastModifiedAt": "2024-11-21T13:08:15.962Z",
diff --git a/api-specs/api/examples/cart-discounts.example.json b/api-specs/api/examples/cart-discounts.example.json
@@ -38,6 +38,9 @@
         }
       ],
       "stackingMode": "Stacking",
+      "recurringOrderScope": {
+        "type": "NonRecurringOrdersOnly"
+      },
       "requiresDiscountCode": true,
       "createdAt": "2024-11-21T13:08:15.962Z",
       "lastModifiedAt": "2024-11-21T13:08:15.962Z",
diff --git a/api-specs/api/types/cart-discount/CartDiscount.raml b/api-specs/api/types/cart-discount/CartDiscount.raml
@@ -110,3 +110,9 @@ properties:
     type: DiscountGroupReference
     description: |
       Reference to a DiscountGroup that the CartDiscount belongs to.
+  recurringOrderScope:
+    type: RecurringOrderScope
+    description: |
+      Scope of the Cart Discount for Recurring Orders.
+
+      The default is [NonRecurringOrdersOnly](ctp:api:type:NonRecurringOrdersOnly).
diff --git a/api-specs/api/types/cart-discount/CartDiscountDraft.raml b/api-specs/api/types/cart-discount/CartDiscountDraft.raml
@@ -83,3 +83,9 @@ properties:
     type: DiscountGroupResourceIdentifier
     description: |
       Reference to a DiscountGroup that the CartDiscount must belong to.
+  recurringOrderScope?:
+    type: RecurringOrderScopeDraft
+    description: |
+      Scope of the Cart Discount for Recurring Orders.
+
+      If not set, the default is [NonRecurringOrdersOnlyDraft](ctp:api:type:NonRecurringOrdersOnlyDraft).
diff --git a/api-specs/api/types/cart-discount/updates/CartDiscountSetRecurringOrderScopeAction.raml b/api-specs/api/types/cart-discount/updates/CartDiscountSetRecurringOrderScopeAction.raml
@@ -0,0 +1,13 @@
+#%RAML 1.0 DataType
+(package): CartDiscount
+type: CartDiscountUpdateAction
+displayName: CartDiscountSetRecurringOrderScopeAction
+discriminatorValue: setRecurringOrderScope
+example: !include ../../../examples/CartDiscount/CartDiscountSetRecurringOrderScopeAction.json
+description: |
+  Sets the scope of the Cart Discount for Recurring Orders.
+properties:
+  recurringOrderScope:
+    type: RecurringOrderScopeDraft
+    description: |
+      Scope of the Cart Discount for Recurring Orders.
diff --git a/api-specs/api/types/recurring-order/scope/AnyOrder.raml b/api-specs/api/types/recurring-order/scope/AnyOrder.raml
@@ -0,0 +1,7 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: RecurringOrderScope
+displayName: AnyOrder
+discriminatorValue: AnyOrder
+description: |
+  Cart Discounts are applied to recurring and non-recurring Orders.
diff --git a/api-specs/api/types/recurring-order/scope/AnyOrderDraft.raml b/api-specs/api/types/recurring-order/scope/AnyOrderDraft.raml
@@ -0,0 +1,7 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: RecurringOrderScopeDraft
+displayName: AnyOrderDraft
+discriminatorValue: AnyOrder
+description: |
+  Applies Cart Discounts to recurring and non-recurring Orders.
diff --git a/api-specs/api/types/recurring-order/scope/ApplicableRecurrencePolicies.raml b/api-specs/api/types/recurring-order/scope/ApplicableRecurrencePolicies.raml
@@ -0,0 +1,16 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: RecurringOrderScope
+displayName: ApplicableRecurrencePolicies
+discriminatorValue: ApplicableRecurrencePolicies
+description: |
+  Cart Discounts are applied to recurring Orders that match the Recurrence Policies.
+properties:
+  type:
+    type: string
+  recurrencePolicies:
+    type: RecurrencePolicyReference[]
+    minItems: 1
+    maxItems: 20
+    description: |
+      Recurrence Policies for which the Cart Discount is valid.
diff --git a/api-specs/api/types/recurring-order/scope/ApplicableRecurrencePoliciesDraft.raml b/api-specs/api/types/recurring-order/scope/ApplicableRecurrencePoliciesDraft.raml
@@ -0,0 +1,20 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: RecurringOrderScopeDraft
+displayName: ApplicableRecurrencePoliciesDraft
+discriminatorValue: ApplicableRecurrencePolicies
+description: |
+  Applies Cart Discounts to recurring Orders that match the Recurrence Policies.
+properties:
+  type:
+    type: string
+  recurrencePolicies:
+    type: RecurrencePolicyResourceIdentifier[]
+    minItems: 1
+    maxItems: 20
+    description: |
+      Recurrence Policies for which the Cart Discount is valid.
+
+      If a Recurrence Policy does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error will be returned.
+
+      If fewer or more Recurrence Policies are provided, an [InvalidOperation](ctp:api:type:InvalidOperationError) error will be returned.
diff --git a/api-specs/api/types/recurring-order/scope/NonRecurringOrdersOnly.raml b/api-specs/api/types/recurring-order/scope/NonRecurringOrdersOnly.raml
@@ -0,0 +1,7 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: RecurringOrderScope
+displayName: NonRecurringOrdersOnly
+discriminatorValue: NonRecurringOrdersOnly
+description: |
+  Cart Discounts are applied to non-recurring Orders.
diff --git a/api-specs/api/types/recurring-order/scope/NonRecurringOrdersOnlyDraft.raml b/api-specs/api/types/recurring-order/scope/NonRecurringOrdersOnlyDraft.raml
@@ -0,0 +1,7 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: RecurringOrderScopeDraft
+displayName: NonRecurringOrdersOnlyDraft
+discriminatorValue: NonRecurringOrdersOnly
+description: |
+  Applies Cart Discounts to non-recurring Orders.
diff --git a/api-specs/api/types/recurring-order/scope/RecurringOrderScope.raml b/api-specs/api/types/recurring-order/scope/RecurringOrderScope.raml
@@ -0,0 +1,10 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: object
+displayName: RecurringOrderScope
+discriminator: type
+description: |
+  Indicates the scope of Cart Discounts for recurring Orders.
+properties:
+  type:
+    type: string
diff --git a/api-specs/api/types/recurring-order/scope/RecurringOrderScopeDraft.raml b/api-specs/api/types/recurring-order/scope/RecurringOrderScopeDraft.raml
@@ -0,0 +1,10 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: object
+displayName: RecurringOrderScopeDraft
+discriminator: type
+description: |
+  Defines the scope of Cart Discounts for recurring Orders.
+properties:
+  type:
+    type: string
diff --git a/api-specs/api/types/recurring-order/scope/RecurringOrdersOnly.raml b/api-specs/api/types/recurring-order/scope/RecurringOrdersOnly.raml
@@ -0,0 +1,7 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: RecurringOrderScope
+displayName: RecurringOrdersOnly
+discriminatorValue: RecurringOrdersOnly
+description: |
+  Cart Discounts are applied to recurring Orders.
diff --git a/api-specs/api/types/recurring-order/scope/RecurringOrdersOnlyDraft.raml b/api-specs/api/types/recurring-order/scope/RecurringOrdersOnlyDraft.raml
@@ -0,0 +1,7 @@
+#%RAML 1.0 DataType
+(package): RecurringOrder
+type: RecurringOrderScopeDraft
+displayName: RecurringOrdersOnlyDraft
+discriminatorValue: RecurringOrdersOnly
+description: |
+  Applies Cart Discounts to recurring Orders.
diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml
@@ -185,6 +185,7 @@ CartDiscountSetCustomTypeAction: !include cart-discount/updates/CartDiscountSetC
 CartDiscountSetDescriptionAction: !include cart-discount/updates/CartDiscountSetDescriptionAction.raml
 CartDiscountSetDiscountGroupAction: !include cart-discount/updates/CartDiscountSetDiscountGroupAction.raml
 CartDiscountSetKeyAction: !include cart-discount/updates/CartDiscountSetKeyAction.raml
+CartDiscountSetRecurringOrderScopeAction: !include cart-discount/updates/CartDiscountSetRecurringOrderScopeAction.raml
 CartDiscountSetStoresAction: !include cart-discount/updates/CartDiscountSetStoresAction.raml
 CartDiscountSetValidFromAction: !include cart-discount/updates/CartDiscountSetValidFromAction.raml
 CartDiscountSetValidFromAndUntilAction: !include cart-discount/updates/CartDiscountSetValidFromAndUntilAction.raml
@@ -2320,6 +2321,16 @@ RecurringOrderUpdate: !include recurring-order/RecurringOrderUpdate.raml
 RecurringOrderUpdateAction: !include recurring-order/RecurringOrderUpdateAction.raml
 SkipConfiguration: !include recurring-order/SkipConfiguration.raml
 SkipConfigurationDraft: !include recurring-order/SkipConfigurationDraft.raml
+AnyOrder: !include recurring-order/scope/AnyOrder.raml
+AnyOrderDraft: !include recurring-order/scope/AnyOrderDraft.raml
+ApplicableRecurrencePolicies: !include recurring-order/scope/ApplicableRecurrencePolicies.raml
+ApplicableRecurrencePoliciesDraft: !include recurring-order/scope/ApplicableRecurrencePoliciesDraft.raml
+NonRecurringOrdersOnly: !include recurring-order/scope/NonRecurringOrdersOnly.raml
+NonRecurringOrdersOnlyDraft: !include recurring-order/scope/NonRecurringOrdersOnlyDraft.raml
+RecurringOrderScope: !include recurring-order/scope/RecurringOrderScope.raml
+RecurringOrderScopeDraft: !include recurring-order/scope/RecurringOrderScopeDraft.raml
+RecurringOrdersOnly: !include recurring-order/scope/RecurringOrdersOnly.raml
+RecurringOrdersOnlyDraft: !include recurring-order/scope/RecurringOrdersOnlyDraft.raml
 RecurringOrderSetCustomFieldAction: !include recurring-order/updates/RecurringOrderSetCustomFieldAction.raml
 RecurringOrderSetCustomTypeAction: !include recurring-order/updates/RecurringOrderSetCustomTypeAction.raml
 RecurringOrderSetExpiresAtAction: !include recurring-order/updates/RecurringOrderSetExpiresAtAction.raml
diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl
@@ -682,6 +682,26 @@ enum AnonymousCartSignInMode {
   UseAsNewActiveCustomerCart
 }
 
+"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
+type AnyOrder implements RecurringOrderScope {
+  type: RecurringOrderScopeType!
+}
+
+input AnyOrderInput {
+  dummy: String
+}
+
+"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
+type ApplicableRecurrencePolicies implements RecurringOrderScope {
+  recurrencePolicies: [RecurrencePolicy!]!
+  type: RecurringOrderScopeType!
+  recurrencePoliciesRef: [Reference!]!
+}
+
+input ApplicableRecurrencePoliciesInput {
+  recurrencePolicies: [ResourceIdentifierInput!]!
+}
+
 type Applied implements OrderEditResult {
   excerptBeforeEdit: OrderExcerpt!
   excerptAfterEdit: OrderExcerpt!
@@ -1904,6 +1924,7 @@ type CartDiscount implements Versioned & ReferenceExpandable {
   lastModifiedAt: DateTime!
   createdBy: Initiator
   lastModifiedBy: Initiator
+  recurringOrderScope: RecurringOrderScope!
 }
 
 type CartDiscountCreated implements MessagePayload {
@@ -1931,6 +1952,7 @@ input CartDiscountDraft {
   key: String
   stores: [ResourceIdentifierInput!]
   discountGroup: ResourceIdentifierInput
+  recurringOrderScope: RecurringOrderScopeInput
 }
 
 type CartDiscountLimitWithCurrent implements LimitWithCurrent {
@@ -2036,6 +2058,7 @@ input CartDiscountUpdateAction {
   setValidFromAndUntil: SetCartDiscountValidFromAndUntil
   setValidUntil: SetCartDiscountValidUntil
   setDiscountGroup: SetCartDiscountDiscountGroup
+  setRecurringOrderScope: SetCartDiscountRecurringOrderScope
 }
 
 interface CartDiscountValue {
@@ -7377,6 +7400,15 @@ type NestedAttributeDefinitionType implements AttributeDefinitionType {
   name: String!
 }
 
+"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
+type NonRecurringOrdersOnly implements RecurringOrderScope {
+  type: RecurringOrderScopeType!
+}
+
+input NonRecurringOrdersOnlyInput {
+  dummy: String
+}
+
 type NotProcessed implements OrderEditResult {
   type: String!
 }
@@ -11237,6 +11269,25 @@ type RecurringOrderScheduleSet implements MessagePayload {
   type: String!
 }
 
+"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
+interface RecurringOrderScope {
+  type: RecurringOrderScopeType!
+}
+
+input RecurringOrderScopeInput {
+  AnyOrder: AnyOrderInput
+  RecurringOrdersOnly: RecurringOrdersOnlyInput
+  NonRecurringOrdersOnly: NonRecurringOrdersOnlyInput
+  ApplicableRecurrencePolicies: ApplicableRecurrencePoliciesInput
+}
+
+enum RecurringOrderScopeType {
+  AnyOrder
+  NonRecurringOrdersOnly
+  RecurringOrdersOnly
+  ApplicableRecurrencePolicies
+}
+
 type RecurringOrderStartsAtSet implements MessagePayload {
   startsAt: DateTime!
   oldStartsAt: DateTime!
@@ -11285,6 +11336,15 @@ input RecurringOrderUpdateAction {
   transitionState: TransitionRecurringOrderState
 }
 
+"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
+type RecurringOrdersOnly implements RecurringOrderScope {
+  type: RecurringOrderScopeType!
+}
+
+input RecurringOrdersOnlyInput {
+  dummy: String
+}
+
 type Reference {
   typeId: String!
   id: String!
@@ -12629,6 +12689,10 @@ input SetCartDiscountKey {
   key: String
 }
 
+input SetCartDiscountRecurringOrderScope {
+  recurringOrderScope: RecurringOrderScopeInput!
+}
+
 input SetCartDiscountStores {
   stores: [ResourceIdentifierInput!]
 }
