Ecommerce
Bring all of your customer’s purchases into the timeline with our ecommerce apps.Categories
Articles
Integrate with Recharge
Recharge is a subscription payments management platform that integrates with Shopify, and allows merchants to set up dynamic recurring billing for their storefronts.Integrate Recharge with Kustomer to allow agents to view subscription data from the Kustomer timeline and launch the Recharge dashboard.Who can access this feature?User typesAdmins can set up this integration.In this articlePrerequisitesHow does Recharge work with Kustomer?Create a Recharge API tokenInstall the Recharge appPrerequisitesBefore starting the integration process, you must already have a Shopify store set up in Recharge. You will also need to have access to the Recharge API. If this is your first time using the Recharge API, you will need to request access to this feature.How does Recharge work with Kustomer?Kustomer's Recharge integration involves a workflow that ingests a Recharge subscription object received via a webhook, which creates a custom object from that subscription. The resulting custom object is displayed to agents in the Kustomer timeline.Agents can view subscription data from the timeline or Insight Panel. Agents can also use the View in Recharge button in the timeline to launch their Recharge dashboard where they can manage the subscription.Note: This app integration can connect to one Recharge account. If you need recommendations for integrating with more than one Recharge account, please contact our support team.Create a Recharge API tokenThe first step in this integration will be to create an API token in Recharge for Kustomer to use.Sign in to your Recharge admin page, then go to Integrations > Enabled integrations > API tokens to create an API token for Kustomer that has Read access to Subscriptions and Customers. Leave this browser tab open to access the API token, as you will use it in Kustomer in the next step.Install the Recharge appNext, you'll install the Recharge app from within the Kustomer App Directory.Go to Appsand select Explore Directory.Search for Recharge in the App Directory, and then select Install.You'll be asked to provide some integration details. Paste the Recharge API token you created earlier where prompted.In the Shopify store subdomain field, enter the prefix of your Shopify URL and omit the .myshopify.com. For example, if your Shopify URL is https://acme-usa.myshopify.com, you would enter acme-usa.Select Install to finish setup and installation.With Recharge set up and installed, your agents will now be able to view Recharge subscription information from the Kustomer timeline.Integrate with BigCommerce
BigCommerce is an online shopping platform for established and rapidly-growing businesses. Integrate BigCommerce with Kustomer to see your customer's purchases in the Kustomer timeline.Who can access this feature?User typesAdmins can set up this integration.In this articlePrerequisitesHow does BigCommerce work with Kustomer?Install the BigCommerce appSet up BigCommerce APIConfigure BigCommerce with KustomerUpdated order eventsCreated order eventsFAQPrerequisitesBefore starting the integration process, you must already have a store set up in BigCommerce.How does BigCommerce work with Kustomer?Orders created or updated in BigCommerce are imported into Kustomer using an API subscription you'll create in Postman. Orders from BigCommerce will appear as a custom object with up to 10 custom fields on the customer timeline. This will display order information from BigCommerce, including order number and date, shipping and billing information, and products ordered.In addition, a BigCommerce insight card also displays summarized order details.Install the BigCommerce appTo integrate BigCommerce with Kustomer, install the BigCommerce app from within the Kustomer App Directory.Go to Apps and select Explore Directory.Search for BigCommerce in the App Directory, and then select Install.This app installs various components in your Kustomer Settings, in the following locations:Apps > BigCommerce (primary settings)Platform > Klasses > bigcommerce-order (Klass, attributes and KlassView)Platform > Workflows > App Created > big-commerce-ingest (ingests BigCommerce orders)Platform > Form Hooks > bigcommerce-1.0.1 (used with ingest workflow)Set up BigCommerce APIThen, use the BigCommerce API to create a webhook and API keys.Obtain Store API Credentials: generate a Store API key by going to Advanced Settings > API Accounts > API Keys and call this key Kustomer Integration.A popup titled BigCommerce API Credentials will appear and save a text file to your computer containing the Client ID and API Token. These two fields correspond directly to the BigCommerce client ID and BigCommerce API token fields in the Kustomer settings.Leave this window open while you return to the Kustomer Settings in another browser window.Back in Kustomer, Go to Apps and select BigCommerce in the sidebar. Copy the Client ID and API Token from the BigCommerce page into the corresponding fields in the Kustomer settings.In the BigCommerce settings, return to API Accounts > API Keys and select the Kustomer Integration key. Use the toggles in the OAuth Scopes section to grant read-only access to the Orders, Products, and Customers API resources.Locate the API Path field and note your store hash within the URL. The store hash is the alphanumeric value underlined in the screenshot below. Copy this alphanumeric store hash (not the entire URL) to the Kustomer Settings, into the BigCommerce store hash field.Configure BigCommerce with KustomerAfter you install the BigCommerce app, you'll need to create the Call Events Subscription using Postman. You'll be creating requests to subscribe to two types of BigCommerce events:Updated order eventsCreated order eventsTo make the request for updated order events:Open Postman.Make a POST request to https://api.bigcommerce.com/stores/store hash/v2/hooks where store hash is the alphanumeric value used earlier during the setup process.Select the Body tab and enter the following payload for updated order events:{ "scope": "store/order/updated","destination": "FORM HOOK URL GOES HERE","is_active": true }Note: In the payload, the destination is the hook address for the bigcommerce-1.0.1 form hook. This hook is automatically created when installing the app. You can locate and copy the address by going to Settings> Platform > Inbound Webhooks > Form Hooks, then select the More menu at the right.Select the Headers tab.In an empty row, type X-Auth-Token into the Key column, then for the Value enter the correct API key from the saved file.Repeat this process to add another header key named X-Auth-Client, with the corresponding saved value.Select Send to submit the request. Confirm that the payloads are correct by checking the hook logs and that orders are being created.To make the request for created order events:Open Postman.Make a POST request to https://api.bigcommerce.com/stores/store hash/v2/hooks where store hash is the alphanumeric value used earlier during the setup process.Select the Body tab and enter the following payload for updated order events:{ "scope": "store/order/created","destination": "FORM HOOK URL GOES HERE","is_active": true }Note: In the payload, the destination is the hook address for the bigcommerce-1.0.1 form hook. This hook is automatically created when installing the app. You can locate and copy the address by going to Settings> Platform > Inbound Webhooks > Form Hooks, then select the More menu at the right.Select the Headers tab.In an empty row, type X-Auth-Token into the Key column, then for the Value enter the correct API key from the saved file.Repeat this process to add another header key named X-Auth-Client, with the corresponding saved value.Select Send to submit the request. Confirm that the payloads are correct by checking the hook logs and that orders are being created.After following these steps, orders placed through your BigCommerce store will be shown in Kustomer under a customer's timeline.FAQQ: Are there any best practices for avoiding issues with importing orders?Yes, it's possible to see errors if an order is created then immediately updated. This occurs because when events occur simultaneously, the workflow might attempt to process the orders individually and create duplicate custom objects (KObjects).You should be able to avoid this as long as there's a short delay between creating and updating an order in BigCommerce. Once one of the two events processes the order payload and creates a custom object, subsequent events with that object should update without issue.Integrate with LoyaltyLion
LoyaltyLion is a data-driven loyalty and engagement platform. You can install the LoyaltyLion app to enable integration with Kustomer which updates and displays reward points data within customer profiles.Who can access this feature?User typesAdmins can set up this integration.In this articlePrerequisitesHow does LoyaltyLion work with Kustomer?Install the LoyaltyLion appSet up the webhook in the LoyaltyLion APIPrerequisitesYour organization must have a LoyaltyLion Classic, Advanced, or Plus account to set up this integration.How does LoyaltyLion work with Kustomer?In the Kustomer timeline, open the Customer Profile or Insights Panel to view LoyaltyLion tier, points, and rewards information. Install the LoyaltyLion appTo integrate LoyaltyLion with Kustomer, install the LoyaltyLion app from within the Kustomer App Directory.Go to Apps , search for LoyaltyLion in the App Directory, and then select Install.Go to Settings > Platform > Inbound Webhooks and select the Form Hooks tab. Locate the Sync LoyaltyLion customer points data hook, select the menu icon , and then select Copy Hook Address. This address will be used in the following step through the LoyaltyLion API.Set up the webhook in the LoyaltyLion APIUse the LoyaltyLion webhook API to register a webhook subscription using the POST action. This webhook subscription should contain the following properties:Topic: This should be entered as customers/updateAddress: Paste the copied hook address from the prior step here.Integrate with Adobe Commerce
The Adobe Commerce (formerly Magento) app integration syncs standard objects such as new addresses, customers, orders, invoices, credit memos (refunds), and shipments, in addition to real-time shopping cart info to populate your Kustomer organization. All data that exists within Adobe Commerce is stored inside of Kustomer and is fully available to support agents.Additional data sent from Adobe Commerce that is not readily displayed in the timeline in Kustomer is displayed in the raw data section so agents can view the full data manifest of each order.Who can access this feature?User typesAdmins can set up this integration.In this articleMigrate to the new version of the Adobe Commerce appPrerequisitesHow does Adobe Commerce work with Kustomer?Install the Adobe Commerce appSet up Kustomer as an integration in Adobe CommerceImport previous ordersLoggingTroubleshootingMigrate to the new version of the Adobe Commerce appNote: The following information is for customers who are currently using the Adobe Commerce integration.Before installing this version, uninstall your Adobe Commerce app from Kustomer. To do so:Go to Apps and select Installed Apps.Select Adobe Commerce and turn the App Active toggle off.Select Deactivate in the window that opens to confirm the deactivation.Then, remove the existing Kustomer extension from within your Adobe Commerce instance following guidance from Adobe Commerce. You can proceed with installing the upgraded app after you have deactivated the old app and removed the old extension. This upgraded version is identical in functionality to the previous Adobe Commerce integration. This version also provides enhanced stability and security and will allow you to access future releases and improvements from Kustomer.PrerequisitesYou must have an active Adobe Commerce web store with API access. This integration operates through the use of the Kustomer extension for Adobe Commerce (hosted on GitHub), which is only compatible with Adobe Commerce/Magento 2.x stores.This configuration requires you to be familiar with installing Adobe Commerce extensions from the command line. If this is your first time installing an extension in your Adobe Commerce store, we recommend familiarizing yourself with the following resource: Adobe Commerce DevDocs: Install an extension.How does Adobe Commerce work with Kustomer?Once you connect Kustomer to your Adobe Commerce store, all orders for a customer are synced in real-time, and order details appear in their timeline. This layout is created for you by default and cannot be deleted. You can perform actions on a customer's order from directly within their timeline. The following actions are available:Cancel will cancel the current order.Send Email sends the customer a confirmation email.Hold places a hold on the order. Invoice creates an order invoice.Refund creates an order credit memo.Ship creates an order shipment.You can also see the contents of your customer's shopping carts in Kustomer while you're providing them support. This is shown in an Insight Card when you're viewing a customer timeline. You can search for, and add, products to their shopping cart, along with updating the quantity or removing items from it. This card is created by default and cannot be deleted. Note: Users have to go to their checkout page to see the changes you make to their shopping cart from within Kustomer. If already on the checkout page, they should refresh it to see the changes.Install the Adobe Commerce appTo integrate Adobe Commerce with Kustomer, install the Adobe Commerce app from within the Kustomer App Directory.Go to Apps, search for Adobe Commerce in the App Directory, and then select Install.Select Install App to grant the permissions needed to run the app.Set up Kustomer as an integration in Adobe CommerceAfter installing the app, go to Apps > Adobe Commerce to view the information you'll need to finish setting up the integration in Adobe Commerce. Then:Log in to the Adobe Commerce dashboard as an admin.Go to System > Integrations and select Add New Integration.Enter kustomer in the Name box.From the Adobe Commerce settings page in Kustomer, copy and paste the following URLs into the boxes:Callback URLIdentity link URLEnter your Adobe Commerce password.Next, select API in the Basic Settings section in the left pane and select All from the Resource Access drop-down menu.Select Save.From the Integrations page, select Activate and then Allow on the page that opens. Any new orders you create in Adobe Commerce will appear in Kustomer.Note: This integration will not capture historical orders.Import previous ordersYou can import previous Adobe Commerce orders directly within Kustomer. Imported orders can be viewed in the customer's timeline.Go to Apps > Adobe Commerce.Enter the Start and End dates of the orders you want to import in the following format: YYYY-MM-DD.Select Import Orders.Any orders that fall within the date range will now be available in Kustomer. You can run an import multiple times if needed. We do not recommend you use the importer if you have thousands of orders, LoggingThe extension uses the standard logger that outputs to the directory /var/log in your Adobe Commerce project. Within this directory there should be the files exception.log and system.log. Because logs are stored on the file system, it makes silent failures due to misconfigurations or exceptions more likely.TroubleshootingQ: Where should I debug event payloads and statuses?View the kustomer_webhook_integration_events table in the Admin Magento Portal to debug outgoing event payloads and statuses.Q: Why aren't events being created?Ensure that orders and customers are created using the Customer Portal. The Admin Portal should not be used for this part of the process.Integrate with Loop
Loop is the exchange-first returns platform for scaling Shopify brands. This integration lets you connect Loop's return services with Kustomer so your team can see the latest information about Loop exchanges and returns directly from the timeline.Who can access this feature?User typesAdmins can set up this integration.In this articlePrerequisitesHow does Loop work with Kustomer?Create a Loop API keyInstall the Loop appSet up the webhook in LoopPrerequisitesTo set up Loop successfully, you must have an active Loop account connected to a Shopify store. Admins will also require developer or administrator privileges in Loop to set up this feature.How does Loop work with Kustomer?This integration connects Loop's return services with Kustomer, allowing your agents to see Returns and Labels created in Loop's system in the timeline. When a return or label is created in Loop, this integration will create or update a Loop KObject, which includes order change information, charge breakdowns, return/exchange items, and tracking info.Create a Loop API keyFirst, sign in to Loop as an administrator to create the API key to install the app in Kustomer.Go to https://admin.loopreturns.com/settings/developers. Select Generate API Key.Select Order and Return in the Scopes section.Enter a name for the key, such as Kustomer.Select Generate. Save this API key in a secure location. You will need it in the following step.Install the Loop appTo integrate Loop with Kustomer, install the Loop app from the Kustomer App Directory.Go to Apps , search for Loop in the App Directory, select Install, and confirm the installation.Enter the Loop API key that you created in the previous section.Select Install.Once the installation is complete, select Click to Copy at the bottom of the page to copy the form hook endpoint URL. You'll need this Kustomer hook URL in the next step of the setup process.Set up the webhook in LoopNext, configure outbound webhooks to post return data to Kustomer.Sign in to Loop as an administrator and go to Settings > Developers > Create webhook.You'll create 4 separate outbound webhooks for the following event types: Return created, Return updated, Label created, and Label updated.Note: The URL for all these hooks will be the form hook endpoint URL you copied from the Kustomer settings in the prior step. Fill out the fields for each webhook as follows:Return createdEvent: Return createdResponse: ReturnURL:form hook endpoint URLReturn updatedEvent: Return updatedResponse: ReturnURL:form hook endpoint URLLabel createdEvent: Label createdResponse: LabelURL:form hook endpoint URLLabel updatedEvent: Label updatedResponse: LabelURL:form hook endpoint URLClick Add to save each new webhook. Verify that the hook status appears as Active in the Webhooks list in Loop.To test each webhook, select the webhook in the list and then switch on Testing Mode.
Still need help? Contact Us