Skip to main content

Reference Data Services

The Reference Data Services API offers essential reference information for CMD and SMDS, enabling the retrieval of customer attribute data.

Overview of Reference Data Services:​

  • CMD Reference Data Services: This API allows users to access reference data related to Customer Master Data.
  • SMDS Reference Data Services: This API facilitates the retrieval of reference data concerning the Single Master Data Solution.

Retrieval Options:​

Data can be retrieved using various fields, including:

  1. Region Code
  2. Status Type
  3. Country Code
  4. Brand Code
  5. Segment Type Code
  6. ISO Language Code
  7. Reason Name

API Contract:​

For a detailed understanding of the request and response structure, refer to the following endpoint path: /customers/referenceData/.

  • /customers/referenceData/statusReasons: This endpoint returns customer status data. The following parameters are required to call this API:
    1. statusType
    2. reasonName
  • /customers/referenceData/customerStatusReasons: This endpoint retrieves customer status reasons. No parameters are required to call this API.
  • /customers/referenceData/customerGroups: This endpoint retrieves customer groups. No parameters are required to call this API.
  • /customers/referenceData/brands: This endpoint retrieves brand information. No parameters are required to call this API.
  • /customers/referenceData/communicationPrefTypes: This endpoint retrieves communication preference types. No parameters are required to call this API.
  • /customers/referenceData/isoLanguages: This endpoint retrieves ISO languages. No parameters are required to call this API.
  • /customers/referenceData/internationalDialingPrefixes: This endpoint retrieves international dialing prefixes. No parameters are required to call this API.
  • /customers/referenceData/internationalContactSalutations: This endpoint retrieves international contact salutations. No parameters are required to call this API.
  • /customers/referenceData/invoiceIsoLanguages: This endpoint retrieves invoice ISO language references. Optional parameters required:
    • countryIsoCode
    • isoLangCode
  • /customers/referenceData/primaryContactSalutations: This endpoint retrieves primary contact salutations. No parameters are required to call this API.
  • /customers/referenceData/contactTypes: This endpoint retrieves customer contact types. No parameters are required to call this API.
  • /customers/referenceData/relationshipTypes: This endpoint retrieves relationship types. No parameters are required to call this API.
  • /customers/referenceData/customerStatus: This endpoint retrieves customer status. No parameters are required to call this API.
  • /customers/referenceData/documentTypes: This endpoint retrieves document types. No parameters are required to call this API.
  • /customers/referenceData/customerTypes: This endpoint retrieves customer type references. No parameters are required to call this API.
  • /customers/referenceData/referenceNumberCodes: This endpoint retrieves reference number types. No parameters are required to call this API.
  • /customers/referenceData/segmentationTypes: This endpoint retrieves segmentation types. No parameters are required to call this API.
  • /customers/referenceData/segmentationValues: This endpoint retrieves segmentation values. Optional parameters required:
    • segmentTypeCode
    • brandCode
  • /customers/referenceData/taxNumberCodes: This endpoint retrieves tax number codes. No parameters are required to call this API.
  • /customers/referenceData/taxTypeLocalNames: This endpoint retrieves tax type local names. Optional parameter required:
    • countryIsoCode
  • /customers/referenceData/regionReference: This endpoint retrieves region references. Optional parameters required:
    • regionCode
    • countryCode

For further details, please refer to the documentation: API Documentation

Mandatory Rules:​

  1. The parameters reasonName and statusType are mandatory for retrieving customer status data.
  2. The following parameters are optional: countryCode, regionCode, countryIsoCode, segmentTypeCode, brandCode, and isoLangCode.

Database Table Details:​

Table Name: Ref_Customer_Group_Type Primary Key: CUST_GROUP_TYP_CD

CREATE TABLE ref_customer_group_type ( CUST_GROUP_TYP_CD VARCHAR(35) CONSTRAINT ref_customer_group_type_pk PRIMARY KEY, CUST_GROUP_TYP_NM VARCHAR(100), CUST_GROUP_TYP_DESC VARCHAR(255), CREATE_TIME VARCHAR, CREATE_USER VARCHAR(50), UPDATE_TIME VARCHAR, UPDATE_USER VARCHAR(50), IS_DELETED VARCHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: REF_BRANDS Primary Key: BRAND_LRA_CODE

CREATE TABLE REF_BRANDS ( BRAND_NAME VARCHAR(100), CONSTRAINT REF_BRANDS_PK PRIMARY KEY, BRAND_LRA_CODE VARCHAR(35), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Customer_Status_Rsn Primary Key: STATUS_RSN_CODE

CREATE TABLE Ref_Customer_Status_Rsn ( STATUS_RSN_CODE VARCHAR(10), CONSTRAINT Ref_Customer_Status_Rsn_PK PRIMARY KEY (STATUS_RSN_CODE), STATUS_CODE VARCHAR(10), STATUS_RSN_NAME VARCHAR(100), STATUS_RSN_DESC VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Communication_Pref_Types Primary Key: COMM_PREF_TYPE_CODE

CREATE TABLE Ref_Communication_Pref_Types ( COMM_PREF_TYPE_CODE VARCHAR(50), CONSTRAINT Ref_Communication_Pref_Types_PK PRIMARY KEY (COMM_PREF_TYPE_CODE), COMM_PREF_NAME VARCHAR(100), COMM_PREF_DESC VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_International_Cont_Salutation Primary Key: SALUTATION_CODE, ISO_LANG_CODE

CREATE TABLE Ref_International_Cont_Salutation ( ISO_LANG_CODE VARCHAR(2), SALUTATION_CODE VARCHAR(50), CONSTRAINT Ref_International_Cont_Salutation_PK PRIMARY KEY (SALUTATION_CODE, ISO_LANG_CODE), INTL_SALUTATION_NAME VARCHAR(100), INTL_SALUTATION_DESC VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_International_Dialing_Prefix Primary Key: COUNTRY_ISO_CODE

CREATE TABLE Ref_International_Dialing_Prefix ( COUNTRY_ISO_CODE VARCHAR(2), CONSTRAINT Ref_International_Dialing_Prefix_PK PRIMARY KEY (COUNTRY_ISO_CODE), DIALING_CODE VARCHAR(10), DIALING_CODE_DESC VARCHAR(50), COUNTRY_NAME VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Invoice_Iso_Languages Primary Key: COUNTRY_ISO_CODE, INVOICE_LANG_CODE_6391

CREATE TABLE Ref_Invoice_Iso_Languages ( COUNTRY_ISO_CODE VARCHAR(2), INVOICE_LANG_CODE_6391 VARCHAR(10), CONSTRAINT Ref_Invoice_Iso_Languages_PK PRIMARY KEY (COUNTRY_ISO_CODE, INVOICE_LANG_CODE_6391), INVOICE_LANG_CODE_DESC VARCHAR(50), DEFAULT_FLAG VARCHAR(1), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Contact_Primary_Salutation Primary Key: Salutation_Code

CREATE TABLE Ref_Contact_Primary_Salutation ( Salutation_Code VARCHAR(50), CONSTRAINT Ref_Contact_Primary_Salutation_PK PRIMARY KEY (Salutation_Code), Salutation_Name VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Contact_Class_Type Primary Key: Contact_CLASS_TYPE, Contact_CLASS_CODE

CREATE TABLE Ref_Contact_Class_Type ( Contact_CLASS_TYPE VARCHAR(50), Contact_CLASS_CODE VARCHAR(50), CONSTRAINT Ref_Contact_Class_Type_PK PRIMARY KEY (Contact_CLASS_TYPE, Contact_CLASS_CODE), Contact_CLASS_NAME VARCHAR(100), Contact_CLASS_DESC VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Iso_Languages Primary Key: ISO_LANG_CODE

CREATE TABLE Ref_Iso_Languages( ISO_LANG_CODE VARCHAR(10), CONSTRAINT Ref_Iso_Languages_PK PRIMARY KEY (ISO_LANG_CODE), ISO_LANG_NAME VARCHAR(100), ISO_LANG_DESC VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Customer_Status Primary Key: Status_CODE

CREATE TABLE Ref_Customer_Status( Status_CODE VARCHAR(50), CONSTRAINT Ref_Customer_Status_PK PRIMARY KEY (Status_CODE), Status_Name VARCHAR(100), Status_Desc VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Customer_Type Primary Key: Customer_Type_CODE

CREATE TABLE Ref_Customer_Type( Customer_Type_CODE VARCHAR(50), CONSTRAINT Ref_Customer_Type_PK PRIMARY KEY (Customer_Type_CODE), Customer_Type_Name VARCHAR(100), Customer_Type_Desc VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Document_Type Primary Key: Document_Type_CODE

CREATE TABLE Ref_Document_Type( Document_Type_CODE VARCHAR(50), CONSTRAINT Ref_Document_Type_PK PRIMARY KEY (Document_Type_CODE), Document_Type_Name VARCHAR(100), Document_Type_Desc VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Collection_Business_Units Primary Key: CBU_ID

CREATE TABLE Ref_Collection_Business_Units( CBU_ID VARCHAR(50), CONSTRAINT Ref_Collection_Business_Units_PK PRIMARY KEY (CBU_ID), CBU_NAME VARCHAR(100), BRAND_LRA_CODE VARCHAR(20), BRAND_NAME VARCHAR(100), COUNTRY_ISO_CD VARCHAR(2), COUNTRY_NAME VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Customer_Reference_Types Primary Key: REF_TYPE, REF_TYPE_CODE

CREATE TABLE Ref_Customer_Reference_Types( REF_TYPE VARCHAR(50), REF_TYPE_CODE VARCHAR(50), CONSTRAINT REF_REF_NUM_TYPE_PK PRIMARY KEY (REF_TYPE, REF_TYPE_CODE), REF_TYPE_NAME VARCHAR(100), REF_TYPE_DESC VARCHAR(100), REF_TYPE_GRP_CODE VARCHAR(50), REF_TYPE_GRP_NAME VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Relationshipship_Types Primary Key: REL_TYPE_CODE

CREATE TABLE Ref_Relationshipship_Types( REL_TYPE_CODE VARCHAR(50), CONSTRAINT REF_REL_TYPE_PK PRIMARY KEY (REL_TYPE_CODE), REL_TYPE_NAME VARCHAR(100), REL_TYPE_DESC VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Segmentation_Types Primary Key: BRAND_SEGMENT_TYPE

CREATE TABLE Ref_Segmentation_Types( BRAND_SEGMENT_TYPE VARCHAR(100), CONSTRAINT Ref_Segmentation_Types_PK PRIMARY KEY (BRAND_SEGMENT_TYPE), SEGMENT_TYPE_CODE VARCHAR(50), SEGMENT_TYPE_NAME VARCHAR(100), SEGMENT_TYPE_DESC VARCHAR(100), BRAND_LRA_CODE VARCHAR(10), ALLOW_MULTIPLE_IND VARCHAR(1), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Segmentation_Value_Type Primary Key: BRAND_SEGMENT_TYPE_VALUE

CREATE TABLE Ref_Segmentation_Value_Type( BRAND_SEGMENT_TYPE_VALUE VARCHAR(150), CONSTRAINT Ref_Segmentation_Value_Type_PK PRIMARY KEY (BRAND_SEGMENT_TYPE_VALUE), SEGMENT_TYPE_CODE VARCHAR(50), SEGMENT_VALUE_CODE VARCHAR(50), SEGMENT_VALUE_NAME VARCHAR(100), SEGMENT_VALUE_DESC VARCHAR(100), BRAND_LRA_CODE VARCHAR(10), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_Tax_Number_Codes Primary Key: TAX_TYPE_CODE

CREATE TABLE Ref_Tax_Number_Codes ( TAX_TYPE_CODE VARCHAR(50), CONSTRAINT Ref_Tax_Number_Codes_PK PRIMARY KEY (TAX_TYPE_CODE), TAX_TYPE_NAME VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Table Name: Ref_TAX_TYPE_Local_Name Primary Key: TAX_TYPE_CODE, COUNTRY_ISO_CODE

CREATE TABLE Ref_TAX_TYPE_Local_Name( TAX_TYPE_CODE VARCHAR(50), COUNTRY_ISO_CODE VARCHAR(2), CONSTRAINT Ref_TAX_TYPE_Local_Name_PK PRIMARY KEY (TAX_TYPE_CODE, COUNTRY_ISO_CODE), TAX_TYPE_NAME VARCHAR(100), STD_TAX_TYPE_CODE VARCHAR(50), STD_TAX_TYPE_DESC VARCHAR(100), CREATE_TIME DATE, CREATE_USER VARCHAR(50), UPDATE_TIME DATE, UPDATE_USER VARCHAR(50), IS_DELETED CHAR(1), SOURCE_OF_LAST_UPDATE VARCHAR(50) );

Was this page helpful?