Browse Guides

Adobe Commerce Integration (Magento)
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide has multiple versions available:
<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the Adobe Commerce Integration?</strong></p><p><strong>- Enabling the Adobe Commerce Module</strong></p><p><strong>- Connecting to Adobe Commerce</strong></p><p><strong>- Users</strong></p><p><strong>- E-commerce Orders</strong></p><p><strong>- Halo Integrator</strong></p><p><br></p><p><br></p><p data-pasted="true"><strong><span style="font-size: 14pt;">What is the Adobe Commerce Integration?</span></strong></p><p>The Adobe Commerce integration allows users and their orders to be imported in Halo. Tickets can then be linked to these orders to track them.</p><p><br></p><p><strong><span style="font-size: 14pt;">Enabling the Adobe Commerce Module</span></strong></p><p>In Configuration &gt; Integrations, scroll to the &quot;E-commerce Orders&quot; section. Hover over the Adobe Commerce module, and click the plus icon to enable it.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFlNmZjZWYzLWZiZmMtNDE0Yy1hZjRjLWVhZDNlZTJmOTUyMyJ9.17BautYgrANFVQsvhaK5eHVczL1qcEPPQWneBJn2vXs" class="fr-fic fr-fil fr-dib" width="91" height="122"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the Adobe Commerce module</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to Adobe Commerce</span></strong></p><p>Clicking into the module, a button shows at the top to &quot;Add/Edit Connections&quot;. Click into this.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNkMzM5OTJmLTBjMTgtNDk5Mi1iY2U3LWVlOGU4MjMyMzQ2MiJ9.NIFMzrkA1jEN-nv5g7LJPS3vkttXTpTZjbm0aEI-2xw" class="fr-fic fr-fil fr-dib" width="1498" height="529"></p><p><strong><span style="font-size: 10pt;">Fig 2. Navigating to add a connection</span></strong></p><p><br></p><p>A list of any Adobe Commerce connections will show here, and multiple connections can be made. Click the &quot;New&quot; button to create one.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM0MDliNTIzLTMzNWUtNDlhNy05MzUzLWNiMzI5Nzk5ZTQ1MSJ9.YWJD5drIvt2wZm8OoIAZdr--3L-6fbBbJrtTNFEsaJA" class="fr-fic fr-fil fr-dib" width="1693" style="width: 1695px; height: 114.589px;" height="115"></p><p><strong><span style="font-size: 10pt;">Fig 3. List of Adobe Commerce connections</span></strong></p><p><br></p><p>Give the new connection a name, and add the URL of the Adobe Commerce site. Save the connection.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFkY2IxODBjLWI1MzEtNGM3Yy04OTU1LTc5ZTVhYTY1OWI0MCJ9.tP0Fgd12EPIno9G6H23KVH7uHn_Ni21Q9XZ0aFS0VW4" class="fr-fic fr-fil fr-dib" width="1390" height="692"></p><p><strong><span style="font-size: 10pt;">Fig 4. Adding the connection</span></strong></p><p><br></p><p data-pasted="true">A &quot;Callback URL&quot; and &quot;Identity link URL&quot; are given on this page that will be used to authorise the connection.</p><p><br></p><p>In Adobe Commerce, navigate to System &gt; Extensions &gt; Integrations and click &quot;Add New Integration&quot;.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlYjBkZWE0LWUxMzgtNDkwZS04OTY5LTllMTFmZWEyZGNmZSJ9.PT07iCrtRFDZ_IJgNxciRHH7o89y--0WYvo35wnTuTw" class="fr-fic fr-fil fr-dib" width="1528" style="width: 1530px; height: 417.208px;" height="417"></p><p><strong><span style="font-size: 10pt;">Fig 5. Integrations area in Adobe</span></strong></p><p><br></p><p>Give the integration a relevant name, i.e. Halo, and add the URLs into the corresponding fields here.&nbsp;</p><p><br></p><p>Enter your password to confirm your identity, and save.</p><p><br></p><p>The full length documentation from Adobe on creating an integration can be found <a href="https://experienceleague.adobe.com/en/docs/commerce-admin/systems/integrations" target="_blank" rel="noopener noreferrer"><strong>here</strong></a>.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM2ZDVmNWQ1LTIwYjktNDAxMy1iODgxLTBhODE0MjJiNjE0NyJ9.dXpKGGUAVTcCrtmFEDaWKtx-PYn6VGu3bOZNzsmPOC0" class="fr-fic fr-fil fr-dib" width="1497" style="width: 1499px; height: 792.189px;" height="792"></p><p><strong><span style="font-size: 10pt;">Fig 6. Creating the integration</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Users</span></strong></p><p>Before importing the orders, users need to be imported to match those orders against. Back on the main page of the module, open the &quot;Registered Customer Imports&quot; dropdown.&nbsp;</p><p><br></p><p>Set a default client/site for those users to be created under, then click &quot;Import Customers&quot; to import users under that site.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk1ZDJkOGFiLTYyZDktNDE5YS05ODIwLWYyYzdhYjMwNDk1YyJ9.A29Ev66LovxG-0a3oFGIsXBtLbDkgeIYVBb1JWIO4ec" class="fr-fic fr-fil fr-dib" width="1492" height="685"></p><p><strong><span style="font-size: 10pt;">Fig 7. Importing users&nbsp;</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">E-commerce Orders</span></strong></p><p>A tab will show on users for any E-commerce orders, either from Adobe Commerce or another e-commerce integration. This will show any orders associated with that user.</p><p><br></p><p><img data-fr-image-pasted="true" src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNlMDM1MDg5LWZlZmMtNGYwNC1iODZkLWE1YTBhYTljNGE4MCJ9.EZ038kio1o5NeQ6SDjTViDfOOu4eKq-NCGugGevcs4w" width="1698" height="176" data-pasted="true" style="box-sizing: inherit; border-style: none; cursor: pointer; padding: 0px 1px; user-select: none; text-align: left; color: rgb(0, 0, 0); font-family: sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; background-color: rgb(255, 255, 255); width: 1700px; height: 175.942px; max-width: none !important;" class="fr-fil fr-dib"></p><p><strong><span style="font-size: 10pt;">Fig 8. E-commerce tab on a user</span></strong></p><p><br></p><p>A dedicated area can also be enabled to show orders for all users in one screen. Within the module, select &quot;Enable the E-commerce Orders Area&quot;.</p><p><br></p><p><strong><em>Note: If this setting is enabled on any e-commerce integration and that integration&#39;s module is enabled, the area will show, even if disabled in another integration.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNjMzMzZjhiLWU1OTMtNDZiZC1hMjhhLWU1MTJlYzE2NWY3MCJ9.17k1lc61cVpP5NQx0bccblTuOXWCtB2kypkflIwwyqk" class="fr-fic fr-fil fr-dib" width="1494" height="784"></p><p><strong><span style="font-size: 10pt;">Fig 9. Enabling the E-commerce area</span></strong></p><p><br></p><p>The area will show within the module bar like this by default.</p><p><br></p><p><strong><em>Note: You will have to log out and in to see the area after enabling the setting and module.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjN2YyNGE2LTAzYTctNDdjNS04NjgwLTQ1MmQyMWJjZjNiZSJ9.Nd5cjaQ0rJhK54jBcdlJMGC2ROUVYRpDQnfsX0rx7n8" class="fr-fic fr-fil fr-dib" width="232" height="136"></p><p><strong><span style="font-size: 10pt;">Fig 10. E-commerce Orders area in the module navigation bar</span></strong></p><p><br></p><p>Orders can now be imported to show in this area and/or tab.</p><p><br></p><p>A date filter can be set to only import orders after a certain date.</p><p><em><strong>Note: This field does not save. If using the Halo Integrator to automatically import orders, this will not filter this and the integrator will bring in all orders.</strong></em></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjJhNWQ3MmQ0LTA1MGQtNDAzMS05ZDgzLWMyODc1NzI5NWU4NSJ9.RFcM1NfTJy58ZhC1d_bA0-SfQwSUyM2NZ6LncpFwRV4" class="fr-fic fr-fil fr-dib" width="1494" height="784"></p><p><strong><span style="font-size: 10pt;">Fig 11. Importing orders&nbsp;</span></strong></p><p><br></p><p>Orders will show in a table format within the area or tab. Orders can be linked to tickets from here by right clicking &gt; &quot;Show more details&quot;.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjkzZjgzZGVmLWNiNzUtNDM1OS04MmQ3LTE4YWRjZThlNjQwYSJ9.E7bduniAShamc-6YWAPt0kD3C-9_Gr9U7dd7KLe93bg" class="fr-fic fr-fil fr-dib" width="1695" style="width: 1697px; height: 148.07px;" height="148"></p><p><strong><span style="font-size: 10pt;">Fig 12. List of orders in the E-commerce Orders area</span></strong></p><p><br></p><p>A popup will show to link the order to a ticket, and multiple orders can be linked to one ticket. Enter the ticket ID, and click save at the bottom of the popup.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNhNGI4NWQyLTRiMjQtNDI0Mi05OTMyLWMzZTkxZmJiNzczNSJ9.rgRYiU8q9zmeS_5KYNqxTJbHQaj-KjIqPhn9hMm7T4k" class="fr-fic fr-fil fr-dib" width="720" height="193"></p><p><strong><span style="font-size: 10pt;">Fig 13. Linking an order to a ticket.</span></strong></p><p><br></p><p>The order information will then show in the &quot;E-commerce Orders&quot; tab on the ticket.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNjOTgyNzgyLTkxZmMtNDUwNC1hZWQ5LTRkOWVkYTBjYzQ3YyJ9.sfNlmrKeEzgu2T99VFM3-V6F_bJgdVoMY7aviG2dXgc" class="fr-fic fr-fil fr-dib" width="1312" height="158"></p><p><strong><span style="font-size: 10pt;">Fig 14. E-commerce Orders tab on a ticket</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Halo Integrator</span></strong></p><p>Users and orders can be imported on a recurring basis via the Halo Integrator.</p><p><br></p><p>Select &quot;Enable the Halo Integrator for the Adobe Commerce integration&quot;, then choose which entities to sync.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImUyNzEzOGIzLThiZTktNGYyMy1hYWIxLTkzMTBiNDJkZmVkYiJ9.P2fvhUcF8QhHB6acqu-uISSVaS2gVyCjnm3WbwfLBFk" class="fr-fic fr-fil fr-dib" width="1483" height="655"></p><p><strong><span style="font-size: 10pt;">Fig 15. Enabling the Halo Integrator</span></strong></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.