Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Salesforce B2B Commerce Cloud source in Nexla.
salesforce_cc_api.png

Salesforce B2B Commerce Cloud

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Salesforce B2B Commerce Cloud connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Salesforce B2B Commerce Cloud account, and click Next; or, create a new Salesforce B2B Commerce Cloud credential for use in this flow.

  3. In Nexla, Salesforce B2B Commerce Cloud data sources can be created using pre-built endpoint templates, which expedite source setup for common Salesforce B2B Commerce Cloud endpoints. Each template is designed specifically for the corresponding Salesforce B2B Commerce Cloud endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Salesforce B2B Commerce Cloud sources can also be configured manually, allowing you to ingest data from Salesforce B2B Commerce Cloud endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Salesforce B2B Commerce Cloud endpoints. Each template is designed specifically for the corresponding Salesforce B2B Commerce Cloud endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Detailed Category Information

    This endpoint template retrieves all information about all categories, including nested related attributes, from your Salesforce B2B Commerce Cloud account. Use this template when you need to retrieve comprehensive category information for your e-commerce catalog.

    • This endpoint automatically retrieves all categories from your Salesforce B2B Commerce Cloud account. The endpoint uses offset-based pagination to handle large datasets efficiently, returning up to 500 records per page by default.

    This endpoint returns all information about all categories, including nested related attributes, from your Salesforce B2B Commerce Cloud account. The endpoint uses offset-based pagination with offset and limit parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the offset parameter.

    For detailed information about categories, API response structures, pagination, and ways to fetch filtered lists, see the Salesforce B2B Commerce Cloud Category REST API documentation.

    Get Detailed Product Information

    This endpoint template retrieves all information about all products, including related attributes, from your Salesforce B2B Commerce Cloud account. Use this template when you need to retrieve comprehensive product information for your e-commerce catalog.

    • This endpoint automatically retrieves all products from your Salesforce B2B Commerce Cloud account, including blocked products. The endpoint uses offset-based pagination to handle large datasets efficiently, returning up to 500 records per page by default.

    This endpoint returns all information about all products, including related attributes, from your Salesforce B2B Commerce Cloud account. The endpoint uses offset-based pagination with offset and limit parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the offset parameter.

    For detailed information about products, API response structures, pagination, and ways to fetch filtered lists, see the Salesforce B2B Commerce Cloud Product REST API documentation.

    Get Basic Category Information

    This endpoint template retrieves some basic information about all categories from your Salesforce B2B Commerce Cloud account. Use this template when you need to retrieve basic category information without all nested attributes.

    • This endpoint automatically retrieves basic category information from your Salesforce B2B Commerce Cloud account. The endpoint uses next URL-based pagination to handle large datasets efficiently.

    This endpoint returns some basic information about all categories from your Salesforce B2B Commerce Cloud account, including category IDs, names, and owner IDs. The endpoint uses next URL-based pagination with nextRecordsUrl to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the next records URL returned in the API response.

    For detailed information about SOQL queries, API response structures, and ways to fetch filtered lists, see the Salesforce SOQL documentation.

    Get Basic Product Information

    This endpoint template retrieves some basic information about all products from your Salesforce B2B Commerce Cloud account. Use this template when you need to retrieve basic product information without all related attributes.

    • This endpoint automatically retrieves basic product information from your Salesforce B2B Commerce Cloud account. The endpoint uses next URL-based pagination to handle large datasets efficiently.

    This endpoint returns some basic information about all products from your Salesforce B2B Commerce Cloud account, including product IDs, names, SKUs, product types, product statuses, and other basic fields. The endpoint uses next URL-based pagination with nextRecordsUrl to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the next records URL returned in the API response.

    For detailed information about SOQL queries, API response structures, and ways to fetch filtered lists, see the Salesforce SOQL documentation.

    Execute SOQL Query

    This endpoint template allows you to fetch resources by specifying a SOQL (Salesforce Object Query Language) query. Use this template when you need to retrieve data using custom SOQL queries to filter and select specific fields.

    • Enter the SOQL query string in the Query String field. This should be a valid SOQL query (e.g., SELECT Id, Name FROM Account WHERE CreatedDate > 2024-01-01T00:00:00Z). The query string determines which records will be retrieved and which fields will be included in the response.

    This endpoint executes a SOQL query to fetch resources from your Salesforce B2B Commerce Cloud account. The endpoint uses next URL-based pagination with nextRecordsUrl to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the next records URL returned in the API response.

    For detailed information about SOQL queries, query syntax, available objects, and ways to construct queries, see the Salesforce SOQL documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Salesforce B2B Commerce Cloud data sources can be manually configured to ingest data from any valid Salesforce B2B Commerce Cloud API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Salesforce B2B Commerce Cloud sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Salesforce B2B Commerce Cloud API from the Method pulldown menu. Salesforce B2B Commerce Cloud API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Salesforce B2B Commerce Cloud API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Salesforce B2B Commerce Cloud endpoint, including your instance URL (e.g., https://your-instance.salesforce.com/services/apexrest/ccrz/cccategory/v8/fetch). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Salesforce B2B Commerce Cloud API endpoint URL should include your instance URL (from your OAuth2 token) and the appropriate API path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Salesforce B2B Commerce Cloud API responses, use $.records[*] to extract all items from the records array for SOQL queries, $.categoryList[*] to extract all items from the category list, $.productList[*] to extract all items from the product list, or $ to extract the entire response for single record endpoints, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Salesforce B2B Commerce Cloud API response. Salesforce B2B Commerce Cloud API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Salesforce B2B Commerce Cloud API uses different pagination mechanisms for different endpoints (next URL-based, offset-based, etc.). Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For next URL-based pagination, specify the JSONPath expression to the next records URL in the response ($.nextRecordsUrl). For offset-based pagination, specify the offset parameter name (offset), page size parameter name (limit), and starting offset value.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.