Mapping of REST services to storefront checkout actions
The Aurora starter store uses REST services throughout the checkout process. The actions for each page map to a REST service.
The following pages are included:
- Shopping cart page (B2C)
- Current order page (B2B)
- Shipping and billing method page (B2C)
- Shipping and billing method page (B2B)
- Order summary page (B2C)
- Order summary page (B2B)
- Quick order page
- Free gift page
- Quick checkout page
Note: The Free gift page is included only if the promotion type is available to
customers.
Shopping cart page (B2C)
Checkout actions:
Page action | HTTP URL | Sample parameters | More information |
---|---|---|---|
Change Attributes | POST AjaxRESTOrderItemDelete |
|
AjaxRESTOrderItemDelete deletes the order item for which the attributes need to be changed. |
POST AjaxRESTOrderItemAdd |
|
AjaxRESTOrderItemAdd adds a new order item using the SKU for the changed attributes. | |
Select your free gift | POST AjaxRESTOrderRewardOptionUpdate |
|
|
Continue Checkout | GET RESTOrderItemUpdate |
|
|
Logon and Checkout | POST Logon |
|
|
URL to API mapping:
URL | REST resource | REST method | Link to API | Command mapping |
---|---|---|---|---|
RESTOrderItemUpdate | cart | PUT /store/{storeId}/cart/@self/update_order_item | cart | OrderItemUpdateCmd |
RESTMoveOrderItem | cart | PUT /store/{storeId}/cart/move_order_item | cart | OrderItemMoveCmd |
AjaxRESTOrderItemDelete | cart | PUT /store/{storeId}/cart/@self/delete_order_item | cart | OrderItemUpdateCmd |
AjaxRESTOrderItemAdd | cart | POST /store/{storeId}/cart | cart | OrderItemAddCmd |
AjaxRESTOrderRewardOptionUpdate | cart | PUT /store/{storeId}/cart/@self/update_reward_option | cart | RewardChoiceUpdateCmd |
Current order page (B2B)
Checkout actions:
Page action | HTTP URL | Sample parameters | More information |
---|---|---|---|
Change Attributes | POST AjaxRESTOrderItemDelete |
|
AjaxRESTOrderItemDelete deletes the order item for which the attributes need to be changed. |
POST AjaxRESTOrderItemAdd |
|
AjaxRESTOrderItemAdd adds a new order item using the SKU for the changed attributes. | |
Select your free gift | POST AjaxRESTOrderRewardOptionUpdate |
|
AjaxRESTOrderRewardOptionUpdate adds the selected SKU as a free gift into the cart. |
Check out | GET RESTOrderItemUpdate |
|
|
URL to API mapping:
URL | REST resource | REST method | Link to API | Command mapping |
---|---|---|---|---|
RESTOrderItemUpdate | cart | PUT /store/{storeId}/cart/@self/update_order_item | cart | OrderItemUpdateCmd |
AjaxRESTOrderItemDelete | cart | PUT /store/{storeId}/cart/@self/delete_order_item | cart | OrderItemUpdateCmd |
AjaxRESTOrderItemAdd | cart | POST /store/{storeId}/cart | cart | OrderItemAddCmd |
AjaxRESTOrderRewardOptionUpdate | cart | PUT /store/{storeId}/cart/@self/update_reward_option | cart | RewardChoiceUpdateCmd |
Shipping and billing method page (B2C)
Checkout actions:
Page action | HTTP URL | Sample parameters | More information |
---|---|---|---|
Select your free gift | POST AjaxRESTOrderRewardOptionUpdate |
|
AjaxRESTOrderRewardOptionUpdate changes the SKU as a free gift in the cart. |
Apply promotion code | POST AjaxRESTPromotionCodeApply |
|
|
Next | POST AjaxRESTOrderPrepare |
|
AjaxRESTOrderPrepare finalizes the order, including price, shipping, tax, and promotions. Then, it locks the order so that it is ready for submission. |
POST AjaxRESTOrderPIAdd |
|
AjaxRESTOrderPIAdd creates a payment instruction, including payment method and amount. An order can be paid for using multiple payment methods, each covering part of the order total amount. |
URL to API mapping:
URL | REST resource | REST method | Link to API | Command mapping |
---|---|---|---|---|
AjaxRESTPromotionCodeApply | assigned_promotion_code | POST /store/{storeId}/cart/@self/assigned_promotion_code | assigned_promotion_code | PromotionCodeAddRemoveControllerCmd |
AjaxRESTOrderPrepare | cart | PUT /store/{storeId}/cart/@self/precheckout | cart | OrderPrepareCmd |
AjaxRESTOrderPIAdd | payment_instruction | POST /store/{storeId}/cart/@self/payment_instruction | payment_instruction | PIAddCmd |
AjaxRESTOrderRewardOptionUpdate | cart | PUT /store/{storeId}/cart/@self/update_reward_option | cart | RewardChoiceUpdateCmd |
Shipping and billing method page (B2B)
Checkout actions:
Page action | HTTP URL | Sample parameters | More information |
---|---|---|---|
Change your free gift | POST AjaxRESTOrderRewardOptionUpdate |
|
AjaxRESTOrderRewardOptionUpdate changes the SKU as a free gift in the cart. |
Apply promotion code | POST AjaxRESTPromotionCodeApply |
|
|
Next | POST AjaxRESTOrderPrepare |
|
AjaxRESTOrderPrepare finalizes the order, including price, shipping, tax, and promotions. Then, it locks the order so that it is ready for submission. |
POST AjaxRESTOrderPIAdd |
|
AjaxRESTOrderPIAdd creates a payment instruction, including payment method and amount. An order can be paid for using multiple payment methods, each covering part of the order total amount. |
URL to API mapping:
URL | REST resource | REST method | Link to API | Command mapping |
---|---|---|---|---|
AjaxRESTPromotionCodeApply | assigned_promotion_code | POST /store/{storeId}/cart/@self/assigned_promotion_code | assigned_promotion_code | PromotionCodeAddRemoveControllerCmd |
AjaxRESTOrderPrepare | cart | PUT /store/{storeId}/cart/@self/precheckout | cart | OrderPrepareCmd |
AjaxRESTOrderPIAdd | payment_instruction | POST /store/{storeId}/cart/@self/payment_instruction | payment_instruction | PIAddCmd |
AjaxRESTOrderRewardOptionUpdate | cart | PUT /store/{storeId}/cart/@self/update_reward_option | cart | RewardChoiceUpdateCmd |
Order summary page (B2C)
Checkout actions:
Page action | HTTP URL | Sample parameters | More information |
---|---|---|---|
Order | POST AjaxRESTOrderSubmit |
|
|
URL to API mapping:
URL | REST resource | REST method | Link to API | Command mapping |
---|---|---|---|---|
AjaxRESTOrderSubmit | cart | POST /store/{storeId}/cart/@self/checkout | cart | OrderProcessCmd |
Order summary page (B2B)
Checkout actions:
Page action | HTTP URL | Sample parameters | More information |
---|---|---|---|
Order | POST AjaxRESTOrderSubmit |
|
|
URL to API mapping:
URL | REST resource | REST method | Link to API | Command mapping |
---|---|---|---|---|
AjaxRESTOrderSubmit | cart | POST /store/{storeId}/cart/@self/checkout | cart | OrderProcessCmd |
Quick order page
Checkout actions:
Page action | HTTP URL | Sample parameters | More information |
---|---|---|---|
Order | POST AjaxRESTOrderAddPreConfigurationToCart |
|
AjaxRESTOrderAddPreConfigurationToCart adds an item into the shopping cart. The item can be a configured dynamic kit, but also can be a normal SKU. In this sample, it is a normal SKU. |
URL to API mapping:
URL | REST resource | REST method | Link to API | Command mapping |
---|---|---|---|---|
AjaxRESTOrderAddPreConfigurationToCart | cart | POST /store/{storeId}/cart/@self/add_preconfiguration_to_cart | cart | OrderProcessCmd |
Free gift page
Checkout actions:
Page action | HTTP URL | Sample parameters | More information |
---|---|---|---|
Apply | POST AjaxRESTOrderRewardOptionUpdate |
|
AjaxRESTOrderItemDelete adds the selected SKU as a free gift into the cart.. |
URL to API mapping:
URL | REST resource | REST method | Link to API | Command mapping |
---|---|---|---|---|
AjaxRESTOrderRewardOptionUpdate | cart | PUT /store/{storeId}/cart/@self/update_reward_option | cart | RewardChoiceUpdateCmd |
Quick checkout page
Checkout actions:
Page action | HTTP URL | Sample parameters | More information |
---|---|---|---|
Select shipping address | POST AjaxRESTOrderShipInfoUpdate |
|
|
Select shipping mode | POST AjaxRESTOrderShipInfoUpdate |
|
|
Apply promotion code | POST AjaxRESTPromotionCodeApply |
|
|
Back | GET RESTOrderCalculate |
|
Re-calculates the order, then forwards it to the Shopping Cart page. |
Next | POST AjaxRESTOrderPrepare |
|
AjaxRESTOrderPrepare finalizes the order, including price, shipping, tax, and promotions. Then, it locks the order so that it is ready for submission. |
POST AjaxRESTOrderPIAdd |
|
AjaxRESTOrderPIAdd creates a payment instruction, including payment method and amount. An order can be paid for using multiple payment methods, each covering part of the order total amount. |
URL to API mapping:
URL | REST resource | REST method | Link to API | Command mapping |
---|---|---|---|---|
AjaxRESTOrderShipInfoUpdate | assigned_promotion_code | POST /store/{storeId}/cart/@self/assigned_promotion_code | assigned_promotion_code | OrderItemUpdateCmd |
AjaxRESTPromotionCodeApply | cart | PUT /store/{storeId}/cart/@self/precheckout | cart | PromotionCodeAddRemoveControllerCmd |
RESTOrderCalculate | payment_instruction | POST /store/{storeId}/cart/@self/payment_instruction | payment_instruction | OrderCalculateCmd |
AjaxRESTOrderPrepare | cart | PUT /store/{storeId}/cart/@self/update_reward_option | cart | OrderPrepareCmd |
AjaxRESTOrderPIAdd | payment_instruction | POST /store/{storeId}/cart/@self/payment_instruction | payment_instruction | PIAddCmd |