Skip to main content

Data Source

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

Salesforce B2C 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 B2C Commerce Cloud connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Salesforce B2C Commerce Cloud account, and click Next; or, create a new Salesforce B2C Commerce Cloud credential for use in this flow.

  3. In Nexla, Salesforce B2C Commerce Cloud data sources can be created using pre-built endpoint templates, which expedite source setup for common Salesforce B2C Commerce Cloud endpoints. Each template is designed specifically for the corresponding Salesforce B2C 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 B2C Commerce Cloud sources can also be configured manually, allowing you to ingest data from Salesforce B2C 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 B2C Commerce Cloud endpoints. Each template is designed specifically for the corresponding Salesforce B2C 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 Catalogs

    This endpoint template retrieves the list of catalogs with no filtering from your Salesforce B2C Commerce Cloud account. Use this template when you need to retrieve information about all available catalogs, including catalog IDs, names, and other catalog metadata.

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

    This endpoint returns the list of catalogs from your Salesforce B2C Commerce Cloud account, including catalog IDs, names, and other catalog metadata. 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 catalogs, API response structures, pagination, and available catalog data, see the Salesforce B2C Commerce Cloud API documentation.

    Get Catalog

    This endpoint template gets the catalog with the specified information from your Salesforce B2C Commerce Cloud account. Use this template when you need to retrieve detailed information about a specific catalog, including catalog details and other catalog metadata.

    • Enter the catalog ID in the Catalog ID field. This should be the unique identifier of the catalog you want to retrieve. The catalog ID determines which catalog's information will be retrieved.

    This endpoint returns the catalog with the specified information from your Salesforce B2C Commerce Cloud account, including catalog details and other catalog metadata. The endpoint returns a single catalog's information.

    For detailed information about catalog retrieval, API response structures, and available catalog data, see the Salesforce B2C Commerce Cloud API documentation.

    Get Orders

    This endpoint template returns the details of orders that match the query filters from your Salesforce B2C Commerce Cloud account. Use this template when you need to retrieve information about orders, including order IDs, customer information, and other order metadata.

    • Enter the site ID in the Site ID field. This should be the unique identifier of the site for which you want to retrieve orders. The site ID determines which site's orders will be retrieved.

    This endpoint returns the details of orders that match the query filters from your Salesforce B2C Commerce Cloud account, including order IDs, customer information, and other order metadata. 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 orders, API response structures, pagination, query filters, and available order data, see the Salesforce B2C Commerce Cloud API documentation.

    Get Order

    This endpoint template returns the details of the order with the specified order number from your Salesforce B2C Commerce Cloud account. Use this template when you need to retrieve detailed information about a specific order.

    • Enter the order number in the Order Number field. This should be the unique order number of the order you want to retrieve. The order number determines which order's information will be retrieved.
    • Enter the site ID in the Site ID field. This should be the unique identifier of the site for which the order belongs. The site ID determines which site's order will be retrieved.

    This endpoint returns the details of the order with the specified order number from your Salesforce B2C Commerce Cloud account, including order details, customer information, and other order metadata. The endpoint returns a single order's information.

    For detailed information about order retrieval, API response structures, and available order data, see the Salesforce B2C Commerce Cloud API documentation.

    Get Product

    This endpoint template retrieves product information from your Salesforce B2C Commerce Cloud account. Use this template when you need to retrieve detailed information about a specific product, including product details, pricing, and other product metadata.

    • Enter the product ID in the Product ID field. This should be the unique identifier of the product you want to retrieve. The product ID determines which product's information will be retrieved.

    This endpoint returns product information from your Salesforce B2C Commerce Cloud account, including product details, pricing, and other product metadata. The endpoint returns a single product's information.

    For detailed information about product retrieval, API response structures, and available product data, see the Salesforce B2C Commerce Cloud API documentation.

    Search Products

    This endpoint template searches for products in your Salesforce B2C Commerce Cloud account. The query attribute specifies a complex query that can be used to narrow down the search. Use this template when you need to search for products based on specific criteria.

    • This endpoint automatically searches for products from your Salesforce B2C Commerce Cloud account. The endpoint uses offset-based pagination to handle large datasets efficiently. You can customize the search query to narrow down the results based on your specific criteria.

    This endpoint searches for products in your Salesforce B2C Commerce Cloud account based on the query attribute. The query attribute specifies a complex query that can be used to narrow down the search. 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 product search, API response structures, query syntax, pagination, and available product data, see the Salesforce B2C Commerce Cloud API 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 B2C Commerce Cloud data sources can be manually configured to ingest data from any valid Salesforce B2C 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 B2C 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 B2C Commerce Cloud API from the Method pulldown menu. Salesforce B2C Commerce Cloud API typically uses GET method for retrieving data from endpoints and POST method for search endpoints.

API Endpoint URL​

  1. Enter the URL of the Salesforce B2C Commerce Cloud API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including your short code (from your credential), API version, organization ID, and the API path (e.g., https://{short_code}.api.commercecloud.salesforce.com/product/catalogs/{version}/organizations/{org_id}/catalogs). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Salesforce B2C Commerce Cloud API endpoint URL should include your short code, API version, organization ID, 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 B2C Commerce Cloud API responses, use $.data[*] to extract all items from the data array for list endpoints, $.hits[*] to extract all hits from the hits array for search endpoints, 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 B2C Commerce Cloud API response. Salesforce B2C 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 B2C Commerce Cloud API uses offset-based pagination with offset and limit parameters for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. 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.