Tax API JavaScript usage

To manage OOP tax integrations, Adobe Commerce provides a set of REST endpoints. The following sections describe how to use these endpoints in your JavaScript code.

To call the Commerce REST endpoints, initialize the Adobe Commerce Client:

const { getAdobeCommerceClient } = require("../lib/adobe-commerce");
const commerceClient = await getAdobeCommerceClient(process.env);
Copied to your clipboard
const { getAdobeCommerceClient } = require("../lib/adobe-commerce");
const commerceClient = await getAdobeCommerceClient(process.env);

Create or modify a new OOPE tax integration

createOopeTaxIntegration creates a new out-of-process tax integration:

Check the API reference for more details.

Example usage

try {
  const createResponse = await commerceClient.createOopeTaxIntegration({
    code: "tax-1",
    title: "Tax Integration 1",
    active: true,
    stores: ["store-1", "store-2"],
  });

  if (!createResponse.success) {
    return errorResponse(
      createResponse.statusCode,
      "Failed to create tax integration",
    );
  }

  console.log("Created tax integration:", createResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while creating tax integration",
  );
}
Copied to your clipboard
try {
  const createResponse = await commerceClient.createOopeTaxIntegration({
    code: "tax-1",
    title: "Tax Integration 1",
    active: true,
    stores: ["store-1", "store-2"],
  });

  if (!createResponse.success) {
    return errorResponse(
      createResponse.statusCode,
      "Failed to create tax integration",
    );
  }

  console.log("Created tax integration:", createResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while creating tax integration",
  );
}

Get an OOPE tax integration by code

getOopeTaxIntegration retrieves one out-of-process tax integration by code from the Adobe Commerce instance.

Check the API reference for more details.

Example usage

try {
  const getResponse = await commerceClient.getOopeTaxIntegration("tax-1");
  if (!getResponse.success) {
    return errorResponse(
      getResponse.statusCode,
      "Failed to retrieve tax integration",
    );
  }
  consolejson("Retrieved tax integration details:", getResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while retrieving tax integration",
  );
}
Copied to your clipboard
try {
  const getResponse = await commerceClient.getOopeTaxIntegration("tax-1");
  if (!getResponse.success) {
    return errorResponse(
      getResponse.statusCode,
      "Failed to retrieve tax integration",
    );
  }
  consolejson("Retrieved tax integration details:", getResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while retrieving tax integration",
  );
}

List all OOPE tax integrations

getOopeTaxIntegrations retrieves a list of all out-of-process tax integrations in the Adobe Commerce instance.

Check the API reference for more details.

Example usage

try {
  const listResponse = await commerceClient.getOopeTaxIntegrations();
  if (!listResponse.success) {
    return errorResponse(
      listResponse.statusCode,
      "Failed to list tax integrations",
    );
  }
  console.log("List of tax integrations:", listResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while listing tax integrations",
  );
}
Copied to your clipboard
try {
  const listResponse = await commerceClient.getOopeTaxIntegrations();
  if (!listResponse.success) {
    return errorResponse(
      listResponse.statusCode,
      "Failed to list tax integrations",
    );
  }
  console.log("List of tax integrations:", listResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while listing tax integrations",
  );
}

Tax use cases

Tax API reference

Last updated 4/8/2025

Was this helpful?

Yes

Tax API JavaScript usage

Create or modify a new OOPE tax integration.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Get an OOPE tax integration by code

List all OOPE tax integrations

Create or modify a new OOPE tax integration