Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit 9c2df52905e1 · 2026-03-09T10:14:20.000Z
diff --git a/api-specs/api/types/event/checkout/CheckoutOrderCreationFailedEvent.raml b/api-specs/api/types/event/checkout/CheckoutOrderCreationFailedEvent.raml
@@ -4,12 +4,12 @@ type: Event
 displayName: CheckoutOrderCreationFailedEvent
 description: |
   Generated when an order creation attempt fails in Checkout. This event includes information about why the order could not be created.
-example: !include ../../examples/Event/CheckoutOrderCreationFailed.json
+example: !include ../../../examples/Event/CheckoutOrderCreationFailed.json
 discriminatorValue: CheckoutOrderCreationFailed
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'checkout'
+    default: checkout
   data:
     type: CheckoutMessageOrderPayloadBaseData
     description: |
diff --git a/api-specs/api/types/event/checkout/CheckoutPaymentAuthorizationCancelledEvent.raml b/api-specs/api/types/event/checkout/CheckoutPaymentAuthorizationCancelledEvent.raml
@@ -4,12 +4,12 @@ type: Event
 displayName: CheckoutPaymentAuthorizationCancelledEvent
 description: |
   Generated when a payment authorization is successfully cancelled in Checkout. This event indicates that the payment is cancelled before it is charged.
-example: !include ../../examples/Event/CheckoutPaymentAuthorizationCancelled.json
+example: !include ../../../examples/Event/CheckoutPaymentAuthorizationCancelled.json
 discriminatorValue: CheckoutPaymentAuthorizationCancelled
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'checkout'
+    default: checkout
   data:
     type: CheckoutMessagePaymentsPayloadBaseData
     description: |
diff --git a/api-specs/api/types/event/checkout/CheckoutPaymentAuthorizationFailedEvent.raml b/api-specs/api/types/event/checkout/CheckoutPaymentAuthorizationFailedEvent.raml
@@ -4,12 +4,12 @@ type: Event
 displayName: CheckoutPaymentAuthorizationFailedEvent
 description: |
   Generated when an attempt to authorize a payment fails in Checkout. This failure could result from insufficient funds, incorrect payment details, expired cards, or risk related rejections.
-example: !include ../../examples/Event/CheckoutPaymentAuthorizationFailed.json
+example: !include ../../../examples/Event/CheckoutPaymentAuthorizationFailed.json
 discriminatorValue: CheckoutPaymentAuthorizationFailed
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'checkout'
+    default: checkout
   data:
     type: CheckoutMessagePaymentsPayloadBaseData
     description: |
diff --git a/api-specs/api/types/event/checkout/CheckoutPaymentAuthorizedEvent.raml b/api-specs/api/types/event/checkout/CheckoutPaymentAuthorizedEvent.raml
@@ -3,13 +3,13 @@
 type: Event
 displayName: CheckoutPaymentAuthorizedEvent
 description: |
-  Generated when a payment is successfully authorized in Checkout. This event indicates the payment has been validated and the amount has been reserved but not yet charged.
-example: !include ../../examples/Event/CheckoutPaymentAuthorized.json
+  Generated when a payment is successfully authorized in Checkout. This event indicates that the payment has been validated and the amount has been reserved but not yet charged.
+example: !include ../../../examples/Event/CheckoutPaymentAuthorized.json
 discriminatorValue: CheckoutPaymentAuthorized
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'checkout'
+    default: checkout
   data:
     type: CheckoutMessagePaymentsPayloadBaseData
     description: |
diff --git a/api-specs/api/types/event/checkout/CheckoutPaymentCancelAuthorizationFailedEvent.raml b/api-specs/api/types/event/checkout/CheckoutPaymentCancelAuthorizationFailedEvent.raml
@@ -4,12 +4,12 @@ type: Event
 displayName: CheckoutPaymentCancelAuthorizationFailedEvent
 description: |
   Generated when an attempt to cancel a payment authorization fails in Checkout. This could happen if the authorization has already been expired, been captured already or no longer valid.
-example: !include ../../examples/Event/CheckoutPaymentCancelAuthorizationFailed.json
+example: !include ../../../examples/Event/CheckoutPaymentCancelAuthorizationFailed.json
 discriminatorValue: CheckoutPaymentCancelAuthorizationFailed
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'checkout'
+    default: checkout
   data:
     type: CheckoutMessagePaymentsPayloadBaseData
     description: |
diff --git a/api-specs/api/types/event/checkout/CheckoutPaymentChargeFailedEvent.raml b/api-specs/api/types/event/checkout/CheckoutPaymentChargeFailedEvent.raml
@@ -4,12 +4,12 @@ type: Event
 displayName: CheckoutPaymentChargeFailedEvent
 description: |
   Generated when an attempt to charge a payment fails in Checkout. Even if a payment was previously authorized, charging it may still fail.
-example: !include ../../examples/Event/CheckoutPaymentChargeFailed.json
+example: !include ../../../examples/Event/CheckoutPaymentChargeFailed.json
 discriminatorValue: CheckoutPaymentChargeFailed
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'checkout'
+    default: checkout
   data:
     type: CheckoutMessagePaymentsPayloadBaseData
     description: |
diff --git a/api-specs/api/types/event/checkout/CheckoutPaymentChargedEvent.raml b/api-specs/api/types/event/checkout/CheckoutPaymentChargedEvent.raml
@@ -4,12 +4,12 @@ type: Event
 displayName: CheckoutPaymentChargedEvent
 description: |
   Generated when a payment is successfully charged in Checkout. This event indicates that the authorized amount has been successfully debited from your customer's account.
-example: !include ../../examples/Event/CheckoutPaymentChargedEvent.json
+example: !include ../../../examples/Event/CheckoutPaymentChargedEvent.json
 discriminatorValue: CheckoutPaymentCharged
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'checkout'
+    default: checkout
   data:
     type: CheckoutMessagePaymentsPayloadBaseData
     description: |
diff --git a/api-specs/api/types/event/checkout/CheckoutPaymentRefundFailedEvent.raml b/api-specs/api/types/event/checkout/CheckoutPaymentRefundFailedEvent.raml
@@ -4,12 +4,12 @@ type: Event
 displayName: CheckoutPaymentRefundFailedEvent
 description: |
   Generated when an attempt to refund a payment refund fails in Checkout. This failure indicates that the planned refund amount was not successfully sent to your customer’s account.
-example: !include ../../examples/Event/CheckoutPaymentRefundFailed.json
+example: !include ../../../examples/Event/CheckoutPaymentRefundFailed.json
 discriminatorValue: CheckoutPaymentRefundFailed
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'checkout'
+    default: checkout
   data:
     type: CheckoutMessagePaymentsPayloadBaseData
     description: |
diff --git a/api-specs/api/types/event/checkout/CheckoutPaymentRefundedEvent.raml b/api-specs/api/types/event/checkout/CheckoutPaymentRefundedEvent.raml
@@ -4,12 +4,12 @@ type: Event
 displayName: CheckoutPaymentRefundedEvent
 description: |
   Generated when a payment is successfully refunded in Checkout. This event confirms that the refund has been processed and sent to your customer.
-example: !include ../../examples/Event/CheckoutPaymentRefunded.json
+example: !include ../../../examples/Event/CheckoutPaymentRefunded.json
 discriminatorValue: CheckoutPaymentRefunded
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'checkout'
+    default: checkout
   data:
     type: CheckoutMessagePaymentsPayloadBaseData
     description: |
diff --git a/api-specs/api/types/event/import/ImportContainerCreatedEvent.raml b/api-specs/api/types/event/import/ImportContainerCreatedEvent.raml
@@ -4,11 +4,11 @@ type: Event
 displayName: ImportContainerCreatedEvent
 description: Generated when an [Import Container](ctp:import:type:ImportContainer) is created.
 discriminatorValue: ImportContainerCreated
-example: !include ../../examples/Event/ImportContainerCreatedEvent.json
+example: !include ../../../examples/Event/ImportContainerCreatedEvent.json
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'import-api'
+    default: import-api
   data:
     type: ImportContainerCreatedEventData
     description: |
diff --git a/api-specs/api/types/event/import/ImportContainerDeletedEvent.raml b/api-specs/api/types/event/import/ImportContainerDeletedEvent.raml
@@ -3,12 +3,12 @@
 type: Event
 displayName: ImportContainerDeletedEvent
 description: Generated when an [Import Container](ctp:import:type:ImportContainer) is deleted.
-example: !include ../../examples/Event/ImportContainerDeletedEvent.json
+example: !include ../../../examples/Event/ImportContainerDeletedEvent.json
 discriminatorValue: ImportContainerDeleted
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'import-api'
+    default: import-api
   data:
     type: ImportContainerDeletedEventData
     description: |
diff --git a/api-specs/api/types/event/import/ImportOperationRejectedEvent.raml b/api-specs/api/types/event/import/ImportOperationRejectedEvent.raml
@@ -3,12 +3,12 @@
 type: Event
 displayName: ImportOperationRejectedEvent
 description: Generated when an [Import Operation](ctp:import:type:ImportOperation) has the `rejected` [ProcessingState](ctp:import:type:ProcessingState).
-example: !include ../../examples/Event/ImportOperationRejectedEvent.json
+example: !include ../../../examples/Event/ImportOperationRejectedEvent.json
 discriminatorValue: ImportOperationRejected
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'import-api'
+    default: import-api
   data:
     type: ImportOperationRejectedEventData
     description: |
diff --git a/api-specs/api/types/event/import/ImportUnresolvedEvent.raml b/api-specs/api/types/event/import/ImportUnresolvedEvent.raml
@@ -4,11 +4,11 @@ type: Event
 displayName: ImportUnresolvedEvent
 discriminatorValue: ImportUnresolved
 description: Generated when an [Import Operation](ctp:import:type:ImportOperation) has the `unresolved` [ProcessingState](ctp:import:type:ProcessingState).
-example: !include ../../examples/Event/ImportUnresolvedEvent.json
+example: !include ../../../examples/Event/ImportUnresolvedEvent.json
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'import-api'
+    default: import-api
   data:
     type: ImportUnresolvedEventData
     description: |
diff --git a/api-specs/api/types/event/import/ImportValidationFailedEvent.raml b/api-specs/api/types/event/import/ImportValidationFailedEvent.raml
@@ -2,13 +2,13 @@
 (package): Event
 type: Event
 displayName: ImportValidationFailedEvent
-example: !include ../../examples/Event/ImportValidationFailedEvent.json
+example: !include ../../../examples/Event/ImportValidationFailedEvent.json
 description: Generated when an [Import Operation](ctp:import:type:ImportOperation) has the `validationFailed` [ProcessingState](ctp:import:type:ProcessingState).
 discriminatorValue: ImportValidationFailed
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'import-api'
+    default: import-api
   data:
     type: ImportValidationFailedEventData
     description: |
diff --git a/api-specs/api/types/event/import/ImportWaitForMasterVariantEvent.raml b/api-specs/api/types/event/import/ImportWaitForMasterVariantEvent.raml
@@ -2,13 +2,13 @@
 (package): Event
 type: Event
 displayName: ImportWaitForMasterVariantEvent
-example: !include ../../examples/Event/ImportWaitForMasterVariantEvent.json
+example: !include ../../../examples/Event/ImportWaitForMasterVariantEvent.json
 description: Generated when an [Import Operation](ctp:import:type:ImportOperation) has the `waitForMasterVariant` [ProcessingState](ctp:import:type:ProcessingState).
 discriminatorValue: ImportWaitForMasterVariant
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    default: 'import-api'
+    default: import-api
   data:
     type: ImportWaitForMasterVariantEventData
     description: |
diff --git a/api-specs/api/types/subscription/CloudEventsFormat.raml b/api-specs/api/types/subscription/CloudEventsFormat.raml
@@ -4,7 +4,8 @@ type: DeliveryFormat
 displayName: CloudEventsFormat
 discriminatorValue: CloudEvents
 description: |
-  The CloudEventsFormat can be used with any [Destination](#destination-1), and the payload is delivered in the `JSON Event Format`. [AzureEventGridDestination](ctp:api:type:AzureEventGridDestination) offers native support to filter and route CloudEvents.
+  The CloudEventsFormat can be used with any [Destination](ctp:api:type:Destination), and the payload is delivered in the `JSON Event Format`.
+  [AzureEventGridDestination](ctp:api:type:AzureEventGridDestination) offers native support to filter and route CloudEvents.
 properties:
   cloudEventsVersion:
     type: string
diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml
@@ -720,22 +720,17 @@ GraphQLStoreCartDiscountsLimitReachedError: !include error/graphql/GraphQLStoreC
 GraphQLSyntaxErrorError: !include error/graphql/GraphQLSyntaxErrorError.raml
 GraphQLValidityLockConflictError: !include error/graphql/GraphQLValidityLockConflictError.raml
 BaseEvent: !include event/BaseEvent.raml
-CheckoutOrderCreationFailedEvent: !include event/CheckoutOrderCreationFailedEvent.raml
-CheckoutPaymentAuthorizationCancelledEvent: !include event/CheckoutPaymentAuthorizationCancelledEvent.raml
-CheckoutPaymentAuthorizationFailedEvent: !include event/CheckoutPaymentAuthorizationFailedEvent.raml
-CheckoutPaymentAuthorizedEvent: !include event/CheckoutPaymentAuthorizedEvent.raml
-CheckoutPaymentCancelAuthorizationFailedEvent: !include event/CheckoutPaymentCancelAuthorizationFailedEvent.raml
-CheckoutPaymentChargeFailedEvent: !include event/CheckoutPaymentChargeFailedEvent.raml
-CheckoutPaymentChargedEvent: !include event/CheckoutPaymentChargedEvent.raml
-CheckoutPaymentRefundFailedEvent: !include event/CheckoutPaymentRefundFailedEvent.raml
-CheckoutPaymentRefundedEvent: !include event/CheckoutPaymentRefundedEvent.raml
 Event: !include event/Event.raml
-ImportContainerCreatedEvent: !include event/ImportContainerCreatedEvent.raml
-ImportContainerDeletedEvent: !include event/ImportContainerDeletedEvent.raml
-ImportOperationRejectedEvent: !include event/ImportOperationRejectedEvent.raml
-ImportUnresolvedEvent: !include event/ImportUnresolvedEvent.raml
-ImportValidationFailedEvent: !include event/ImportValidationFailedEvent.raml
-ImportWaitForMasterVariantEvent: !include event/ImportWaitForMasterVariantEvent.raml
+CheckoutOrderCreationFailedEvent: !include event/checkout/CheckoutOrderCreationFailedEvent.raml
+CheckoutPaymentAuthorizationCancelledEvent: !include event/checkout/CheckoutPaymentAuthorizationCancelledEvent.raml
+CheckoutPaymentAuthorizationFailedEvent: !include event/checkout/CheckoutPaymentAuthorizationFailedEvent.raml
+CheckoutPaymentAuthorizedEvent: !include event/checkout/CheckoutPaymentAuthorizedEvent.raml
+# yamllint disable-line rule:line-length
+CheckoutPaymentCancelAuthorizationFailedEvent: !include event/checkout/CheckoutPaymentCancelAuthorizationFailedEvent.raml
+CheckoutPaymentChargeFailedEvent: !include event/checkout/CheckoutPaymentChargeFailedEvent.raml
+CheckoutPaymentChargedEvent: !include event/checkout/CheckoutPaymentChargedEvent.raml
+CheckoutPaymentRefundFailedEvent: !include event/checkout/CheckoutPaymentRefundFailedEvent.raml
+CheckoutPaymentRefundedEvent: !include event/checkout/CheckoutPaymentRefundedEvent.raml
 CheckoutMessageOrderPayloadBaseData: !include event/data/CheckoutMessageOrderPayloadBaseData.raml
 CheckoutMessagePaymentsPayloadBaseData: !include event/data/CheckoutMessagePaymentsPayloadBaseData.raml
 ImportContainerCreatedEventData: !include event/data/ImportContainerCreatedEventData.raml
@@ -744,6 +739,12 @@ ImportOperationRejectedEventData: !include event/data/ImportOperationRejectedEve
 ImportUnresolvedEventData: !include event/data/ImportUnresolvedEventData.raml
 ImportValidationFailedEventData: !include event/data/ImportValidationFailedEventData.raml
 ImportWaitForMasterVariantEventData: !include event/data/ImportWaitForMasterVariantEventData.raml
+ImportContainerCreatedEvent: !include event/import/ImportContainerCreatedEvent.raml
+ImportContainerDeletedEvent: !include event/import/ImportContainerDeletedEvent.raml
+ImportOperationRejectedEvent: !include event/import/ImportOperationRejectedEvent.raml
+ImportUnresolvedEvent: !include event/import/ImportUnresolvedEvent.raml
+ImportValidationFailedEvent: !include event/import/ImportValidationFailedEvent.raml
+ImportWaitForMasterVariantEvent: !include event/import/ImportWaitForMasterVariantEvent.raml
 AWSLambdaDestination: !include extension/AWSLambdaDestination.raml
 AuthorizationHeaderAuthentication: !include extension/AuthorizationHeaderAuthentication.raml
 AzureFunctionsAuthentication: !include extension/AzureFunctionsAuthentication.raml
diff --git a/api-specs/import/api.raml b/api-specs/import/api.raml
@@ -180,7 +180,7 @@ traits:
       description: |
         Creates an Import Container in the Project.
 
-        Generates the [ImportContainerCreated](/projects/events#import-container-created-event) Event.
+        Generates the [ImportContainerCreated](ctp:api:type:ImportContainerCreatedEvent) Event.
       is:
         - secured_by_manage_import_containers
       body:
@@ -275,7 +275,7 @@ traits:
         description: |
           Deletes an Import Container in the Project.
 
-          Generates the [ImportContainerDeleted](/projects/events#import-container-deleted-event) Event.
+          Generates the [ImportContainerDeleted](ctp:api:type:ImportContainerDeletedEvent) Event.
         is:
           - secured_by_manage_import_containers
         responses:
diff --git a/api-specs/import/types/common.raml b/api-specs/import/types/common.raml
@@ -483,10 +483,10 @@ types:
     (annotations.enumDescriptions):
       processing: The initial state assigned if the request payload (JSON structure and fields) meets Import API specifications. The resource import is in progress.
       imported: The resource was successfully imported.
-      unresolved: The import request contains [KeyReferences](ctp:api:type:KeyReference) to resources that do not exist in your Composable Commerce Project. Generates the [ImportUnresolved](/projects/events#import-unresolved-event) Event.
-      validationFailed: Either the request payload is missing the data as per Import API specifications, or even though the references were resolved, the data does not meet validation constraints. Generates the [ImportValidationFailed](/projects/events#import-validation-failed-event) Event.
-      waitForMasterVariant: Products must have at least one Product Variant, also known as the Master Variant. If you import a Product without a Master Variant, the import request will have this status until another import request includes Master Variant data for the Product. Generates the [ImportWaitForMasterVariant](/projects/events#import-wait-for-master-variant-event) Event.
-      rejected: The resource could not be imported. References were resolved, but the system could not import the data due to an internal server error and the retry limit was reached. Generates the [ImportOperationRejected](/projects/events#import-operation-rejected-event) Event.
+      unresolved: The import request contains [KeyReferences](ctp:api:type:KeyReference) to resources that do not exist in your Composable Commerce Project. Generates the [ImportUnresolved](ctp:api:type:ImportUnresolvedEvent) Event.
+      validationFailed: Either the request payload is missing the data as per Import API specifications, or even though the references were resolved, the data does not meet validation constraints. Generates the [ImportValidationFailed](ctp:api:type:ImportValidationFailedEvent) Event.
+      waitForMasterVariant: Products must have at least one Product Variant, also known as the Master Variant. If you import a Product without a Master Variant, the import request will have this status until another import request includes Master Variant data for the Product. Generates the [ImportWaitForMasterVariant](ctp:api:type:ImportWaitForMasterVariantEvent) Event.
+      rejected: The resource could not be imported. References were resolved, but the system could not import the data due to an internal server error and the retry limit was reached. Generates the [ImportOperationRejected](ctp:api:type:ImportOperationRejectedEvent) Event.
       canceled: The import request was canceled and the resource was not imported.
     type: string
     enum:
