{"id":56905,"date":"2023-05-12T06:10:19","date_gmt":"2023-05-12T05:10:19","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=56905"},"modified":"2023-05-29T07:28:36","modified_gmt":"2023-05-29T06:28:36","slug":"configuring-the-shopify-action","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/integrations\/configuring-the-shopify-action\/","title":{"rendered":"Configuring the Shopify Action"},"content":{"rendered":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row type_default valign_top\"><div class=\"vc_col-sm-12 wpb_column vc_column_container\"><div class=\"vc_column-inner\"><div class=\"wpb_wrapper\"><div class=\"ult-spacer spacer-6ae86fe9e96f7\" data-id=\"6ae86fe9e96f7\" data-height=\"10\" data-height-mobile=\"10\" data-height-tab=\"10\" data-height-tab-portrait=\"\" data-height-mobile-landscape=\"\" style=\"clear:both;display:block;\"><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>The Kore.ai XO Platform lets you easily connect your Shopify Shop instance to find information regarding Customers, Products, and Orders.<\/p>\n<p>This document explains how to authorize and enable the Shopify action and install the pre-built templates.<\/p>\n<h2><span class=\"ez-toc-section\" id=\"Authorizations_Supported\">Authorizations Supported<\/span><\/h2>\n<p>The Kore.ai XO Platform supports basic authentication to allow Shopify integration to exchange data. For more information, read the <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/advanced-topics\/authorization\/bot-authentication\/\">Bot Authorization Overview<\/a> article.<\/p>\n<p>The Kore.ai XO Platform supports the following authorization types for the Shopify integration:<\/p>\n<ul>\n<li><strong>Pre-Authorize the Integration<\/strong> &#8211; To make the integration process smoother for developers and customers, you can pre-authorize it by providing the necessary authorization credentials to obtain the access token.<\/li>\n<li><strong>Allow Users to Authorize the Integration<\/strong> &#8211; This method requires the end user to provide credentials during the conversation for authorization. This authorization process involves requesting permission for Kore.ai&#8217;s Shopify app to access an access token at runtime. To learn more about Shopify account types, see <a href=\"https:\/\/www.shopify.com\/in\/blog\/topics\/guides\">Shopify Documentation<\/a>.<\/li>\n<\/ul>\n<h2><span class=\"ez-toc-section\" id=\"Step_1_Enable_the_Shopify_Action\">Step 1: Enable the Shopify Action<\/span><\/h2>\n<p><strong>Prerequisites<\/strong>:<\/p>\n<p>Before enabling the Shopify action, complete the following prerequisites:<\/p>\n<ul>\n<li>Create a custom app for a store in the Shopify admin page.<\/li>\n<li>Authenticate the custom app by installing the app.<\/li>\n<li>Generate API credentials and the necessary API access tokens. Refer this link for more information related to custom apps:- <a href=\"https:\/\/help.shopify.com\/en\/manual\/apps\/app-types\/custom-apps\">Shopify custom apps<\/a>.<\/li>\n<li>Configure the app with the following scopes to perform the actions provided by the Kore.ai XO platform.\n<ul>\n<li><code>read_orders<\/code><\/li>\n<li><code>read_products<\/code><\/li>\n<li><code>read_customers<\/code><\/li>\n<\/ul>\n<\/li>\n<li>Provide the <strong>Admin API access token<\/strong> and <strong>Domain<\/strong> provided by Shopify in Kore.ai Pre-authorize the Integration.<\/li>\n<li>If you don\u2019t have Shopify account credentials, create a developer account in Shopify and note down login credentials. Use the <a href=\"https:\/\/www.shopify.com\/in\/blog\/topics\/guides\">Shopify Documentation<\/a> for more information.<\/li>\n<li>Copy your Shopify account&#8217;s API Key and Domain name and keep it for future use.<\/li>\n<\/ul>\n<h3><span class=\"ez-toc-section\" id=\"Pre-authorize_the_Integration\">Pre-authorize the Integration<\/span><\/h3>\n<p><strong>Basic Auth<\/strong><br \/>\nYou can authorize the integration using your credentials. The developer authorization lets you authorize the integration with preconfigured Kore.ai\u2019s app with the <strong>Basic Auth<\/strong> option.<\/p>\n<p>Steps to authorize a Shopify action using developer credentials:<\/p>\n<ol>\n<li>Go to <strong>Build > Integrations > Actions<\/strong>.<\/li>\n<li>Select the <strong>Shopify<\/strong> action in the Available Actions.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512070823\/shopify_action.png\"><img loading=\"lazy\" decoding=\"async\" width=\"1902\" height=\"887\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512070823\/shopify_action.png\" alt=\"\" class=\"alignnone size-medium wp-image-56913\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512070823\/shopify_action.png 1902w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512070823\/shopify_action-300x140.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512070823\/shopify_action-1024x478.png 1024w\" sizes=\"auto, (max-width: 1902px) 100vw, 1902px\" \/><\/a><\/li>\n<li>In the <strong>Configurations<\/strong> dialog, select the <strong>Authorization<\/strong> tab.<\/li>\n<li>Enter the following details:\n<ul>\n<li><strong>Authorization Type<\/strong> &#8211; Select the <strong>Pre-authorize the Integration<\/strong> option, and then select the <strong>Basic Auth<\/strong> option.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512072654\/shopify_action1.png\"><img loading=\"lazy\" decoding=\"async\" width=\"1058\" height=\"820\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512072654\/shopify_action1.png\" alt=\"\" class=\"alignnone size-medium wp-image-56917\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512072654\/shopify_action1.png 1058w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512072654\/shopify_action1-300x233.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512072654\/shopify_action1-1024x794.png 1024w\" sizes=\"auto, (max-width: 1058px) 100vw, 1058px\" \/><\/a><\/li>\n<li><strong>User Sub Domain<\/strong> &#8211; The domain name of the Shopify account.<\/li>\n<li><strong>API Key<\/strong> &#8211; The secret API key of your Shopify account.<\/li>\n<\/ul>\n<\/li>\n<li>Click <strong>Enable<\/strong>. When you configure the action for the first time, the Integration Successful  pop-up is displayed.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512073710\/shopify_action4.png\"><img loading=\"lazy\" decoding=\"async\" width=\"883\" height=\"350\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512073710\/shopify_action4.png\" alt=\"\" class=\"alignnone size-medium wp-image-56920\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512073710\/shopify_action4.png 883w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512073710\/shopify_action4-300x119.png 300w\" sizes=\"auto, (max-width: 883px) 100vw, 883px\" \/><\/a><br \/>\n<strong>Note<\/strong>: The Shopify action is moved from Available to Configured region.<\/li>\n<\/ol>\n<h3><span class=\"ez-toc-section\" id=\"Allow_End_User_to_Authorize\">Allow End User to Authorize<\/span><\/h3>\n<p>You can authorize the integration at a user level with their login credentials. The user authorization process involves requesting permission for Kore.ai\u2019s Shopify app to access an access token at runtime. You can also use the basic auth profile to let a user configure the integration at runtime.<\/p>\n<p>Steps to authorize a Shopify action at a user level:<\/p>\n<ol>\n<li>Go to <strong>Build > Integrations > Actions<\/strong> and select the <strong>Shopify<\/strong> action.<\/li>\n<li>In the Configurations dialog, select the <strong>Authorization<\/strong> tab.<\/li>\n<li>Enter the following details:\n<ul>\n<li><strong>Authorization Type<\/strong> &#8211; Select the <strong>Allow Users to Authorize the Integration<\/strong> option, and then select the <strong>Basic Auth<\/strong> option.<\/li>\n<li>Create your authorization profile to obtain an access token and use it to complete integration without using Kore.ai&#8217;s Shopify app for authorization. To create a profile, click the <strong>Select Authorization<\/strong> drop-down and select the <strong>Create New<\/strong> option.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512074530\/shopify_action3.png\"><img loading=\"lazy\" decoding=\"async\" width=\"1075\" height=\"823\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512074530\/shopify_action3.png\" alt=\"\" class=\"alignnone size-medium wp-image-56924\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512074530\/shopify_action3.png 1075w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512074530\/shopify_action3-300x230.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512074530\/shopify_action3-1024x784.png 1024w\" sizes=\"auto, (max-width: 1075px) 100vw, 1075px\" \/><\/a><\/li>\n<li>Select the type of authorization mechanism. For example, select the <strong>API Key<\/strong> option. To create Basic Auth profiles, see <a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/advanced-topics\/authorization\/bot-authentication\/\">Bot Authorization Overview<\/a>.<\/li>\n<li>Enter the following authentication credentials for the Basic Auth mechanism:\n<ul>\n<li><b>Name<\/b> &#8211; Enter the name for the Basic Auth profile.<\/li>\n<li>Select <b>Yes <\/b>for the tenancy URLs option.<\/li>\n<li><b>Base URL<\/b> &#8211; Enter the base tenant URL for the Shopify instance.<\/li>\n<li><b>Authorization Check URL<\/b> &#8211; Enter the authorization check URL for your Shopify instance.<\/li>\n<li><b>Description<\/b> &#8211; Enter the description of the basic authentication profile.<\/li>\n<li>Click <strong>Save Auth<\/strong> to save the authorization profile.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512080934\/shopify_API_key_profile.png\"><img loading=\"lazy\" decoding=\"async\" width=\"924\" height=\"425\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512080934\/shopify_API_key_profile.png\" alt=\"\" class=\"alignnone size-medium wp-image-56928\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512080934\/shopify_API_key_profile.png 924w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512080934\/shopify_API_key_profile-300x138.png 300w\" sizes=\"auto, (max-width: 924px) 100vw, 924px\" \/><\/a><\/li>\n<li>Select the new <strong>Authorization Profile<\/strong>, which you created to complete integration.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<li>Click <strong>Enable<\/strong>. When you configure the action for the first time, the <strong>Integration Successful<\/strong> pop-up is displayed.<\/li>\n<\/ol>\n<h2><span class=\"ez-toc-section\" id=\"Step_2_Install_the_Shopify_Action_Templates\">Step 2: Install the Shopify Action Templates<\/span><\/h2>\n<p>Once you have configured a Shopify integration, you can explore and install action templates.<\/p>\n<p>Steps to install action templates:<\/p>\n<ol>\n<li>On the Integration Successful dialog, click the <strong>Explore Templates<\/strong> button to view the templates.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512073710\/shopify_action4.png\"><img loading=\"lazy\" decoding=\"async\" width=\"883\" height=\"350\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512073710\/shopify_action4.png\" alt=\"\" class=\"alignnone size-medium wp-image-56920\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512073710\/shopify_action4.png 883w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512073710\/shopify_action4-300x119.png 300w\" sizes=\"auto, (max-width: 883px) 100vw, 883px\" \/><\/a><br \/>\nYou can also click the <strong>Skip for Now<\/strong> button to install the Dialog Task templates later.<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512082615\/shopify_skip.png\"><img loading=\"lazy\" decoding=\"async\" width=\"886\" height=\"352\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512082615\/shopify_skip.png\" alt=\"\" class=\"alignnone size-medium wp-image-56932\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512082615\/shopify_skip.png 886w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512082615\/shopify_skip-300x119.png 300w\" sizes=\"auto, (max-width: 886px) 100vw, 886px\" \/><br \/>\n<\/a><\/li>\n<li>In the Integration Templates dialog, click the <strong>Install<\/strong> button to begin the installation.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512082741\/shopify_action5.png\"><img loading=\"lazy\" decoding=\"async\" width=\"882\" height=\"756\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512082741\/shopify_action5.png\" alt=\"\" class=\"alignnone size-medium wp-image-56935\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512082741\/shopify_action5.png 882w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512082741\/shopify_action5-300x257.png 300w\" sizes=\"auto, (max-width: 882px) 100vw, 882px\" \/><\/a><\/li>\n<li>Once the template is installed, click the <strong>Go to Dialog<\/strong> button to view the dialog task.<\/li>\n<li>Once all templates are installed, a dialog task for each template is auto-created.<\/li>\n<li>Select the desired dialog task from the templates and click <strong>Proceed<\/strong>. For example, select the <strong>Get products by name<\/strong> task.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083248\/shopify_action7.png\"><img loading=\"lazy\" decoding=\"async\" width=\"1193\" height=\"904\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083248\/shopify_action7.png\" alt=\"\" class=\"alignnone size-medium wp-image-56938\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083248\/shopify_action7.png 1193w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083248\/shopify_action7-300x227.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083248\/shopify_action7-1024x776.png 1024w\" sizes=\"auto, (max-width: 1193px) 100vw, 1193px\" \/><\/a><\/li>\n<li>Once you click Proceed, the dialog task is auto-created, and the canvas opens with all required entity nodes, service nodes, and message scripts.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083503\/shopify_action8.png\"><img loading=\"lazy\" decoding=\"async\" width=\"1474\" height=\"860\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083503\/shopify_action8.png\" alt=\"\" class=\"alignnone size-medium wp-image-56941\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083503\/shopify_action8.png 1474w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083503\/shopify_action8-300x175.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230512083503\/shopify_action8-1024x597.png 1024w\" sizes=\"auto, (max-width: 1474px) 100vw, 1474px\" \/><\/a><\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"ult-spacer spacer-6ae86fe9e9cd0\" data-id=\"6ae86fe9e9cd0\" data-height=\"20\" data-height-mobile=\"20\" data-height-tab=\"20\" data-height-tab-portrait=\"\" data-height-mobile-landscape=\"\" style=\"clear:both;display:block;\"><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"The Kore.ai XO Platform lets you easily connect your Shopify Shop instance to find information regarding Customers, Products, and Orders. This document explains how to authorize and enable the Shopify action and install the pre-built templates. Authorizations Supported The Kore.ai XO Platform supports basic authentication to allow Shopify integration to exchange data. For more information,...","protected":false},"author":17,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[201],"tags":[],"class_list":["post-56905","post","type-post","status-publish","format-standard","hentry","category-integrations"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/56905","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/17"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=56905"}],"version-history":[{"count":14,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/56905\/revisions"}],"predecessor-version":[{"id":57137,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/56905\/revisions\/57137"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=56905"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=56905"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=56905"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}