Represents the customer resource
| Parameter | Type | Description | Required |
|---|
| id | string | id
string
id Example: | no |
| embedded | object | if_multiple_integration
boolean
required
Indicates whether multiple integrations are enabled Example:
true
default_integration
object
Integration setting for a specific e-commerce platform integration_type
string
The type of integration (e.g., SHOPIFY, BIGCOMMERCE, CUSTOM)
= 0 characters
<= 2147483647 characters
Example:
SHOPIFY
brand_name
string
The brand name associated with this integration
= 0 characters
<= 2147483647 characters
Example:
Acme Inc.
brand_domain_id
string
The domain ID for the brand
= 0 characters
<= 2147483647 characters
Example:
acme.com
authorization_id
string
Authorization ID used to authenticate
= 0 characters
<= 2147483647 characters
Example:
auth-1234
shopify_integration_credential
object
Represents the Shopify Integration credentialsmultiple_integrations
array[object]
A list of integration settings when multiple integrations are enabled
integration_type
string
The type of integration (e.g., SHOPIFY, BIGCOMMERCE, CUSTOM)
= 0 characters
<= 2147483647 characters
Example:
SHOPIFY
brand_name
string
The brand name associated with this integration
= 0 characters
<= 2147483647 characters
Example:
Acme Inc.
brand_domain_id
string
The domain ID for the brand
= 0 characters
<= 2147483647 characters
Example:
acme.com
authorization_id
string
Authorization ID used to authenticate
= 0 characters
<= 2147483647 characters
Example:
auth-1234
shopify_integration_credential
object
Represents the Shopify Integration credentials_links
object
required
self
object
required
href
string<uri>
Example:
http://api-docs.talkdesk.org/erc/ecommerce/shopify-webhooks-handler/credentials
| yes |
| Parameter | Type | Description | Required |
|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
