From 0323605b053596bf433f93aa53f00c55cd2d54a7 Mon Sep 17 00:00:00 2001 From: "ct-sdks[bot]" <153784748+ct-sdks[bot]@users.noreply.github.com> Date: Tue, 22 Oct 2024 07:29:57 +0000 Subject: [PATCH] Updated API from documentation release --- .../examples/message/ErrorInitBadConfigMessage.json | 5 +++-- .../examples/message/InfoOrderCreatedMessage.json | 3 ++- .../checkout/types/responses/AddDiscountCodeError.raml | 3 +++ .../checkout/types/responses/ApplicationDeactivated.raml | 3 +++ api-specs/checkout/types/responses/BadInputData.raml | 3 +++ .../types/responses/CartEmptiedDuringCheckout.raml | 3 +++ api-specs/checkout/types/responses/CartEmpty.raml | 3 +++ api-specs/checkout/types/responses/CartNotFound.raml | 3 +++ .../types/responses/CartWithExistingPayment.raml | 3 +++ .../checkout/types/responses/CheckoutCancelled.raml | 3 +++ .../checkout/types/responses/CheckoutCompleted.raml | 3 +++ api-specs/checkout/types/responses/CheckoutLoaded.raml | 3 +++ api-specs/checkout/types/responses/CheckoutStarted.raml | 3 +++ api-specs/checkout/types/responses/DeprecatedFields.raml | 3 +++ .../types/responses/DiscountCodeNotApplicable.raml | 3 +++ api-specs/checkout/types/responses/ExpiredSession.raml | 3 +++ .../responses/ExternalTermsAndConditionsPending.raml | 3 +++ api-specs/checkout/types/responses/InitError.raml | 3 +++ api-specs/checkout/types/responses/InitTimeout.raml | 3 +++ api-specs/checkout/types/responses/InvalidLocale.raml | 3 +++ api-specs/checkout/types/responses/InvalidMode.raml | 3 +++ api-specs/checkout/types/responses/Message.raml | 9 ++++++--- .../types/responses/MultipleVendorButtonContainers.raml | 3 +++ api-specs/checkout/types/responses/NoPaymentMethods.raml | 3 +++ .../checkout/types/responses/NoShippingMethods.raml | 3 +++ api-specs/checkout/types/responses/OrderCreated.raml | 3 +++ .../checkout/types/responses/OrderCreationError.raml | 3 +++ api-specs/checkout/types/responses/PaymentCancelled.raml | 3 +++ .../checkout/types/responses/PaymentConnectorError.raml | 3 +++ api-specs/checkout/types/responses/PaymentFailed.raml | 3 +++ .../checkout/types/responses/PaymentMethodLoaded.raml | 3 +++ .../checkout/types/responses/PaymentMethodLoading.raml | 3 +++ .../types/responses/PaymentMethodLoadingError.raml | 3 +++ .../checkout/types/responses/PaymentMethodSelected.raml | 3 +++ .../responses/PaymentMethodSelectionConfirmation.raml | 3 +++ .../PaymentMethodSelectionConfirmationFailed.raml | 3 +++ .../checkout/types/responses/PaymentMethodsReceived.raml | 3 +++ api-specs/checkout/types/responses/PaymentStarted.raml | 3 +++ .../types/responses/PaymentValidationFailed.raml | 3 +++ .../types/responses/PaymentValidationPassed.raml | 3 +++ .../types/responses/PaymentValidationStarted.raml | 3 +++ .../types/responses/PaymentVerificationStarted.raml | 3 +++ .../types/responses/PaymentVerificationTimeout.raml | 3 +++ .../checkout/types/responses/ProjectIsDeactivated.raml | 3 +++ .../types/responses/RemoveDiscountCodeError.raml | 3 +++ api-specs/checkout/types/responses/ResponseMessage.raml | 4 ++++ .../types/responses/SetShippingAddressError.raml | 3 +++ .../types/responses/ShippingAddressMissingError.raml | 3 +++ .../types/responses/ShippingMethodDoesNotMatchCart.raml | 3 +++ .../checkout/types/responses/UnavailableLocale.raml | 3 +++ .../checkout/types/responses/UnsupportedCountry.raml | 3 +++ api-specs/checkout/types/responses/UpdatedFields.raml | 5 ++++- 52 files changed, 160 insertions(+), 7 deletions(-) diff --git a/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json b/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json index 8f15154ea..abcfb3f7c 100644 --- a/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json +++ b/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json @@ -6,5 +6,6 @@ "project": { "key": "{projectKey}" } - } -} + }, + "correlationId": "spa/commercetools-checkout/1729263187262/565301612087128" +} \ No newline at end of file diff --git a/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json b/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json index 8ce8fcba7..3f29be468 100644 --- a/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json +++ b/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json @@ -6,5 +6,6 @@ "order": { "id": "{orderId}" } - } + }, + "correlationId": "spa/commercetools-checkout/1729263187262/565301612087128" } \ No newline at end of file diff --git a/api-specs/checkout/types/responses/AddDiscountCodeError.raml b/api-specs/checkout/types/responses/AddDiscountCodeError.raml index e74c84d1b..ea6eb2245 100644 --- a/api-specs/checkout/types/responses/AddDiscountCodeError.raml +++ b/api-specs/checkout/types/responses/AddDiscountCodeError.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Error adding discount code. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `error` object. diff --git a/api-specs/checkout/types/responses/ApplicationDeactivated.raml b/api-specs/checkout/types/responses/ApplicationDeactivated.raml index 497961e9a..3a480830d 100644 --- a/api-specs/checkout/types/responses/ApplicationDeactivated.raml +++ b/api-specs/checkout/types/responses/ApplicationDeactivated.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Application `{applicationKey}` for `{projectKey}` is disabled. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `project` and `application` objects with the related `key` property. diff --git a/api-specs/checkout/types/responses/BadInputData.raml b/api-specs/checkout/types/responses/BadInputData.raml index 5b3f71cd4..5d7b528fa 100644 --- a/api-specs/checkout/types/responses/BadInputData.raml +++ b/api-specs/checkout/types/responses/BadInputData.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Some fields are invalid. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `invalidFields` array of objects with the related `schema`, `path`, `value` and `message` properties. diff --git a/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml b/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml index 0e12ba7a1..0d118f233 100644 --- a/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml +++ b/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Cart `{cartId}` was emptied during checkout. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `cart` object with the `id` property. diff --git a/api-specs/checkout/types/responses/CartEmpty.raml b/api-specs/checkout/types/responses/CartEmpty.raml index fca632733..73dae55f7 100644 --- a/api-specs/checkout/types/responses/CartEmpty.raml +++ b/api-specs/checkout/types/responses/CartEmpty.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Cart `{cartId}` is empty. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `cart` object with the `id` property. diff --git a/api-specs/checkout/types/responses/CartNotFound.raml b/api-specs/checkout/types/responses/CartNotFound.raml index 7a85c6a71..5a4e591b4 100644 --- a/api-specs/checkout/types/responses/CartNotFound.raml +++ b/api-specs/checkout/types/responses/CartNotFound.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Cart for `{projectKey}` and session `{sessionId}` not found. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `project` and `session` objects with the related `key` and `id` properties. diff --git a/api-specs/checkout/types/responses/CartWithExistingPayment.raml b/api-specs/checkout/types/responses/CartWithExistingPayment.raml index fb2872479..dddf5860e 100644 --- a/api-specs/checkout/types/responses/CartWithExistingPayment.raml +++ b/api-specs/checkout/types/responses/CartWithExistingPayment.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Cart with existing approved payment. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `cart` object with the `id` property. diff --git a/api-specs/checkout/types/responses/CheckoutCancelled.raml b/api-specs/checkout/types/responses/CheckoutCancelled.raml index a6ef07be8..1831ff438 100644 --- a/api-specs/checkout/types/responses/CheckoutCancelled.raml +++ b/api-specs/checkout/types/responses/CheckoutCancelled.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Checkout cancelled. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/CheckoutCompleted.raml b/api-specs/checkout/types/responses/CheckoutCompleted.raml index c56b35121..58a2ebb3c 100644 --- a/api-specs/checkout/types/responses/CheckoutCompleted.raml +++ b/api-specs/checkout/types/responses/CheckoutCompleted.raml @@ -18,3 +18,6 @@ properties: payload: type: object description: Contains the `order` object with the `id` property. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/CheckoutLoaded.raml b/api-specs/checkout/types/responses/CheckoutLoaded.raml index d28439787..56707f6b4 100644 --- a/api-specs/checkout/types/responses/CheckoutLoaded.raml +++ b/api-specs/checkout/types/responses/CheckoutLoaded.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Checkout loaded. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/CheckoutStarted.raml b/api-specs/checkout/types/responses/CheckoutStarted.raml index 9f2515fcf..8f8959dc2 100644 --- a/api-specs/checkout/types/responses/CheckoutStarted.raml +++ b/api-specs/checkout/types/responses/CheckoutStarted.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Checkout started. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/DeprecatedFields.raml b/api-specs/checkout/types/responses/DeprecatedFields.raml index a4f5c522d..f9eebf795 100644 --- a/api-specs/checkout/types/responses/DeprecatedFields.raml +++ b/api-specs/checkout/types/responses/DeprecatedFields.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Some fields are deprecated. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `deprecatedFields` array. diff --git a/api-specs/checkout/types/responses/DiscountCodeNotApplicable.raml b/api-specs/checkout/types/responses/DiscountCodeNotApplicable.raml index bc8e56be7..7067375ca 100644 --- a/api-specs/checkout/types/responses/DiscountCodeNotApplicable.raml +++ b/api-specs/checkout/types/responses/DiscountCodeNotApplicable.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Discount code not applicable. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains string values for `cartId` and the given `discountCode`. diff --git a/api-specs/checkout/types/responses/ExpiredSession.raml b/api-specs/checkout/types/responses/ExpiredSession.raml index 09d55e7b1..ec9042ffd 100644 --- a/api-specs/checkout/types/responses/ExpiredSession.raml +++ b/api-specs/checkout/types/responses/ExpiredSession.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Session is expired. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/ExternalTermsAndConditionsPending.raml b/api-specs/checkout/types/responses/ExternalTermsAndConditionsPending.raml index b4ad320a9..60c3c80b3 100644 --- a/api-specs/checkout/types/responses/ExternalTermsAndConditionsPending.raml +++ b/api-specs/checkout/types/responses/ExternalTermsAndConditionsPending.raml @@ -15,3 +15,6 @@ properties: message: type: string description: External terms and conditions pending. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/InitError.raml b/api-specs/checkout/types/responses/InitError.raml index 4e35bf5cd..a269b5278 100644 --- a/api-specs/checkout/types/responses/InitError.raml +++ b/api-specs/checkout/types/responses/InitError.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Error during initialization. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/InitTimeout.raml b/api-specs/checkout/types/responses/InitTimeout.raml index 7193ee769..1222fc8f9 100644 --- a/api-specs/checkout/types/responses/InitTimeout.raml +++ b/api-specs/checkout/types/responses/InitTimeout.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Timeout error, no init message received. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/InvalidLocale.raml b/api-specs/checkout/types/responses/InvalidLocale.raml index 7f563a07d..28216036a 100644 --- a/api-specs/checkout/types/responses/InvalidLocale.raml +++ b/api-specs/checkout/types/responses/InvalidLocale.raml @@ -15,6 +15,9 @@ properties: message: type: string description: The provided `{locale}` is invalid. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the provided locale string, the related locale field (language or currency), and the used fallback one. diff --git a/api-specs/checkout/types/responses/InvalidMode.raml b/api-specs/checkout/types/responses/InvalidMode.raml index 75f579b46..5044f32d4 100644 --- a/api-specs/checkout/types/responses/InvalidMode.raml +++ b/api-specs/checkout/types/responses/InvalidMode.raml @@ -15,3 +15,6 @@ properties: message: type: string description: \`{mode}` mode requires an application with mode type `{modeTypeRequested}`. Current mode `{modeTypeReceived}`. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/Message.raml b/api-specs/checkout/types/responses/Message.raml index 6e199c67d..9c7581f1d 100644 --- a/api-specs/checkout/types/responses/Message.raml +++ b/api-specs/checkout/types/responses/Message.raml @@ -6,13 +6,16 @@ discriminator: code description: properties: code: - description: The Message code for the event. + description: Message code for the event. type: string severity: description: | - The severity level of the event. It can be `info`, `warn`, or `error`. + Severity level of the event. Can be `info`, `warn`, or `error`. type: string message: description: | - A human-readable description of the event. + Human-readable description of the event. type: string + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/MultipleVendorButtonContainers.raml b/api-specs/checkout/types/responses/MultipleVendorButtonContainers.raml index c422386af..d9d30c551 100644 --- a/api-specs/checkout/types/responses/MultipleVendorButtonContainers.raml +++ b/api-specs/checkout/types/responses/MultipleVendorButtonContainers.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Multiple vendor button containers detected, this may cause issues. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/NoPaymentMethods.raml b/api-specs/checkout/types/responses/NoPaymentMethods.raml index c81216759..d7988ef7a 100644 --- a/api-specs/checkout/types/responses/NoPaymentMethods.raml +++ b/api-specs/checkout/types/responses/NoPaymentMethods.raml @@ -15,3 +15,6 @@ properties: message: type: string description: There are no payment methods configured. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/NoShippingMethods.raml b/api-specs/checkout/types/responses/NoShippingMethods.raml index 496b15954..016ca907d 100644 --- a/api-specs/checkout/types/responses/NoShippingMethods.raml +++ b/api-specs/checkout/types/responses/NoShippingMethods.raml @@ -15,6 +15,9 @@ properties: message: type: string description: There are no shipping methods matching cart. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `cart` object with the `id` property. diff --git a/api-specs/checkout/types/responses/OrderCreated.raml b/api-specs/checkout/types/responses/OrderCreated.raml index 9f4b58865..7cb606ff9 100644 --- a/api-specs/checkout/types/responses/OrderCreated.raml +++ b/api-specs/checkout/types/responses/OrderCreated.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Order `{orderId}` created. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `order` object with the `id` property. diff --git a/api-specs/checkout/types/responses/OrderCreationError.raml b/api-specs/checkout/types/responses/OrderCreationError.raml index 3be9f3142..4805b6663 100644 --- a/api-specs/checkout/types/responses/OrderCreationError.raml +++ b/api-specs/checkout/types/responses/OrderCreationError.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Order creation failed with approved payment. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains `paymentReference`, `sessionId`, and the `errors` array of objects, with the related `code` and `message` properties. diff --git a/api-specs/checkout/types/responses/PaymentCancelled.raml b/api-specs/checkout/types/responses/PaymentCancelled.raml index ad1a7e780..e5880e992 100644 --- a/api-specs/checkout/types/responses/PaymentCancelled.raml +++ b/api-specs/checkout/types/responses/PaymentCancelled.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Payment cancelled. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/PaymentConnectorError.raml b/api-specs/checkout/types/responses/PaymentConnectorError.raml index 1ee07c8e2..e9d9e5feb 100644 --- a/api-specs/checkout/types/responses/PaymentConnectorError.raml +++ b/api-specs/checkout/types/responses/PaymentConnectorError.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Payment connector error. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `connector` object with the `id` property. diff --git a/api-specs/checkout/types/responses/PaymentFailed.raml b/api-specs/checkout/types/responses/PaymentFailed.raml index f156b27e2..63ee9d2fb 100644 --- a/api-specs/checkout/types/responses/PaymentFailed.raml +++ b/api-specs/checkout/types/responses/PaymentFailed.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Payment failed. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/PaymentMethodLoaded.raml b/api-specs/checkout/types/responses/PaymentMethodLoaded.raml index eead98886..404294700 100644 --- a/api-specs/checkout/types/responses/PaymentMethodLoaded.raml +++ b/api-specs/checkout/types/responses/PaymentMethodLoaded.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Payment method loaded. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `method` object with the `type` and `connectorId` properties. diff --git a/api-specs/checkout/types/responses/PaymentMethodLoading.raml b/api-specs/checkout/types/responses/PaymentMethodLoading.raml index 02f8121e8..56c47968c 100644 --- a/api-specs/checkout/types/responses/PaymentMethodLoading.raml +++ b/api-specs/checkout/types/responses/PaymentMethodLoading.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Payment method loading. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `method` object with the `type` and `connectorId` properties. diff --git a/api-specs/checkout/types/responses/PaymentMethodLoadingError.raml b/api-specs/checkout/types/responses/PaymentMethodLoadingError.raml index d339f03c9..f026cca32 100644 --- a/api-specs/checkout/types/responses/PaymentMethodLoadingError.raml +++ b/api-specs/checkout/types/responses/PaymentMethodLoadingError.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Payment method loading failed. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `method` object with the `type` and `connectorId` properties. diff --git a/api-specs/checkout/types/responses/PaymentMethodSelected.raml b/api-specs/checkout/types/responses/PaymentMethodSelected.raml index 476f72c2b..2c44167b1 100644 --- a/api-specs/checkout/types/responses/PaymentMethodSelected.raml +++ b/api-specs/checkout/types/responses/PaymentMethodSelected.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Payment method selected. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `method` object with the `type` and `hasVendorButton` properties. diff --git a/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmation.raml b/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmation.raml index 51f3d5a44..d04ece8c9 100644 --- a/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmation.raml +++ b/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmation.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Payment method selected. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `method` object with the `type` and `hasVendorButton` properties. diff --git a/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmationFailed.raml b/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmationFailed.raml index 61433555a..a16efa34e 100644 --- a/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmationFailed.raml +++ b/api-specs/checkout/types/responses/PaymentMethodSelectionConfirmationFailed.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Payment method selection failed. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `method` object with the `type` property. diff --git a/api-specs/checkout/types/responses/PaymentMethodsReceived.raml b/api-specs/checkout/types/responses/PaymentMethodsReceived.raml index c91f0b240..cc7261619 100644 --- a/api-specs/checkout/types/responses/PaymentMethodsReceived.raml +++ b/api-specs/checkout/types/responses/PaymentMethodsReceived.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Payment methods received. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `paymentMethods` array of objects with the `type` and `connectorId` properties. diff --git a/api-specs/checkout/types/responses/PaymentStarted.raml b/api-specs/checkout/types/responses/PaymentStarted.raml index deac087bd..b8b1aadfc 100644 --- a/api-specs/checkout/types/responses/PaymentStarted.raml +++ b/api-specs/checkout/types/responses/PaymentStarted.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Payment started. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `method` object with the `type` property. diff --git a/api-specs/checkout/types/responses/PaymentValidationFailed.raml b/api-specs/checkout/types/responses/PaymentValidationFailed.raml index 9c43806be..4314d9f44 100644 --- a/api-specs/checkout/types/responses/PaymentValidationFailed.raml +++ b/api-specs/checkout/types/responses/PaymentValidationFailed.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Payment validation failed. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/PaymentValidationPassed.raml b/api-specs/checkout/types/responses/PaymentValidationPassed.raml index 99c40610a..48f9ab963 100644 --- a/api-specs/checkout/types/responses/PaymentValidationPassed.raml +++ b/api-specs/checkout/types/responses/PaymentValidationPassed.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Payment validation passed. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/PaymentValidationStarted.raml b/api-specs/checkout/types/responses/PaymentValidationStarted.raml index 1255ed3ba..3f273dcc0 100644 --- a/api-specs/checkout/types/responses/PaymentValidationStarted.raml +++ b/api-specs/checkout/types/responses/PaymentValidationStarted.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Payment validation started. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/PaymentVerificationStarted.raml b/api-specs/checkout/types/responses/PaymentVerificationStarted.raml index 50c528aeb..09a6bf5b7 100644 --- a/api-specs/checkout/types/responses/PaymentVerificationStarted.raml +++ b/api-specs/checkout/types/responses/PaymentVerificationStarted.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Payment verification started. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/PaymentVerificationTimeout.raml b/api-specs/checkout/types/responses/PaymentVerificationTimeout.raml index 5035d5dd0..0d5747e29 100644 --- a/api-specs/checkout/types/responses/PaymentVerificationTimeout.raml +++ b/api-specs/checkout/types/responses/PaymentVerificationTimeout.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Payment verification timeout. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/ProjectIsDeactivated.raml b/api-specs/checkout/types/responses/ProjectIsDeactivated.raml index 6203f7850..d0b960ced 100644 --- a/api-specs/checkout/types/responses/ProjectIsDeactivated.raml +++ b/api-specs/checkout/types/responses/ProjectIsDeactivated.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Project `{projectKey}` is deactivated. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `project` object with the `key` property. diff --git a/api-specs/checkout/types/responses/RemoveDiscountCodeError.raml b/api-specs/checkout/types/responses/RemoveDiscountCodeError.raml index a850c9257..0688e3f59 100644 --- a/api-specs/checkout/types/responses/RemoveDiscountCodeError.raml +++ b/api-specs/checkout/types/responses/RemoveDiscountCodeError.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Error removing discount code. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `error` object. diff --git a/api-specs/checkout/types/responses/ResponseMessage.raml b/api-specs/checkout/types/responses/ResponseMessage.raml index 520582614..af1951812 100644 --- a/api-specs/checkout/types/responses/ResponseMessage.raml +++ b/api-specs/checkout/types/responses/ResponseMessage.raml @@ -11,3 +11,7 @@ properties: description: | Additional data about the event. type: object + correlationId: + description: | + Unique identifier of the event. + type: string diff --git a/api-specs/checkout/types/responses/SetShippingAddressError.raml b/api-specs/checkout/types/responses/SetShippingAddressError.raml index 339ad929e..c266b5d1f 100644 --- a/api-specs/checkout/types/responses/SetShippingAddressError.raml +++ b/api-specs/checkout/types/responses/SetShippingAddressError.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Error setting shipping address. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `errors` array of objects, with the related `code` and `message` properties. diff --git a/api-specs/checkout/types/responses/ShippingAddressMissingError.raml b/api-specs/checkout/types/responses/ShippingAddressMissingError.raml index d0925b15f..f20ff3b92 100644 --- a/api-specs/checkout/types/responses/ShippingAddressMissingError.raml +++ b/api-specs/checkout/types/responses/ShippingAddressMissingError.raml @@ -15,6 +15,9 @@ properties: message: type: string description: The shippingAddress field is missing for cart `{cartId}`. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `cart` object with the `id` property. diff --git a/api-specs/checkout/types/responses/ShippingMethodDoesNotMatchCart.raml b/api-specs/checkout/types/responses/ShippingMethodDoesNotMatchCart.raml index 095ef2e06..d40a5ac20 100644 --- a/api-specs/checkout/types/responses/ShippingMethodDoesNotMatchCart.raml +++ b/api-specs/checkout/types/responses/ShippingMethodDoesNotMatchCart.raml @@ -15,3 +15,6 @@ properties: message: type: string description: Selected shipping method no longer matches cart. + correlationId: + type: string + description: Unique identifier of the event. diff --git a/api-specs/checkout/types/responses/UnavailableLocale.raml b/api-specs/checkout/types/responses/UnavailableLocale.raml index c33296a6c..38f28dcf4 100644 --- a/api-specs/checkout/types/responses/UnavailableLocale.raml +++ b/api-specs/checkout/types/responses/UnavailableLocale.raml @@ -15,6 +15,9 @@ properties: message: type: string description: The provided locale `{locale}` is not available for translated definitions. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `locale` and the `fallback` properties. diff --git a/api-specs/checkout/types/responses/UnsupportedCountry.raml b/api-specs/checkout/types/responses/UnsupportedCountry.raml index 3daf76a5e..cac1ba5f1 100644 --- a/api-specs/checkout/types/responses/UnsupportedCountry.raml +++ b/api-specs/checkout/types/responses/UnsupportedCountry.raml @@ -15,6 +15,9 @@ properties: message: type: string description: Cart `{cartId}` has unsupported country. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object description: Contains the `cart` object with the `id` property, `shippingCountry`, `billingCountry`, and the `supportedCountries` array. diff --git a/api-specs/checkout/types/responses/UpdatedFields.raml b/api-specs/checkout/types/responses/UpdatedFields.raml index bf46ec80b..8499ef6d0 100644 --- a/api-specs/checkout/types/responses/UpdatedFields.raml +++ b/api-specs/checkout/types/responses/UpdatedFields.raml @@ -15,9 +15,12 @@ properties: message: type: string description: Some fields are invalid and have been updated. + correlationId: + type: string + description: Unique identifier of the event. payload: type: object - description: | + description: | Contains two arrays: - `invalidFields` contains a list of invalid fields with the related `schema`, `path`, `value` and `message` properties. - `updatedFields` contains the updated fields with its related `type`, `path` and `value` properties, where `type` can be `update`|`insert`|`delete`.