Skip to content

CEXT-6420: Adopt aio-commerce-sdk (bundle size, response & webhook helpers) #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iivvaannxx merged 6 commits into from
Jul 17, 2026
Merged

CEXT-6420: Adopt aio-commerce-sdk (bundle size, response & webhook helpers) #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0aee832
chore: reduce bundle size by removing aio-sdk
iivvaannxx Jul 16, 2026
f74bf70
docs: remove stale doc
iivvaannxx Jul 16, 2026
4931fb7
refactor: adopt aio-commerce-sdk response and webhook helpers
iivvaannxx Jul 17, 2026
58529fb
fix: differentiate event label and description in app.commerce.config
iivvaannxx Jul 17, 2026
148a413
fix: use human-readable labels for events instead of title-cased names
iivvaannxx Jul 17, 2026
03d0335
fix: remove apostrophes from event descriptions
iivvaannxx Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ Welcome to Adobe Commerce Integration Starter Kit.

Integrating an e-commerce platform with your ERP, OMS, or CRM is a mission-critical requirement. Companies can spend tens of thousands of dollars building these integrations. To reduce the cost of integrating with Enterprise Resource Planning (ERP) solutions and to improve the reliability of real-time connections, Adobe is introducing an integration starter kit for back-office integrations using Adobe Developer App Builder. The kit includes reference integrations for commonly used commerce data like orders, products, and customers. It also includes a standardized architecture for developers to build on following best practices.

The public documentation can be found at [Adobe Developer Starter Kit docs](https://developer.adobe.com/commerce/extensibility/starter-kit/integration/).

![Architecture Diagram](architecture.png "Architecture Diagram")

## Prerequisites
Expand Down Expand Up @@ -328,6 +326,7 @@ The starter kit comes with predefined events for each entity. Sometimes, you may
final: true
```
- Deploy the changes: `aio app deploy`
- Reinstall the application in App Management so the new event is wired up.

With these steps, you can consume the new event you added to the project.
If you want to change an existing event, make the changes in the same places:
Expand Down
104 changes: 62 additions & 42 deletions app.commerce.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ export default defineConfig({
events: [
{
name: "observer.catalog_product_delete_commit_after",
label: "Observer catalog product delete commit after",
description: "Observer catalog product delete commit after",
label: "Product Deleted",
description:
"Fires after a product is deleted in Commerce, used to sync the deletion to external systems",
fields: [
field("id"),
field("sku"),
Expand All @@ -37,8 +38,9 @@ export default defineConfig({
},
{
name: "observer.catalog_product_save_commit_after",
label: "Observer catalog product save commit after",
description: "Observer catalog product save commit after",
label: "Product Created or Updated",
description:
"Fires after a product is created or updated in Commerce, used to sync product changes to external systems",
fields: [
field("id"),
field("sku"),
Expand All @@ -54,8 +56,9 @@ export default defineConfig({
},
{
name: "observer.customer_save_commit_after",
label: "Observer customer save commit after",
description: "Observer customer save commit after",
label: "Customer Created or Updated",
description:
"Fires after a customer is created or updated in Commerce, used to sync customer changes to external systems",
fields: [
field("id"),
field("firstname"),
Expand All @@ -71,8 +74,9 @@ export default defineConfig({
},
{
name: "observer.customer_delete_commit_after",
label: "Observer customer delete commit after",
description: "Observer customer delete commit after",
label: "Customer Deleted",
description:
"Fires after a customer is deleted in Commerce, used to sync the deletion to external systems",
fields: [
field("id"),
field("firstname"),
Expand All @@ -83,8 +87,9 @@ export default defineConfig({
},
{
name: "observer.customer_group_save_commit_after",
label: "Observer customer group save commit after",
description: "Observer customer group save commit after",
label: "Customer Group Created or Updated",
description:
"Fires after a customer group is created or updated in Commerce, used to sync group changes to external systems",
fields: [
field("customer_group_code"),
field("tax_class_id"),
Expand All @@ -95,8 +100,9 @@ export default defineConfig({
},
{
name: "observer.customer_group_delete_commit_after",
label: "Observer customer group delete commit after",
description: "Observer customer group delete commit after",
label: "Customer Group Deleted",
description:
"Fires after a customer group is deleted in Commerce, used to sync the deletion to external systems",
fields: [
field("customer_group_code"),
field("customer_group_id"),
Expand All @@ -106,8 +112,9 @@ export default defineConfig({
},
{
name: "observer.sales_order_save_commit_after",
label: "Observer sales order save commit after",
description: "Observer sales order save commit after",
label: "Sales Order Created or Updated",
description:
"Fires after a sales order is created or updated in Commerce, used to sync order changes to external systems",
fields: [
field("id"),
field("increment_id"),
Expand All @@ -121,9 +128,9 @@ export default defineConfig({
},
{
name: "observer.cataloginventory_stock_item_save_commit_after",
label: "Observer cataloginventory stock item save commit after",
label: "Stock Item Updated",
description:
"Observer cataloginventory stock item save commit after",
"Fires after inventory data for a stock item is created or updated in Commerce, used to sync stock levels to external systems",
fields: [
field("item_id"),
field("product_id"),
Expand Down Expand Up @@ -172,80 +179,93 @@ export default defineConfig({
events: [
{
name: "be-observer.catalog_product_create",
label: "Be observer catalog product create",
description: "Be observer catalog product create",
label: "Backoffice Product Created",
description:
"Notifies Commerce that a product was created in the backoffice system",
runtimeActions: ["product-backoffice/created"],
},
{
name: "be-observer.catalog_product_update",
label: "Be observer catalog product update",
description: "Be observer catalog product update",
label: "Backoffice Product Updated",
description:
"Notifies Commerce that a product was updated in the backoffice system",
runtimeActions: ["product-backoffice/updated"],
},
{
name: "be-observer.catalog_product_delete",
label: "Be observer catalog product delete",
description: "Be observer catalog product delete",
label: "Backoffice Product Deleted",
description:
"Notifies Commerce that a product was deleted in the backoffice system",
runtimeActions: ["product-backoffice/deleted"],
},
{
name: "be-observer.customer_create",
label: "Be observer customer create",
description: "Be observer customer create",
label: "Backoffice Customer Created",
description:
"Notifies Commerce that a customer was created in the backoffice system",
runtimeActions: ["customer-backoffice/created"],
},
{
name: "be-observer.customer_update",
label: "Be observer customer update",
description: "Be observer customer update",
label: "Backoffice Customer Updated",
description:
"Notifies Commerce that a customer was updated in the backoffice system",
runtimeActions: ["customer-backoffice/updated"],
},
{
name: "be-observer.customer_delete",
label: "Be observer customer delete",
description: "Be observer customer delete",
label: "Backoffice Customer Deleted",
description:
"Notifies Commerce that a customer was deleted in the backoffice system",
runtimeActions: ["customer-backoffice/deleted"],
},
{
name: "be-observer.customer_group_create",
label: "Be observer customer group create",
description: "Be observer customer group create",
label: "Backoffice Customer Group Created",
description:
"Notifies Commerce that a customer group was created in the backoffice system",
runtimeActions: ["customer-backoffice/group-created"],
},
{
name: "be-observer.customer_group_update",
label: "Be observer customer group update",
description: "Be observer customer group update",
label: "Backoffice Customer Group Updated",
description:
"Notifies Commerce that a customer group was updated in the backoffice system",
runtimeActions: ["customer-backoffice/group-updated"],
},
{
name: "be-observer.customer_group_delete",
label: "Be observer customer group delete",
description: "Be observer customer group delete",
label: "Backoffice Customer Group Deleted",
description:
"Notifies Commerce that a customer group was deleted in the backoffice system",
runtimeActions: ["customer-backoffice/group-deleted"],
},
{
name: "be-observer.sales_order_status_update",
label: "Be observer sales order status update",
description: "Be observer sales order status update",
label: "Backoffice Order Status Updated",
description:
"Notifies Commerce that a sales order status was updated in the backoffice system",
runtimeActions: ["order-backoffice/updated"],
},
{
name: "be-observer.sales_order_shipment_create",
label: "Be observer sales order shipment create",
description: "Be observer sales order shipment create",
label: "Backoffice Order Shipment Created",
description:
"Notifies Commerce that a shipment was created for a sales order in the backoffice system",
runtimeActions: ["order-backoffice/shipment-created"],
},
{
name: "be-observer.sales_order_shipment_update",
label: "Be observer sales order shipment update",
description: "Be observer sales order shipment update",
label: "Backoffice Order Shipment Updated",
description:
"Notifies Commerce that a shipment was updated for a sales order in the backoffice system",
runtimeActions: ["order-backoffice/shipment-updated"],
},
{
name: "be-observer.catalog_stock_update",
label: "Be observer catalog stock update",
description: "Be observer catalog stock update",
label: "Backoffice Stock Updated",
description:
"Notifies Commerce that stock levels were updated in the backoffice system",
runtimeActions: ["stock-backoffice/updated"],
},
],
Expand Down
Loading
Loading