Company Management Dictionary

The Company Management dictionary contains all user-facing text, labels, and messages displayed by this drop-in. Customize the dictionary to:

• Localize the drop-in for different languages and regions
• Customize labels and messages to match your brand voice
• Override default text without modifying source code for the drop-in

Dictionaries use the i18n (internationalization) pattern, where each text string is identified by a unique key path.

Version: 1.0.0-beta27

How to customize

Override dictionary values during drop-in initialization. The drop-in deep-merges your custom values with the defaults.

import { initialize } from '@dropins/storefront-company-management';

await initialize({
  langDefinitions: {
    en_US: {
      "Company": {
        "shared": {
          "fields": {
            "companyName": "Custom value",
            "companyEmail": "Custom value"
          }
        }
      }
    }
  }
});

You only need to include the keys you want to change. For multi-language support and advanced patterns, see the Dictionary customization guide.

Default keys and values

Below are the default English (en_US) strings provided by the Company Management drop-in:

{
  "Company": {
    "shared": {
      "fields": {
        "companyName": "Company Name",
        "companyEmail": "Company Email",
        "email": "Email",
        "legalName": "Legal Name",
        "vatTaxId": "VAT/Tax ID",
        "resellerId": "Reseller ID",
        "accountInformation": "Account Information",
        "legalAddress": "Legal Address",
        "streetAddress": "Street Address",
        "city": "City",
        "country": "Country",
        "stateProvince": "State/Province",
        "zipPostalCode": "ZIP/Postal Code",
        "phoneNumber": "Phone Number",
        "status": "Status",
        "region": "Region",
        "postalCode": "Postal Code",
        "jobTitle": "Job Title",
        "workPhoneNumber": "Work Phone Number",
        "userRole": "User Role",
        "title": "New Company",
        "companyInformation": "Company Information",
        "street": "Street Address",
        "streetLine2": "Street Address Line 2",
        "postcode": "ZIP/Postal Code",
        "telephone": "Phone Number",
        "companyAdmin": "Company Administrator",
        "adminJobTitle": "Job Title",
        "adminWorkTelephone": "Work Phone Number",
        "adminEmail": "Email",
        "adminFirstname": "First Name",
        "adminLastname": "Last Name",
        "adminGender": "Gender",
        "address": "Address",
        "submit": "Register Company",
        "submitting": "Registering...",
        "required": "Required",
        "createCompanyError": "Failed to create company. Please try again.",
        "unexpectedError": "An unexpected error occurred. Please try again."
      },
      "buttons": {
        "edit": "Edit",
        "cancel": "Cancel",
        "save": "Save Changes",
        "saving": "Saving...",
        "close": "Close",
        "confirm": "Confirm"
      },
      "validation": {
        "required": "This field is required",
        "invalidEmail": "Please enter a valid email address",
        "companyNameRequired": "Company name is required",
        "emailRequired": "Email is required",
        "emailNotAvailable": "This email is already used by another company",
        "phoneInvalid": "Please enter a valid phone number",
        "postalCodeInvalid": "Please enter a valid postal code",
        "companyNameLengthError": "Company name must not exceed 40 characters",
        "legalNameLengthError": "Legal name must not exceed 80 characters",
        "vatTaxIdLengthError": "VAT/Tax ID must not exceed 40 characters",
        "resellerIdLengthError": "Reseller ID must not exceed 40 characters",
        "roleNameRequired": "This is a required field.",
        "roleNameExists": "User role with this name already exists. Enter a different name to save this role."
      },
      "messages": {
        "loading": "Loading...",
        "noData": "No data available",
        "error": "An error occurred",
        "success": "Operation completed successfully"
      },
      "loading": "Loading...",
      "ariaLabels": {
        "editButton": "Edit company profile",
        "cancelButton": "Cancel editing",
        "saveButton": "Save company profile changes",
        "closeButton": "Close dialog"
      }
    },
    "CompanyProfile": {
      "containerTitle": "Company Profile",
      "editCompanyProfile": {
        "containerTitle": "Edit Company Profile",
        "companySuccess": "Company profile updated successfully",
        "companyError": "Failed to update company profile",
        "buttonSecondary": "Cancel",
        "buttonPrimary": "Save Changes"
      },
      "companyProfileCard": {
        "noDataMessage": "Company profile not available. Please contact your administrator.",
        "contacts": "Contacts",
        "companyAdministrator": "Company Administrator",
        "salesRepresentative": "Sales Representative",
        "paymentInformation": "Payment Information",
        "availablePaymentMethods": "Available Payment Methods",
        "shippingInformation": "Shipping Information",
        "availableShippingMethods": "Available Shipping Methods",
        "noPaymentMethods": "This company has no payment methods. Please contact store administrator.",
        "noShippingMethods": "This company has no shipping methods. Please contact store administrator.",
        "companyDetails": "Company Details",
        "addressInformation": "Address Information"
      },
      "messages": {
        "loadError": "Failed to load company profile",
        "updateError": "Failed to update company profile",
        "loadingProfile": "Loading company profile...",
        "savingProfile": "Saving company profile...",
        "noDataToUpdate": "No data to update"
      }
    },
    "CompanyStructure": {
      "containerTitle": "Company Structure",
      "shared": {
        "buttons": {
          "addUser": "Add User",
          "addTeam": "Add Team",
          "editSelected": "Edit",
          "remove": "Remove",
          "ok": "OK",
          "cancel": "Cancel",
          "close": "Close",
          "save": "Save",
          "deleting": "Deleting…",
          "removing": "Removing…",
          "expandAll": "Expand All",
          "collapseAll": "Collapse All"
        },
        "titles": {
          "addUser": "Add User",
          "editUser": "Edit User",
          "addTeam": "Add Team",
          "editTeam": "Edit Team"
        },
        "fields": {
          "jobTitle": "Job Title",
          "userRole": "User Role",
          "firstName": "First Name",
          "lastName": "Last Name",
          "email": "Email",
          "workPhoneNumber": "Work Phone Number",
          "status": "Status",
          "teamTitle": "Team Title",
          "description": "Description"
        },
        "options": {
          "selectRole": "Select role…",
          "active": "Active",
          "inactive": "Inactive",
          "companyAdministrator": "Company Administrator",
          "delete": "Delete",
          "expand": "Expand",
          "collapse": "Collapse"
        },
        "ariaLabels": {
          "addUser": "Add user",
          "addTeam": "Add team",
          "editSelected": "Edit selected",
          "removeSelected": "Remove selected",
          "showDescription": "Show description",
          "companyStructureActions": "Company structure actions",
          "expandAllNodes": "Expand all nodes",
          "collapseAllNodes": "Collapse all nodes"
        },
        "messages": {
          "processing": "Processing…",
          "teamDescription": "Team description"
        },
        "validation": {
          "firstNameRequired": "First name is required",
          "lastNameRequired": "Last name is required",
          "emailRequired": "Email is required",
          "emailInvalid": "Enter a valid email",
          "jobTitleRequired": "Job title is required",
          "workPhoneRequired": "Work phone number is required",
          "selectRole": "Select a role",
          "teamTitleRequired": "Team title is required",
          "firstNameMaxLength": "First name must not exceed 255 characters",
          "lastNameMaxLength": "Last name must not exceed 255 characters",
          "emailMaxLength": "Email must not exceed 254 characters",
          "jobTitleMaxLength": "Job title must not exceed 255 characters",
          "telephoneMaxLength": "Phone number must not exceed 20 characters",
          "teamNameMaxLength": "Team title must not exceed 39 characters",
          "teamDescriptionMaxLength": "Team description must not exceed 1000 characters",
          "firstNameInvalidChars": "First name contains invalid characters. Only letters, numbers, spaces, and ,-._'`& are allowed",
          "lastNameInvalidChars": "Last name contains invalid characters. Only letters, numbers, spaces, and ,-._'`& are allowed",
          "telephoneInvalidChars": "Phone number contains invalid characters. Only 0-9, +, -, (, ), and spaces are allowed"
        }
      },
      "messages": {
        "loadError": "Failed to load company structure",
        "updateError": "Failed to update company structure",
        "noStructureData": "No structure data.",
        "cannotDeleteUser": "Cannot Delete User",
        "cannotDeleteTeam": "Cannot Delete This Team",
        "removeUserConfirm": "Remove this user from Company structure?",
        "deleteTeamConfirm": "Delete this team?",
        "removeItemsConfirm": "Remove {count} item(s)?",
        "removeUserMessage": "Removing a user changes the account status to Inactive. The user's content is still available to the Company administrator, but the user cannot log in.",
        "cannotDeleteUserMessage": "This user has active users or teams assigned to it and cannot be deleted. Please unassign the users or teams first.",
        "cannotDeleteTeamMessage": "This team has active users or teams assigned to it and cannot be deleted. Please unassign the users or teams first.",
        "removeItemsMessage": "This action will remove the selected items from the company structure.",
        "deleteTeamMessage": "This action cannot be undone. Are you sure you want to delete this team?",
        "failedToMoveItem": "Failed to move item",
        "createUserError": "Failed to create user. You may not have permission to perform this action.",
        "createTeamError": "Failed to create team. You may not have permission to perform this action.",
        "saveUserError": "An error occurred while saving the user.",
        "saveTeamError": "An error occurred while saving the team.",
        "createUserSuccess": "The customer was successfully created.",
        "updateUserSuccess": "The customer was successfully updated.",
        "createTeamSuccess": "The team was successfully created.",
        "updateTeamSuccess": "The team was successfully updated.",
        "removeUserSuccess": "User was successfully removed from company structure.",
        "deleteTeamSuccess": "Team was successfully deleted.",
        "removeMultipleSuccess": "{count} item(s) were successfully removed.",
        "moveUserSuccess": "User was successfully moved.",
        "moveTeamSuccess": "Team was successfully moved.",
        "loadRolesError": "Failed to load roles",
        "fetchPermissionsError": "Failed to fetch permissions"
      }
    },
    "CompanyUsers": {
      "filters": {
        "showAll": "Show All Users",
        "showActive": "Show Active Users",
        "showInactive": "Show Inactive Users"
      },
      "columns": {
        "id": "ID",
        "name": "Name",
        "email": "Email",
        "role": "Role",
        "team": "Team",
        "status": "Status",
        "actions": "Actions"
      },
      "status": {
        "active": "Active",
        "inactive": "Inactive"
      },
      "emptyTeam": "-",
      "pagination": {
        "itemsRange": "Items {start}-{end} of {total}",
        "itemsPerPage": "Items per page:",
        "show": "Show",
        "perPage": "per page",
        "previous": "Previous",
        "next": "Next",
        "pageInfo": "Page {current} of {total}"
      },
      "emptyActions": "",
      "noUsersFound": "No users found.",
      "actions": {
        "manage": "Manage",
        "edit": "Edit",
        "addNewUser": "Add New User"
      },
      "ariaLabels": {
        "loadingUsers": "Loading company users",
        "usersTable": "Company users table",
        "filterOptions": "User filter options",
        "paginationNav": "Pagination navigation",
        "pageNavigation": "Page navigation",
        "pageSizeSelector": "Items per page selector",
        "previousPageFull": "Go to previous page, current page {current}",
        "nextPageFull": "Go to next page, current page {current}",
        "currentPage": "Current page {current} of {total}",
        "showingUsers": "Showing {count} users",
        "dataLoaded": "Loaded {count} users",
        "dataError": "Failed to load users.",
        "manageUser": "Manage user {name}",
        "editUser": "Edit user {name}"
      },
      "managementModal": {
        "title": "Manage user",
        "setActiveText": "Reactivate the user's account by selecting \"Set as Active\".",
        "setInactiveText": "Temporarily lock the user's account by selecting \"Set as Inactive\".",
        "deleteText": "Permanently delete the user's account and all associated content by selecting \"Delete\". This action cannot be reverted.",
        "setActiveButton": "Set as Active",
        "setInactiveButton": "Set as Inactive",
        "settingActiveButton": "Setting Active...",
        "settingInactiveButton": "Setting Inactive...",
        "deleteButton": "Delete",
        "deletingButton": "Deleting...",
        "cancelButton": "Cancel",
        "setActiveErrorGeneric": "An unexpected error occurred while setting user as active.",
        "setActiveErrorSpecific": "Failed to set user as active.",
        "setInactiveErrorGeneric": "An unexpected error occurred while setting user as inactive.",
        "setInactiveErrorSpecific": "Failed to set user as inactive.",
        "deleteErrorGeneric": "An unexpected error occurred.",
        "deleteErrorSpecific": "Failed to delete user.",
        "setActiveSuccess": "User was successfully activated.",
        "setInactiveSuccess": "User was successfully deactivated.",
        "deleteSuccess": "User was successfully deleted.",
        "ariaLabels": {
          "closeModal": "Close modal",
          "modalDescription": "User management options including setting as inactive or deleting the user account"
        }
      }
    },
    "CompanyRegistration": {
      "success": {
        "pendingApproval": "Thank you! We're reviewing your request and will contact you soon.",
        "companyDetails": "Company Information"
      }
    },
    "CustomerCompanyInfo": {
      "individualUserMessage": "You don't have a company account yet.",
      "createAccountCta": "Create a Company Account"
    },
    "CompanyCredit": {
      "title": "Company Credit",
      "creditAvailable": "Available Credit",
      "creditLimit": "Credit Limit",
      "outstandingBalance": "Outstanding Balance",
      "messages": {
        "loadError": "Failed to load company credit"
      },
      "emptyState": {
        "title": "No Credit Information",
        "message": "There is no credit information to display."
      }
    },
    "CompanyCreditHistory": {
      "title": "Credit History",
      "columns": {
        "date": "Date",
        "operation": "Operation",
        "amount": "Amount",
        "outstandingBalance": "Outstanding Balance",
        "availableCredit": "Available Credit",
        "creditLimit": "Credit Limit",
        "customReference": "Custom Reference #",
        "updatedBy": "Updated By"
      },
      "pagination": {
        "itemsRange": "Items {start}-{end} of {total}",
        "show": "Show"
      },
      "emptyState": {
        "title": "No Credit History",
        "message": "There is no credit history to display."
      },
      "ariaLabels": {
        "dataLoaded": "Loaded {count} credit history entries",
        "dataError": "Failed to load credit history entries. Please try again.",
        "historyTable": "Credit history table",
        "paginationNav": "Pagination navigation",
        "pageSizeSelector": "Items per page selector",
        "showingHistory": "Showing {count} credit history entries"
      }
    },
    "EditRoleAndPermission": {
      "createTitle": "Add New Role",
      "editTitle": "Edit Role",
      "roleInformation": "Role Information",
      "roleName": "Role Name",
      "rolePermissions": "Role Permissions",
      "permissionsDescription": "Granting permissions does not affect which features are available for your company account. The merchant must enable features to make them available for your account.",
      "expandAll": "Expand All",
      "collapseAll": "Collapse All",
      "saveRole": "Save Role"
    },
    "FormText": {
      "requiredFieldError": "This is a required field.",
      "numericError": "Only numeric values are allowed.",
      "alphaNumWithSpacesError": "Only alphanumeric characters and spaces are allowed.",
      "alphaNumericError": "Only alphanumeric characters are allowed.",
      "alphaError": "Only alphabetic characters are allowed.",
      "emailError": "Please enter a valid email address.",
      "phoneError": "Please enter a valid phone number.",
      "postalCodeError": "Please enter a valid postal code.",
      "lengthTextError": "Text length must be between {min} and {max} characters.",
      "urlError": "Please enter a valid URL",
      "nameError": "Please enter a valid name",
      "selectCountry": "Please select a country",
      "selectRegion": "Please select a region, state or province",
      "selectCountryFirst": "Please select a country first",
      "companyNameLengthError": "Company name must be between {min} and {max} characters.",
      "loading": "Loading...",
      "submitting": "Registering your company..."
    },
    "AcceptInvitation": {
      "title": "Accept Company Invitation",
      "loadingText": "Processing your invitation...",
      "successMessage": "You have successfully accepted the invitation to the company.",
      "myAccountButton": "My Account",
      "loginButton": "Go to Login",
      "invalidLinkError": "Invalid invitation link. Please check the URL and try again.",
      "companyDisabledError": "Company functionality is not enabled. Please contact the store administrator.",
      "expiredLinkError": "This invitation link has expired or is no longer valid.",
      "genericError": "An error occurred while processing your invitation. Please try again."
    },
    "RolesAndPermissions": {
      "containerTitle": "Company Roles & Permissions",
      "noAccess": {
        "title": "Access Restricted",
        "message": "You do not have permission to view roles and permissions. Please contact your company administrator."
      },
      "error": {
        "title": "Error Loading Roles",
        "message": "An error occurred while loading roles and permissions. Please try again."
      },
      "deleteModal": {
        "title": "Delete This Role?",
        "message": "This action cannot be undone. Are you sure you want to delete this role?",
        "confirm": "Delete",
        "cancel": "Cancel"
      },
      "cannotDeleteModal": {
        "title": "Cannot Delete Role",
        "message": "This role cannot be deleted because users are assigned to it. Reassign the users to another role to continue.",
        "ok": "OK"
      },
      "alerts": {
        "createSuccess": "Role \"{roleName}\" created successfully!",
        "createError": "Failed to create role. Please try again.",
        "createErrorPermissions": "Failed to create role. Please check your permissions and try again.",
        "updateSuccess": "Role \"{roleName}\" updated successfully!",
        "updateError": "Failed to update role. Please try again.",
        "updateErrorPermissions": "Failed to update role. Please check your permissions and try again.",
        "deleteError": "Failed to delete role. Please try again."
      }
    },
    "RoleAndPermissionTable": {
      "addNewRole": "Add New Role",
      "columnId": "ID",
      "columnRole": "Role",
      "columnUsers": "Users",
      "columnActions": "Actions",
      "editButton": "Edit",
      "duplicateButton": "Duplicate",
      "deleteButton": "Delete",
      "viewOnlyLabel": "View Only",
      "systemRoleLabel": "System Role",
      "itemCount": "Item(s)",
      "itemsRange": "Items {start}-{end} of {total}",
      "show": "Show",
      "perPage": "per page",
      "deleteRole": {
        "success": "You have deleted role \"{roleName}\"."
      }
    },
    "Table": {
      "sortedAscending": "Sorted ascending by {label}",
      "sortedDescending": "Sorted descending by {label}",
      "sortBy": "Sort by {label}"
    }
  }
}