Salesforce Commerce Cloud API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "salesforce_commerce_cloud",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "config": {
    "ocapi_client_id": "string",
    "include_ocapi_endpoints": true,
    "ocapi_hostname": "string",
    "organization_id": "organization_id",
    "site_id": "your_site_id",
    "customer_list_id": "your_customer_list_id",
    "ocapi_custom_object_types": "string",
    "client_secret": "your_api_secret",
    "client_id": "your_client_id",
    "ocapi_client_secret": "string",
    "short_code": "your_short_code",
    "schema": "schema_name"
  },
  "auth": {
    "ocapi_refresh_token": "string",
    "ocapi_access_token": "string"
  }
}

Config parameters

Name	Description
`ocapi_client_id`	The Salesforce Commerce Cloud OCAPI Client ID.
`include_ocapi_endpoints`	Whether to sync data through OCAPI endpoints.
`ocapi_hostname`	The Salesforce Commerce Cloud OCAPI hostname.
`organization_id`	The organization ID from Salesforce Commerce Cloud account.
`site_id`	The name of the site from which you want to sync data.
`customer_list_id`	The parameter to retrieve customer details.
`ocapi_custom_object_types`	The Salesforce Commerce Cloud OCAPI custom object types.
`client_secret`	The Salesforce Commerce Cloud Client secret.
`client_id`	The Salesforce Commerce Cloud Client ID.
`ocapi_client_secret`	The Salesforce Commerce Cloud OCAPI Client secret.
`short_code`	The Salesforce eight-character string assigned to a realm for routing purposes.
`schema`	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_id, client_secret, short_code, site_id, organization_id and customer_list_id parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "salesforce_commerce_cloud",
  "group_id": "group_id",
  "config": {
    "client_id": "your_client_id",
    "client_secret": "your_api_secret",
    "short_code": "your_short_code",
    "site_id": "your_site_id",
    "organization_id": "organization_id",
    "customer_list_id": "your_customer_list_id"
  }
}

By using the Connect Card or the Fivetran dashboard.