Pull from Adobe Commerce¶
Adobe Commerce is a digital commerce and order management platform that allows customers to build multichannel ecommerce experiences on a single platform. Adobe Commerce uses MySQL for database management.
Adobe Commerce is source of high quality data for both customer records and interaction records, including:
Customer profiles
Customer addresses
Customer group
Order details
The addresses to which orders are shipped
The items within each order
Note
Adobe Commerce was previously known as Magento.
This topic describes the steps that are required to pull customer profiles and transaction histories to Amperity from Adobe Commerce:
Get details¶
Adobe Commerce requires the following configuration details:
The hostname or IP address for the Adobe Commerce storefront. |
|
Adobe Commerce uses OAuth-based credentials , which requires all of the following settings:
|
Tip
Use SnapPass to securely share configuration details for Adobe Commerce between your company and your Amperity representative.
Configure credentials¶
The following steps describe how to configure Amperity to connect to Adobe Commerce.
Important
These steps may require administrator access to Adobe Commerce. Configure this data source in a sandbox, verify the workflow, and then push these changes to your Amperity production tenant.
To configure credentials
Open the Sources tab to configure credentials for Adobe Commerce. Click the Add courier button to open the Add courier dialog box. Do one of the following to select Adobe Commerce:
|
|
Credentials allow Amperity to connect to Adobe Commerce and must exist before a courier can be configured to pull data from Adobe Commerce. Select an existing credential from the Credential drop-down, and then click Continue. |
|
Add the hostname or IP address for the Adobe Commerce storefront, the consumer key and consumer secret, and the access token and access token secret. When finished, click Continue. |
Add data source and feeds¶
A courier brings data from an external system to Amperity.
To add a courier
Open the Sources page to configure a destination for Adobe Commerce. Click the Add courier button to open the Add courier dialog box. Do one of the following to select Adobe Commerce:
|
|
Credentials allow Amperity to connect to Adobe Commerce and must exist before a courier can be configured to pull data from Adobe Commerce. Select an existing credential from the Credential drop-down, and then click Continue. |
|
On the Add courier page, under Select data to ingest, enable one (or more) data sets to pull to Amperity:
When finished, click Create. |
|
From the Sources tab, open the menu for the courier, and then select Run. The Run Courier dialog box opens. Select a time period to be run, and then click Run. |
|
After running the Adobe Commerce courier it will create a series of feeds and domain tables. Review the records for each domain table to ensure the right data was loaded from Adobe Commerce and that any semantic tags for customer profiles and transactions are applied correctly for your tenant. Select a time period to be run, and then click Run. |
Review feeds and domain tables¶
After running the Adobe Commerce courier it will create a series of feeds and domain tables. Review the records for each domain table to ensure the right data was loaded from Adobe Commerce.
Customers¶
The feed and domain table for customer details will contain the following fields:
CREATED_AT
CREATED_IN
DEFAULT_BILLING
DEFAULT_SHIPPING
DISABLE_AUTO_GROUP_CHANGE
EMAIL
ENTITY_ID
FIRSTNAME
GROUP_ID
LASTNAME
STORE_ID
UPDATED_AT
WEBSITE_ID
You may choose to apply customer profile semantic tags to the columns in this table.
Customer address¶
The feed and domain table for customer addresses will contain the following fields:
CITY
COUNTRY_ID
ENTITY_ID
FIRSTNAME
LASTNAME
PARENT_ID
POSTCODE
REGION
REGION_ID
STREET
TELEPHONE
UPDATED_AT
You may choose to apply customer profile semantic tags to the columns in this table.
Customer group¶
The feed and domain table for customer group will contain the following fields:
CODE
CUSTOMER_GROUP_ID
TAX_CLASS_ID
TAX_CLASS_NAME
VIP_DATA
Orders¶
The feed and domain table for orders will contain the following fields:
ADJUSTMENT_NEGATIVE
ADJUSTMENT_POSITIVE
APPLIED_RULE_IDS
BASE_ADJUSTMENT_NEGATIVE
BASE_ADJUSTMENT_POSITIVE
BASE_CURRENCY_CODE
BASE_DISCOUNT_AMOUNT
BASE_DISCOUNT_CANCELED
BASE_DISCOUNT_INVOICED
BASE_DISCOUNT_REFUNDED
BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT
BASE_DISCOUNT_TAX_COMPENSATION_INVOICED
BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED
BASE_GRAND_TOTAL
BASE_SHIPPING_AMOUNT
BASE_SHIPPING_CANCELED
BASE_SHIPPING_DISCOUNT_AMOUNT
BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT
BASE_SHIPPING_INCL_TAX
BASE_SHIPPING_INVOICED
BASE_SHIPPING_REFUNDED
BASE_SHIPPING_TAX_AMOUNT
BASE_SHIPPING_TAX_REFUNDED
BASE_SUBTOTAL
BASE_SUBTOTAL_CANCELED
BASE_SUBTOTAL_INVOICED
BASE_SUBTOTAL_REFUNDED
BASE_TAX_AMOUNT
BASE_TAX_CANCELED
BASE_TAX_INVOICED
BASE_TAX_REFUNDED
BASE_TO_GLOBAL_RATE
BASE_TO_ORDER_RATE
BASE_TOTAL_CANCELED
BASE_TOTAL_DUE
BASE_TOTAL_INVOICED
BASE_TOTAL_INVOICED_COST
BASE_TOTAL_ONLINE_REFUNDED
BASE_TOTAL_REFUNDED
BASE_TOTAL_PAID
BILLING_ADDRESS_ID
COUPON_CODE
CREATED_AT
CUSTOMER_GENDER
CUSTOMER_EMAIL
CUSTOMER_FIRSTNAME
CUSTOMER_GROUP_ID
CUSTOMER_ID
CUSTOMER_IS_GUEST
CUSTOMER_LASTNAME
CUSTOMER_NOTE_NOTIFY
DISCOUNT_AMOUNT
DISCOUNT_CANCELED
DISCOUNT_DESCRIPTION
DISCOUNT_INVOICED
DISCOUNT_REFUNDED
DISCOUNT_TAX_COMPENSATION_AMOUNT
DISCOUNT_TAX_COMPENSATION_INVOICED
DISCOUNT_TAX_COMPENSATION_REFUNDED
EMAIL_SENT
ENTITY_ID
GLOBAL_CURRENCY_CODE
GRAND_TOTAL
INCREMENT_ID
IS_VIRTUAL
ORDER_CURRENCY_CODE
PROTECT_CODE
QUOTE_ID
REMOTE_IP
STATUS
SHIPPING_AMOUNT
SHIPPING_DESCRIPTION
SHIPPING_CANCELED
SHIPPING_DISCOUNT_AMOUNT
SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT
SHIPPING_INCL_TAX
SHIPPING_INVOICED
SHIPPING_REFUNDED
SHIPPING_TAX_AMOUNT
SHIPPING_TAX_REFUNDED
STATE
STORE_CURRENCY_CODE
STORE_NAME
STORE_ID
STORE_TO_BASE_RATE
STORE_TO_ORDER_RATE
SUBTOTAL
SUBTOTAL_CANCELED
SUBTOTAL_INCL_TAX
SUBTOTAL_INVOICED
SUBTOTAL_REFUNDED
TAX_AMOUNT
TAX_CANCELED
TAX_INVOICED
TAX_REFUNDED
TOTAL_CANCELED
TOTAL_DUE
TOTAL_INVOICED
TOTAL_ITEM_COUNT
TOTAL_ONLINE_REFUNDED
TOTAL_PAID
TOTAL_QTY_ORDERED
TOTAL_REFUNDED
UPDATED_AT
WEIGHT
X_FORWARDED_FOR
You may choose to apply itemized transaction semantic tags to the columns in this table.
Order address¶
The feed and domain table for order address will contain the following fields:
ADDRESS_TYPE
CITY
COMPANY
COUNTRY_ID
CUSTOMER_ADDRESS_ID
EMAIL
ENTITY_ID
FIRSTNAME
LASTNAME
PARENT_ID
POSTCODE
QUOTE_ADDRESS_ID
REGION
REGION_CODE
REGION_ID
STREET
TELEPHONE
You may choose to apply customer profile semantic tags to the columns in this table.
Order items¶
The feed and domain table for order items will contain the following fields:
AMOUNT_REFUNDED
BASE_AMOUNT_REFUNDED
BASE_DISCOUNT_AMOUNT
BASE_DISCOUNT_INVOICED
BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT
BASE_DISCOUNT_TAX_COMPENSATION_INVOICED
BASE_ORIGINAL_PRICE
BASE_PRICE
BASE_PRICE_INCL_TAX
BASE_ROW_INVOICED
BASE_ROW_TOTAL
BASE_ROW_TOTAL_INCL_TAX
BASE_TAX_AMOUNT
BASE_TAX_INVOICED
CREATED_AT
DISCOUNT_AMOUNT
DISCOUNT_INVOICED
DISCOUNT_PERCENT
DISCOUNT_TAX_COMPENSATION_AMOUNT
DISCOUNT_TAX_COMPENSATION_CANCELED
FREE_SHIPPING
IS_QTY_DECIMAL
IS_VIRTUAL
ITEM_ID
NAME
NO_DISCOUNT
ORDER_ID
ORIGINAL_PRICE
PARENT_ITEM_ID
PRODUCT_ID
PRODUCT_OPTION
PRODUCT_TYPE
QTY_CANCELED
QTY_ORDERED
QTY_INVOICED
QTY_REFUNDED
QTY_RETURNED
QTY_SHIPPED
QUOTE_ITEM_ID
ROW_INVOICED
ROW_TOTAL
PRICE
PRICE_INCL_TAX
ROW_WEIGHT
ROW_TOTAL_INCL_TAX
SKU
STORE_ID
TAX_AMOUNT
TAX_CANCELED
TAX_INVOICED
TAX_PERCENT
UPDATED_AT
WEEE_TAX_APPLIED
WEIGHT
You may choose to apply itemized transaction semantic tags to the columns in this table.