You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/starter-kit/checkout/connect.md
-2Lines changed: 0 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -69,5 +69,3 @@ This option allows communication between Commerce and App Builder.
69
69
## Debugging requests
70
70
71
71
After following one of the connection options above, you can debug your application and access customized logs using the `LOG_LEVEL` environment variable. If this variable is set, logs from different phases of the commerce client display with detailed information.
72
-
73
-
<!-- What are options for log level variable??? -->
Copy file name to clipboardExpand all lines: src/pages/starter-kit/checkout/getting-started.md
+5-1Lines changed: 5 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ To begin using the checkout starter kit, ensure that your Adobe Commerce install
14
14
15
15
You must install or have access to the following prerequisites to develop with the Adobe Commerce checkout starter kit:
16
16
17
-
- Adobe Commerce version `2.4.4` or higher.
17
+
- Adobe Commerce as a Cloud Service or Adobe Commerce version `2.4.4` or higher.
18
18
19
19
-[Node.js](https://nodejs.org/) version 22. If you have Node Version Manager (`nvm`) installed, you can run the following command to install and use the required version:
20
20
@@ -29,6 +29,10 @@ You must install or have access to the following prerequisites to develop with t
29
29
30
30
## Install Commerce modules
31
31
32
+
<InlineAlertvariant="info"slots="text"/>
33
+
34
+
Adobe Commerce as a Cloud Service is preconfigured with all the required modules for the checkout starter kit. Cloud Service users can proceed by [configuring their local environment](#initial-configuration) or [configuring Commerce](./configure.md).
35
+
32
36
Before installing Commerce modules, ensure that you have the required credentials in `auth.json` with [access to the Adobe Commerce repository](https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/prerequisites/authentication-keys).
33
37
34
38
- Install the Out-of-Process Payment Extensions (OOPE) module on Adobe Commerce
Copy file name to clipboardExpand all lines: src/pages/starter-kit/checkout/use-cases.md
+27-15Lines changed: 27 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -66,9 +66,13 @@ the [AppBuilder Applications with Adobe I/O Events](https://developer.adobe.com/
66
66
67
67
You can also refer to the [Adobe I/O Events Webhook FAQ](https://developer.adobe.com/events/docs/support/faq/#webhook-faq) which contains information about how to handle event consumption, such as state of registration, retries, and debugging.
68
68
69
-
## Payment flow: Get order details from Adobe Commerce using the masked cart ID
69
+
## Payment
70
70
71
-
The following steps demonstrate the payment flow:
71
+
The checkout starter kit supports the following payments use cases. For more information, refer to [Payment methods](./configure.md#create-payment-methods) and the [Payment API reference](./payment-reference.md).
72
+
73
+
### Get order details with masked cart ID
74
+
75
+
The following steps demonstrate the payment flow for getting order details from Adobe Commerce using the masked cart ID:
72
76
73
77
1. The payment flow starts at the frontend. When checkout is completed, the frontend sends the masked cart ID to the payment gateway.
74
78
@@ -78,7 +82,7 @@ The following steps demonstrate the payment flow:
To perform a headless checkout and payment, the Commerce instance must ensure that the payment has succeeded and the order can be placed.
84
88
@@ -114,7 +118,9 @@ setPaymentMethodOnCart(
114
118
115
119
With this information persisted, you can configure an [Adobe Commerce Webhook](../../webhooks/index.md) so that every time an order is placed, a synchronous call dispatches to the App Builder application implementing the payment method to validate the payment.
116
120
117
-
To register a webhook, [modify the `webhooks.xml` file](../../webhooks/hooks.md) and create a new webhook with the following configuration:
121
+
To register a webhook in Adobe Commerce on Cloud or on-premises, [modify the `webhooks.xml` file](../../webhooks/hooks.md) and create a new webhook with the following configuration.
122
+
123
+
For Adobe Commerce as a Cloud Service, you can [create webhook in the Admin](../../webhooks/create-webhooks.md).
118
124
119
125
```yaml
120
126
Hook Settings
@@ -138,7 +144,7 @@ You can also enable webhook signature generation by following the [webhooks sign
138
144
139
145
Refer to [`actions/validate-payment.js`](https://github.com/adobe/commerce-checkout-starter-kit/blob/main/actions/validate-payment/index.js) for an example of how to receive the request and validate the payment according to the payment gateway needs.
140
146
141
-
## Payment methods: Filter out payment method
147
+
### Filter out payment method
142
148
143
149
In some cases, you may want to filter out a payment method based on the cart details or the customer's information. For example, you may want to disable a payment method based on customer group or product attributes in the cart.
144
150
@@ -209,7 +215,11 @@ Payload example:
209
215
210
216
You can find examples of how to filter out payment methods using customer data or product attributes in your App Builder application in [`actions/filter-payment.js`](https://github.com/adobe/commerce-checkout-starter-kit/blob/main/actions/filter-payment/index.js).
211
217
212
-
## Shipping methods
218
+
## Shipping
219
+
220
+
The checkout starter kit supports the following shipping use cases:
221
+
222
+
### Shipping methods
213
223
214
224
You can add shipping methods to the checkout process by using [webhooks](../../webhooks/index.md).
215
225
@@ -219,7 +229,9 @@ After the webhook is registered, every time a shopping cart is requested, a sync
219
229
220
230
Refer to [`actions/shipping-methods.js`](https://github.com/adobe/commerce-checkout-starter-kit/blob/main/actions/shipping-methods/index.js) for an example of how to process the request and return the list of available shipping methods.
221
231
222
-
To register a webhook, you need to create a `webhooks.xml` [configuration file](../../webhooks/xml-schema.md) in your module or in the root `app/etc` directory.
232
+
To register a webhook in Adobe Commerce on Cloud or on-premises, you need to create a `webhooks.xml` [configuration file](../../webhooks/xml-schema.md) in your module or in the root `app/etc` directory.
233
+
234
+
For Adobe Commerce as a Cloud Service, you can [create webhook in the Admin](../../webhooks/create-webhooks.md).
223
235
224
236
The following example demonstrates how to add a webhook to the `plugin.magento.out_of_process_shipping_methods.api.shipping_rate_repository.get_rates` method:
225
237
@@ -243,13 +255,7 @@ The following example demonstrates how to add a webhook to the `plugin.magento.o
243
255
244
256
You can register multiple webhooks for different shipping methods or shipping carriers by adding them into the same batch to ensure they are executed in parallel or create multiple batches to execute them sequentially.
245
257
246
-
### Remove shipping method
247
-
248
-
The `plugin.magento.out_of_process_shipping_methods.api.shipping_rate_repository.get_rates` webhook allows you to remove specific shipping methods from the list of available options.
249
-
250
-
If you use the `flatrate` shipping method, but want to disable it, you must update your webhook response to mark the shipping method as removed. This example is demonstrated in [`actions/shipping-methods.js`](https://github.com/adobe/commerce-checkout-starter-kit/blob/main/actions/shipping-methods/index.js).
251
-
252
-
## Shipping methods: Payload
258
+
#### Payload
253
259
254
260
The request payload contains information about all items in the cart, including product information, product attributes, shipping address, and customer information for logged-in customers.
255
261
@@ -327,7 +333,7 @@ Payload example:
327
333
328
334
You can find examples of how to use shipping addresses, customer data, and product attributes in your App Builder application in [`actions/shipping-methods.js`](https://github.com/adobe/commerce-checkout-starter-kit/blob/main/actions/shipping-methods/index.js).
329
335
330
-
## Shipping methods: GraphQL
336
+
#### GraphQL
331
337
332
338
In the `setShippingAddressesOnCart` mutation, available shipping methods that are returned by the webhook are appended to the `available_shipping_methods` field.
333
339
@@ -471,3 +477,9 @@ In the `setShippingMethodsOnCart` mutation, you can set the shipping method prov
471
477
}
472
478
}
473
479
```
480
+
481
+
### Remove shipping method
482
+
483
+
The `plugin.magento.out_of_process_shipping_methods.api.shipping_rate_repository.get_rates` webhook allows you to remove specific shipping methods from the list of available options.
484
+
485
+
If you use the `flatrate` shipping method, but want to disable it, you must update your webhook response to mark the shipping method as removed. This example is demonstrated in [`actions/shipping-methods.js`](https://github.com/adobe/commerce-checkout-starter-kit/blob/main/actions/shipping-methods/index.js).
0 commit comments