@taurgis/sfccdx/lib/api/request/buildOCAPIUrl.js

SFCCDX is a command line interface (CLI) for Salesforce Commerce Cloud. It can be used to easily manage (meta)data (import/export) in relation to your project.

/**
 * @function buildOCAPIUrl
 * @description Builds the OCAPI Url used to drive a request
 *
 * @param {String} apiType Describes the type of API for the request
 * @param {String} apiVersion Represents the API version to include in the OCAPI url
 * @param {String} urlSuffix Represents any suffix being added to the url
 * @param {Boolean} [includeOrgPrefix] Should the BM site representation be included in the url
 * @param {String} [siteId] Describes the internal siteId used to identify the site
 * @returns {Object} Returns the OCAPI Url created using the argument properties
 */
module.exports = (apiType, apiVersion, urlSuffix, includeOrgPrefix, siteId) => {
  // Initialize local variables
  let prefix = '';

  switch (apiType) {
    // Create foundation urls for the data api
    case 'data':
      // Do we need to include the organizationPrefix?
      if (includeOrgPrefix === true) {
        prefix = '/s/-';
      }
      break;
    // Create foundation urls for the shop api
    case 'shop':
      // If it's a shop request -- include the siteId
      prefix = `/s/${siteId}`;
      break;
    default:
      throw new Error(`Unknown api type "${apiType}"`);
  }

  // Continue to build out the OCAPI url -- including the API version and urlSuffix
  return `${prefix}/dw/${apiType}/${apiVersion}${urlSuffix}`;
};