This Help Center is a preview of a future release. The final Help Center will be available on the Validation date.

Identifier APIs

IT system administrators use these APIs to add, edit, or remove identifiers in company, company location, Partner, or Partner location master data to track and leverage information necessary to complete operations needed for serialized production, shipping and receiving, and regulatory compliance. These APIs only impact new identifiers, IT system administrators can edit identifiers without needing to fill out the entire set of data for the associated record.

Add Identifiers to Master Data

IT system administrators use this API to add identifiers to company, company location, Partner, or Partner location master data.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String

Required. The fully qualified name of the request event. Valid value is masterdata-manager:add-identifier-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is masterdata-manager.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  masterDataObjectId String

Required. The master data identifier for the master data record that the new identifier is being added to.
  masterDataObjectType Enumeration

Required. Specifies the type of identifier that is being added to the master data record.

Valid values:

  • COMPANY – The identifier for the company.
  • COMPANY_LOCATION – The identifier for the company location.
  • PARTNER – The identifier for the Partner.
  • PARTNER_LOCATION – The identifier for the Partner location.
  identifiers Array Required. The identifier for company, company location, Partner, or Partner location.
  masterDataIdentifierTypeDef Object

Required. The information for the identifiers to add.
      identifierType String

Required. The type of the identifier.

  • AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.
  • AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.
  • BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).
  • BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).
  • BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.
  • BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).
  • BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.
  • CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).
  • CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).
  • CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).
  • CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).
  • COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).
  • COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).
  • DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.
  • DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).
  • DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).
  • DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).
  • GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).
  • GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.
  • HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).
  • ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).
  • IN_COMPANY_ID – India Company ID (e.g. 5423695784236).
  • IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).
  • IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.
  • IN_LOCATION_ID – India Location ID (e.g. 65874532).
  • IN_MFR – India Manufacturing Code (e.g. 00552101).
  • IN_MRCH – India Merchant Exporter Code (e.g. 601227644).
  • IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.
  • IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.
  • KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.
  • KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).
  • KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).
  • KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.
  • RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.
  • RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.
  • RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • SGLN – 15-character SGLN format representation of Global Location Number:
    • Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
    • Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
  • TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).
  • UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
      identifierValue String Required. The identifier value.
      isPrimary Boolean

Required. Indicates whether the given company, company location, Partner, or Partner identifier is the primary identifier. One only identifier can be set as the primary identifier. Not all identifiers are eligible to be set as the primary.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "masterdata-manager:add-identifier:v1",
        "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "dataspace": "default",
        "appName": "masterdata-manager"
    },
    "payload": {
        "masterDataObjectId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "masterDataObjectType": "COMPANY",
        "identifiers": [
            {
                "identifierType": "AM_TIN",
                "identifierValue": "12345678",
                "isPrimary": false
            },
            {
                "identifierType": "BR_CNES",
                "identifierValue": ".1929229",
                "isPrimary": false
            }
        ]
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is masterdata-manager:add-identifier-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful. Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String

Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception returned for the request, if applicable.

Valid values:

  • BadRequestException – The request is missing fields or has invalid data.
  • NotFoundException – The requested information is not available.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The GUID of the updated master data record.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "masterdata-manager:add-identifier-response:v1",
        "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "mZDUcT-hcnkaS"
    },
    "payload": {
        "id": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07"
    }
}

Errors

Element Error Message Description
  • masterDataObjectType
  • identifierType
  • isPrimary
Invalid value for <field name>. Valid values are: (list of valid values, separated by commas). The error occurs if the value is not in the list of valid values.
masterDataObjectId Object <masterDataObjectId> does not exist.

The object does not exist.

masterDataObjectId Access not allowed to object specified by masterDataObjectId. This will return a 403 error code. The user does not have access to the object.
identifierValue and identifierType Error message from validation criteria is returned.

The identifiers do not pass the validation criteria.
identifierValue and identifierType

Identifier already exists for identifierType. Identifier [<type>] <value> already exists in Company or Partner master data.

The identifier already exists in company or Partner master data.

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Review TraceLink's API: Terms of Use

Edit Identifiers in Master Data

IT system administrators use this API to edit identifiers in company, company location, Partner, or Partner location master data.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String

Required. The fully qualified name of the request event. Valid value is masterdata-manager:edit-identifier:v1.

  ownerId String Required. The identifier for the Owner company associated with the request.
  appName String Required. The application that owns the event. Valid value is masterdata-manager.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  masterDataObjectId String

Required. The master data identifier for the master data record that the new identifier is being added to.
  masterDataObjectType Enumeration

Required. Specifies the type of identifier that is being edited within the master data record.

Valid values:

  • COMPANY
  • COMPANY_LOCATION
  • PARTNER
  • PARTNER_LOCATION
  oldIdentifier Object Required. The information for the current identifier.
    identifierType String

Required. The type of the identifier.

  • AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.
  • AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.
  • BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).
  • BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).
  • BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.
  • BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).
  • BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.
  • CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).
  • CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).
  • CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).
  • CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).
  • COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).
  • COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).
  • DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.
  • DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).
  • DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).
  • DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).
  • GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).
  • GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.
  • HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).
  • ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).
  • IN_COMPANY_ID – India Company ID (e.g. 5423695784236).
  • IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).
  • IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.
  • IN_LOCATION_ID – India Location ID (e.g. 65874532).
  • IN_MFR – India Manufacturing Code (e.g. 00552101).
  • IN_MRCH – India Merchant Exporter Code (e.g. 601227644).
  • IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.
  • IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.
  • KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.
  • KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).
  • KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).
  • KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.
  • RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.
  • RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.
  • RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • SGLN – 15-character SGLN format representation of Global Location Number:
    • Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
    • Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
  • TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).
  • UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
    identifierValue String Required. The identifier value.
    isPrimary Boolean

Required. Indicates whether the given company, company location, Partner, or Partner identifier is the primary identifier. One only identifier can be set as the primary identifier. Not all identifiers are eligible to be set as the primary.

TraceLink uses the primary identifier to identify the correct company, company location, Partner, or Partner location when the user updates the master data.

Valid values:

  • true – The identifier is the primary identifier.
  • false – (default) The identifier is not the primary identifier.
  newIdentifier Object Required. The information for the new identifier.
      identifierType String

Required. The type of the identifier.

  • AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.
  • AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.
  • BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).
  • BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).
  • BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.
  • BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).
  • BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.
  • CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).
  • CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).
  • CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).
  • CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).
  • COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).
  • COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).
  • DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.
  • DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).
  • DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).
  • DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).
  • GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).
  • GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.
  • HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).
  • ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).
  • IN_COMPANY_ID – India Company ID (e.g. 5423695784236).
  • IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).
  • IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.
  • IN_LOCATION_ID – India Location ID (e.g. 65874532).
  • IN_MFR – India Manufacturing Code (e.g. 00552101).
  • IN_MRCH – India Merchant Exporter Code (e.g. 601227644).
  • IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.
  • IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.
  • KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.
  • KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).
  • KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).
  • KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.
  • RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.
  • RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.
  • RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • SGLN – 15-character SGLN format representation of Global Location Number:
    • Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
    • Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
  • TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).
  • UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
      identifierValue String Required. The identifier value.
      isPrimary Boolean

Required. Indicates whether the given company, company location, Partner, or Partner identifier is the primary identifier. One only identifier can be set as the primary identifier. Not all identifiers are eligible to be set as the primary.

Example

Copy 
{
                        "header": {
                        "headerVersion": 1,
                        "eventName": "placeholder",
                        "ownerId": "placeholder",
                        "isErr": placeholder,
                        "errCode": "placeholder",
                        "licensePlate": "placeholder"
                        },
                        "payload": {
                        "userId": "placeholder",
                        "aptUserPreferenceId": "placeholder"
                        }
                    }

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is masterdata-manager:edit-identifier:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful. Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String

Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception returned for the request, if applicable.

Valid values:

  • BadRequestException – The request is missing fields or has invalid data.
  • NotFoundException – The requested information is not available.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The GUID of the updated master data record.

Example

Copy 
{
                        "header": {
                        "headerVersion": 1,
                        "eventName": "placeholder",
                        "ownerId": "placeholder",
                        "isErr": placeholder,
                        "errCode": "placeholder",
                        "licensePlate": "placeholder"
                        },
                        "payload": {
                        "userId": "placeholder",
                        "aptUserPreferenceId": "placeholder"
                        }
                    }

Errors

Element Error Message Description
  • masterDataObjectType
  • identifierType
  • isPrimary
Invalid value for <field name>. Valid values are: (list of valid values, separated by commas). The error occurs if the value is not in the list of valid values.
masterDataObjectId Object <masterDataObjectId> does not exist.

The object does not exist.

masterDataObjectId Access not allowed to object specified by masterDataObjectId. This will return a 403 error code. The user does not have access to the object.
newIdentifier and oldIdentifier Error message from validation criteria is returned.

The identifiers do not pass the validation criteria.
oldIdentifier

Identifier does not exists for identifierType. OldIdentifier [<type>]<value> does not exist in Company or Partner master data.

The identifier does not exist in company or Partner master data.

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Review TraceLink's API: Terms of Use

Remove Identifiers from Master Data

IT system administrators use this API to remove identifiers from company, company location, Partner, or Partner location master data.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String Required. The fully qualified name of the request event. Valid value is masterdata-manager:delete-identifier:v1.
  ownerId String Required. The identifier for the company providing the app.
  appName String Required. The application that owns the event. Valid value is masterdata-manager.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  masterDataObjectId String Required. The identifier for the master data record. The identifier is attached to this record.
  masterDataObjectType Enumeration

Required. Specifies the type of identifier that is being removed from the master data record.

Valid values:

  • COMPANY
  • COMPANY_LOCATION
  • PARTNER
  • PARTNER_LOCATION
  identifiers Array Required. Required. The identifier for company, company location, Partner, or Partner location.
    masterDataIdentifierTypeDef Object Required. The information to remove the identifier.
  • COMPANY
  • COMPANY_LOCATION
  • PARTNER
  • PARTNER_LOCATION
    identifierType String

Required. The type of the identifier.

  • AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.
  • AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.
  • BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).
  • BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).
  • BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.
  • BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).
  • BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.
  • CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).
  • CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).
  • CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).
  • CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).
  • COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).
  • COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).
  • DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.
  • DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).
  • DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).
  • DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).
  • GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).
  • GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.
  • HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).
  • ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).
  • IN_COMPANY_ID – India Company ID (e.g. 5423695784236).
  • IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).
  • IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.
  • IN_LOCATION_ID – India Location ID (e.g. 65874532).
  • IN_MFR – India Manufacturing Code (e.g. 00552101).
  • IN_MRCH – India Merchant Exporter Code (e.g. 601227644).
  • IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.
  • IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.
  • KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.
  • KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).
  • KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).
  • KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.
  • RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.
  • RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.
  • RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.
  • SGLN – 15-character SGLN format representation of Global Location Number:
    • Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
    • Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
  • TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).
  • UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
    identifierValue String Required. The identifier value.
    isPrimary Boolean

Required. Indicates whether the given company, company location, Partner, or Partner identifier is the primary identifier. One only identifier can be set as the primary identifier. Not all identifiers are eligible to be set as the primary.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "masterdata-manager:delete-identifier:v1",
        "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "dataspace": "default",
        "appName": "masterdata-manager"
    },
    "payload": {
        "masterDataObjectId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "masterDataObjectType": "COMPANY",
        "identifiers": [
            {
                "identifierType": "AM_TIN",
                "identifierValue": "12345678",
                "isPrimary": false
            }
        ]
    }
}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is masterdata-manager:delete-identifier-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful. Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String

Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception returned for the request, if applicable.

Valid values:

  • BadRequestException – The request is missing fields or has invalid data.
  • NotFoundException – The requested information is not available.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  id String Required. The GUID of the removed master data record.

Example

Copy 
{
    "header": {
        "headerVersion": 1,
        "eventName": "masterdata-manager:delete-identifier-response:v1",
        "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "NgvYli-SvzvQk"
    },
    "payload": {
        "id": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07"
    }
}

Errors

Element Error Message Description
  • masterDataObjectType
  • identifierType
  • isPrimary
Invalid value for <field name>. Valid values are: (list of valid values, separated by commas). The error occurs if the value is not in the list of valid values.
masterDataObjectId Object <masterDataObjectId> does not exist.

The object does not exist.

masterDataObjectId Access not allowed to object specified by masterDataObjectId. This will return a 403 error code. The user does not have access to the object.
identifiers

Identifier is primary identifierType. Identifiers[x] identifier [<type>]<value> is the primary identifier.

The identifier is the primary identifier.
identifiers

Identifier does not exists for identifierType. Identifiers[x] identifier [<type>]<value> does not exist in Company or Partner master data.

The identifier does not exist in company or Partner master data.

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.

Review TraceLink's API: Terms of Use