TAtalkdesk
Retail Experience Cloud Bridge

Update Shopify Integration Credentials

Upsert the Shopify Integration credentials for the currently authenticated Talkdesk account.

Required fields:

  • shopify_store_domain
  • shopify_api_key
  • shopify_api_secret

A successful request upserts the Shopify Integration credentials and returns the updated credentials.

put/erc/ecommerce/shopify-webhooks-handler/credentials

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/erc/ecommerce/shopify-webhooks-handler/credentials
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: erc-ecommerce-shopify-webhooks-handler-credentials:write

Request body

shopify_store_domainstring required

The domain of the shopify store that is integrated with the authenticated Talkdesk account

shopify_api_keystring required

The API key of the Shopify App that allows the integration with the Shopify API

shopify_api_secretstring required

The API secret of the Shopify App that allows the integration with the Shopify API

shopify_api_access_tokenstring

"The API access token obtained during the installation of the Shopify App that allows the integration with the Shopify API"

Example request

{
  "shopify_store_domain": "shopify-store-name.myshopify.com",
  "shopify_api_key": "<opaque-key-token>",
  "shopify_api_secret": "<opaque-secret-token>",
  "shopify_api_access_token": "<opaque-access-token>"
}

Response

The Shopify Integration credentials currently configured for the authenticated Talkdesk account

if_multiple_integrationboolean required

Indicates whether multiple integrations are enabled

callbar_customer_searchboolean

Indicates whether callbar customer search is enabled

Example response

{
  "if_multiple_integration": true,
  "default_integration": {
    "integration_type": "SHOPIFY",
    "brand_name": "Acme Inc.",
    "brand_domain_id": "acme.com",
    "authorization_id": "auth-1234",
    "shopify_integration_credential": {
      "shopify_store_domain": "example-store.myshopify.com",
      "shopify_api_key": "<api-key>",
      "shopify_api_secret": "<api-secret>",
      "shopify_api_access_token": "<access-token>"
    }
  },
  "multiple_integrations": [
    {
      "integration_type": "SHOPIFY",
      "brand_name": "Acme Inc.",
      "brand_domain_id": "acme.com",
      "authorization_id": "auth-1234",
      "shopify_integration_credential": {
        "shopify_store_domain": "example-store.myshopify.com",
        "shopify_api_key": "<api-key>",
        "shopify_api_secret": "<api-secret>",
        "shopify_api_access_token": "<access-token>"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "http://api-docs.talkdesk.org/erc/ecommerce/shopify-webhooks-handler/credentials"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.