Skip to main content

Interface: AliasCode

Represents an alternative product code for a specific company.

The AliasCode interface defines a mapping between standard internal product codes and company-specific alternatives. These aliases enable seamless integration with external systems that use different product identification schemes, such as customer ERPs, ordering systems, or inventory management platforms.

Alias codes are particularly valuable for B2B contexts where different organizations may have established product numbering systems that must be maintained for operational continuity.

Example​

// Product with company-specific alias codes
const productCodes = {
  code: "CHAIR-OAK-STD",  // Standard internal code
  aliasCodes: [
    {
      companyId: "company123",
      companyName: "Acme Furnishings",
      aliasCode: "ACF-2501-O"
    },
    {
      companyId: "company456",
      companyName: "Global Office",
      aliasCode: "GOCH-101"
    }
  ]
};

// Finding the correct code for a specific company
function getCompanyProductCode(companyId) {
  const alias = productCodes.aliasCodes.find(a => a.companyId === companyId);
  return alias ? alias.aliasCode : productCodes.code;  // Fall back to standard code
}

Properties​

aliasCode​

aliasCode: string

Company-specific alternative product code.

This is the actual code used by the specific company to identify this product in their systems. It might follow a different format or convention than internal codes.

companyId​

companyId: string

Identifier of the company this alias applies to.

This links the alias code to a specific company, ensuring that the right code is used when interacting with each organization's systems.

companyName?​

optional companyName: string

Display name of the company this alias belongs to.

This human-readable company name is used in interfaces where alias codes are displayed or managed.

id​

id: string

Unique identifier for this alias code entry.

This ID uniquely identifies this specific code mapping for reference, updates, and tracking purposes.