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

Your company APIs

The full master data records for a company and its internal locations include the company's headquarters information, identifiers, and location master data on TraceLink. IT system administrators and app developers use these APIs to read the full master data record for their company and internal locations by submitting either regulatory identifier information for the company or location or a query that finds the company or location based on the contents of one or more fields. Additionally, IT system administrators use these APIs to edit the full master data record for their company and internal locations.

To ensure that company or company location master data is updated successfully, TraceLink recommends only submitting a few records at a time with each add or update request.

Get your Company Master Data

IT system administrators and app developers use this API to retrieve the full master data record for a company (e.g. name, address) based on the company's regulatory identifier information.

Get your Company Master Data request

Guidelines

Attribute		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:get-company-by-regulatory-identifier:v1`.
	ownerId	String	Required. The identifier for the company providing the app.
	dataspace	String	Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is `default`.
	appName	String	Required. The application that owns the event. Valid value is `masterdata-manager`.
payload		–	Required. The request body.
	regulatoryCompanyIdentifier	String	The value of the regulatory identifier.
	regulatoryCompanyIdentifierType	String	The type of the regulatory identifier.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "header": {
    "headerVersion": 1,
    "eventName": "masterdata-manager:get-company-by-regulatory-identifier:v1",
    "ownerId": "0510ad55-2abb-4316-bf60-e8578251c8fe",
    "dataspace": "default",
    "appName": "masterdata-manager"
  },
  "payload": {
    "regulatoryCompanyIdentifier": "123456",
    "regulatoryCompanyIdentifierType": "GLN"
  }
}

Get your Company Master Data response

Guidelines

Attribute							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:get-company-by-regulatory-identifier-response:v1`
	ownerId						String	Required. The identifier for the company providing the app.
	isErr						String	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 name. Valid values: `BadRequestException` – The request is missing fields or has invalid data. `NotFoundException` – The request references an object that does not exist in TraceLink.
payload							–	Required. The response body.
	pagingInfo						String	Required. The query paging information representing where the previous query result ended. The pagingInfo from the previous query may be used as the starting point for a new query.
	documents						Array	Required. Contains the results of the query request.
		metadata					Object	Required. The metadata about the object.
			schemaId				String	Required. The JSON schema that defines the object.
			schemaVersion				Integer	Required. The JSON schema version number.
			primaryKey				String	Required. The primary key of the object.
			dataVersion				Integer	Required. The current version number of the object.
			indexTarget				String	Required. The index target identifier of the object.
			dbTxid				Integer	Required. The transactional identifier of the object.
		payload					–	Required. The master data objects.
			schemaVersion				Integer	Required. The JSON schema version number.
			data				Object	Required. Contains the attributes for the object. The contents depend on the object schema specified when the event handlers were added.
				lscS3Identifier			String	Required. The identifier of the company object that S3 uses.
				isLegalEntity			Boolean	Specifies if the company is a legal entity. Valid values: `true` – The node is a legal entity. `false` – The node is not a legal entity.
				providerNetworkNodeIdentifier			String	Required. The network node of the originating company for the master data record.
				legalEntityCode			String	The legal entity code of the network node.
				companyNetworkNodeId			String	Required. The network node that the record belongs to.
				regulatoryCompanyIdentifiers			String	Required. The list of all identifiers of the company.
					regulatoryCompanyIdentifierTypeId		String	Required. The identifier type.
					isPrimaryRegulatoryIdentifier		String	Required. Specifies if the given identifier is the primary identifier.
					regulatoryIdentifierValue		String	Required. The identifier value.
				businessMasterDataCommon			TypeDef	Required. The common business information.
					businessType		String	The list of all business types of the company.
					lscBusinessVersion		String	Required. The business version identifier in Track & Trace Services.
					businessName		String	Required. The company's name.
					businessEmail		String	The company's email address.
					businessPhone		String	The company's phone number.
					businessUrl		String	The URL of the company's website.
					businessTaxRegistrationCode		String	The company's tax registration code.
					businessAddress		TypeDef	The company's address information.
						address1	String	Required. The street address, including number and street name.
						address2	String	The second line of the street address. Any additional address information, if available.
						buildingNumber	String	The company's building number.
						plantNumber	String	The facility's plant number.
						floorNumber	String	The facility's floor number.
						houseNumber	String	The building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in address1.
						city	String	The city in which the company is located.
						village	String	The village in which the company is located.
						township	String	The name of the town in which the company is located.
						district	String	The 3-digit numeric code of the district where the company is located in India.
						state	String	The state in which the company is located.
						postalCode	String	Conditionally required if the country has a ZIP or other postal code. If the country does have a postal code and it is omitted, an error is generated. See Valid values for exclusions. Valid values Angola, AO Antigua and Barbuda, AG Aruba, AW Bahamas, BS Belize, BZ Benin, BJ Botswana, BW Burkina Faso, BF Burundi, BI Cameroon, CM Central African Republic, CF Comoros, KM Congo, CG Congo, the Democratic Republic of the, CD Cook Islands, CK Cote d'Ivoire, CI Djibouti, DJ Dominica, DM Equatorial Guinea, GQ Eritrea, ER Fiji, FJ French Southern Territories, TF Gambia, GM Ghana, GH Grenada, GD Guinea, GN Guyana, GY Hong Kong, HK Ireland, IE Jamaica, JM Kenya, KE Kiribati, KI Macao, MO Malawi, MW Mali, ML Mauritania, MR Mauritius, MU Montserrat, MS Nauru, NR Netherlands Antilles, AN Niue, NU North Korea, KP Panama, PA Qatar, QA Rwanda, RW Saint Kitts and Nevis, KN Saint Lucia, LC Sao Tome and Principe, ST Saudi Arabia, SA Seychelles, SC Sierra Leone, SL Solomon Islands, SB Somalia, SO South Africa, ZA Suriname, SR Syria, SY Tanzania, United Republic of, TZ Timor-Leste, TL Tokelau, TK Tonga, TO Trinidad and Tobago, TT Tuvalu, TV Uganda, UG United Arab Emirates, AE Vanuatu, VU Yemen, YE Zimbabwe, ZW
						country	String	Required. The country using the standard two–letter abbreviation specified in ISO 3166–1alpha-2:1997 country code. Valid values `AD` – ANDORRA `AE` – UNITED ARAB EMIRATES `AF` – AFGHANISTAN `AG` – ANTIGUA AND BARBUDA `AI` – ANGUILLA `AL` – ALBANIA `AM` – ARMENIA `AN` – NETHERLANDS ANTILLES `AO` – ANGOLA `AQ` – ANTARCTICA `AR` – ARGENTINA `AS` – AMERICAN SAMOA `AT` – AUSTRIA `AU` – AUSTRALIA `AW` – ARUBA `AX` – ÅLAND ISLANDS `AZ` – AZERBAIJAN `BA` – BOSNIA AND HERZEGOVINA `BB` – BARBADOS `BD` – BANGLADESH `BE` – BELGIUM `BF` – BURKINA FASO `BG` – BULGARIA `BH` – BAHRAIN `BI` – BURUNDI `BJ` – BENIN `BL` – SAINT BARTHÉLEMY `BM` – BERMUDA `BN` – BRUNEI DARUSSALAM `BO` – BOLIVIA, PLURINATIONAL STATE OF `BR` – BRAZIL `BS` – BAHAMAS `BT` – BHUTAN `BV` – BOUVET ISLAND `BW` – BOTSWANA `BY` – BELARUS `BZ` – BELIZE `CA` – CANADA `CC` – COCOS (KEELING) ISLANDS `CD` – CONGO, THE DEMOCRATIC REPUBLIC OF THE `CF` – CENTRAL AFRICAN REPUBLIC `CG` – CONGO `CH` – SWITZERLAND `CI` – CÔTE D'IVOIRE `CK` – COOK ISLANDS `CL` – CHILE `CM` – CAMEROON `CN` – CHINA `CO` – COLOMBIA `CR` – COSTA RICA `CU` – CUBA `CV` – CAPE VERDE `CX` – CHRISTMAS ISLAND `CY` – CYPRUS `CZ` – CZECH REPUBLIC `DE` – GERMANY `DJ` – DJIBOUTI `DK` – DENMARK `DM` – DOMINICA `DO` – DOMINICAN REPUBLIC `DZ` – ALGERIA `EC` – ECUADOR `EE` – ESTONIA `EG` – EGYPT `EH` – WESTERN SAHARA `ER` – ERITREA `ES` – SPAIN `ET` – ETHIOPIA `FI` – FINLAND `FJ` – FIJI `FK` – FALKLAND ISLANDS (MALVINAS) `FM` – MICRONESIA, FEDERATED STATES OF `FO` – FAROE ISLANDS `FR` – FRANCE `GA` – GABON `GB` – UNITED KINGDOM `GD` – GRENADA `GE` – GEORGIA `GF` – FRENCH GUIANA `GG` – GUERNSEY `GH` – GHANA `GI` – GIBRALTAR `GL` – GREENLAND `GM` – GAMBIA `GN` – GUINEA `GP` – GUADELOUPE `GQ` – EQUATORIAL GUINEA `GR` – GREECE `GS` – SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS `GT` – GUATEMALA `GU` – GUAM `GW` – GUINEA–BISSAU `GY` – GUYANA `HK` - HONG KONG `HM` – HEARD ISLAND AND MCDONALD ISLANDS `HN` – HONDURAS `HR` – CROATIA `HT` – HAITI `HU` – HUNGARY `ID` – INDONESIA `IE` – IRELAND `IL` – ISRAEL `IM` – ISLE OF MAN `IN` – INDIA `IO` – BRITISH INDIAN OCEAN TERRITORY `IQ` – IRAQ `IR` – IRAN, ISLAMIC REPUBLIC OF `IS` – ICELAND `IT` – ITALY `JE` – JERSEY `JM` – JAMAICA `JO` – JORDAN `JP` – JAPAN `KE` – KENYA `KG` – KYRGYZSTAN `KH` – CAMBODIA `KI` – KIRIBATI `KM` – COMOROS `KN` – SAINT KITTS AND NEVIS `KP` – KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF `KR` – KOREA, REPUBLIC OF `KW` – KUWAIT `KY` – CAYMAN ISLANDS `KZ` – KAZAKHSTAN `LA` – LAO PEOPLE'S DEMOCRATIC REPUBLIC `LB` – LEBANON `LC` – SAINT LUCIA `LI` – LIECHTENSTEIN `LK` – SRI LANKA `LR` – LIBERIA `LS` – LESOTHO `LT` – LITHUANIA `LU` – LUXEMBOURG `LV` – LATVIA `LY` – LIBYAN ARAB JAMAHIRIYA `MA` – MOROCCO `MC` – MONACO `MD` – MOLDOVA, REPUBLIC OF `ME` – MONTENEGRO `MF` – SAINT MARTIN `MG` – MADAGASCAR `MH` – MARSHALL ISLANDS `MK` – MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF `ML` – MALI `MM` – MYANMAR `MN` – MONGOLIA `MO` – MACAO `MP` – NORTHERN MARIANA ISLANDS `MQ` – MARTINIQUE `MR` – MAURITANIA `MS` – MONTSERRAT `MT` – MALTA `MU` – MAURITIUS `MV` – MALDIVES `MW` – MALAWIÂ `MX` – MEXICO `MY` – MALAYSIA `MZ` – MOZAMBIQUE `NA` – NAMIBIA `NC` – NEW CALEDONIA `NE` – NIGER `NF` – NORFOLK ISLAND `NG` – NIGERIA `NI` – NICARAGUA `NL` – NETHERLANDS `NO` – NORWAY `NP` – NEPAL `NR` – NAURU `NU` – NIUE `NZ` – NEW ZEALAND `OM` – OMAN `PA` – PANAMA `PE` – PERU `PF` – FRENCH POLYNESIA `PG` – PAPUA NEW GUINEA `PH` – PHILIPPINES `PK` – PAKISTAN `PL` – POLAND `PM` – SAINT PIERRE AND MIQUELON `PN` – PITCAIRN `PR` – PUERTO RICO `PS` – PALESTINIAN TERRITORY, OCCUPIED `PT` – PORTUGAL `PW` – PALAU `PY` – PARAGUAY `QA` – QATAR `RE` – RÉUNION `RO` – ROMANIA `RS` – SERBIA `RU` – RUSSIAN FEDERATION `RW` – RWANDA `SA` – SAUDI ARABIA `SB` – SOLOMON ISLANDS `SC` – SEYCHELLES `SD` – SUDAN `SE` – SWEDEN `SG` – SINGAPORE `SH` – SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA `SI` – SLOVENIA `SJ` – SVALBARD AND JAN MAYEN `SK` – SLOVAKIA `SL` – SIERRA LEONE `SM` – SAN MARINO `SN` – SENEGAL `SO` – SOMALIA `SR` – SURINAME `ST` – SAO TOME AND PRINCIPE `SV` – EL SALVADOR `SY` – SYRIAN ARAB REPUBLIC `SZ` – SWAZILAND `TC` – TURKS AND CAICOS ISLANDS `TD` – CHAD `TF` – FRENCH SOUTHERN TERRITORIES `TG` – TOGO `TH` – THAILAND `TJ` – TAJIKISTAN `TK` – TOKELAU `TL` – TIMOR–LESTE `TM` – TURKMENISTAN `TN` – TUNISIA `TO` – TONGA `TR` – TURKEY `TT` – TRINIDAD AND TOBAGO `TV` – TUVALU `TW` – TAIWAN `TZ` – TANZANIA, UNITED REPUBLIC OF `UA` – UKRAINE `UG` – UGANDA `UM` – UNITED STATES MINOR OUTLYING ISLANDS `US` – UNITED STATES `UY` – URUGUAY `UZ` – UZBEKISTAN `VA` – HOLY SEE (VATICAN CITY STATE) `VC` – SAINT VINCENT AND THE GRENADINES `VE` – VENEZUELA, BOLIVARIAN REPUBLIC OF `VG` – VIRGIN ISLANDS, BRITISH `VI` – VIRGIN ISLANDS, U.S. `VN` – VIET NAM `VU` – VANUATU `WF` – WALLIS AND FUTUNA `WS` – SAMOA `XK` – KOSOVO `YE` – YEMEN `YT` – MAYOTTE `ZA` – SOUTH AFRICA `ZM` – ZAMBIA `ZW` – ZIMBABWE
						telephone	String	The office's telephone number.
						fax	String	The office's fax number.
						premisesCode	String	The identifier representing a physical area within the company location (e.g. a location's second floor).
						lscAddressidentifier	String	The global identifier assigned by Russian Federation Information Address System (FIAS). Maximum 36 characters, using the digits 0-9 and letters A-F.
					regulatoryContact		Object	The contact information for the regulatory contact at the company.
						regulatoryContactTitle	String	The regulatory contact's business title.
						regulatoryContactName	String	The regulatory contact's name.
						regulatoryContactEmail	String	The regulatory contact's email address.
						regulatoryContactPhone	Integer	The regulatory contact's phone number.
					businessLogo		Object	Information for the business logo.
						imageIdentifier	String	The business logo's image identifier.
						imageMimeType	String	The business logo's image mime type.
						imagefileName	String	The business logo's file name.
						imagebase64	String	A readable string of the image.
				regulatoryCompanyIdentifiersDerivedField			String	The result of the query when ftsInfo \| value equals `index-regulatoryPartnerIdentifiersWithBusinessNameDerivedField:[searchString]` in the request. This includes the following fields: businessName regulatoryCompanyIdentifierTypeId regulatoryIdentifierValue
				regulatoryCompanyIdentifiersWithBusinessNameDerivedField			String	The result of the query when ftsInfo \| value equals `index-regulatoryPartnerIdentifiersDerivedField:[searchString]` in the request. This includes the following fields: regulatoryCompanyIdentifierTypeId* regulatoryIdentifierValue
			schemaId				String	Required. The JSON schema that defines the object.
			id				String	Required. The identifier of the master data object.
			objectType				String	Required. The type of the object. Valid value is `masterdata-manager:productMasterData`.
			lastUpdatedDateTime				String	The identifier of the user that made the last update to the master data record.
			contextualOwnerId				String	Required. The identifier of the company sending the master data request.
			lastUpdatedByUserId				DateTime	The identifier of the user that made the last update to the master data record.
			ownerId				String	Required. The identifier of the company that owns the master data record.
			dataVersion				Integer	Required. The current version number of the object.
			createdByUserId				String	Required. The ID of the user that created the master data record.
			creationDateTime				DateTime	Required. The date and time when the master data record was created.
	primaryKey						String	Required. The primary key of the object.
facets							String	Required. Enables searches through a particular dataset.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
  "header": {
    "headerVersion": 1,
    "eventName": "masterdata-manager:get-company-by-regulatory-identifier-response:v1",
    "ownerId": "0510ad55-2abb-4316-bf60-e8578251c8fe",
    "isErr": false,
    "errCode": "200_OK",
    "licensePlate": "htdsgG"
  },
  "payload": {
    "pagingInfo": null,
    "documents": [
      {
        "metadata": {
          "schemaId": "masterdata-manager:companyMasterData",
          "schemaVersion": 1,
          "primaryKey": "masterdata-manager:companyMasterData#f8af495f-de32-4448-a197-2904dfb7dcd1",
          "dataVersion": 1,
          "indexTarget": "f8af495f-de32-4448-a197-2904dfb7dcd1",
          "dbTxId": 93446
        },
        "payload": {
          "schemaVersion": 1,
          "data": {
            "lscS3Identifier": "lscS3Identifier",
            "isLegalEntity": true,
            "providerNetworkNodeIdentifier": "providerNetworkNodeIdentifier",
            "legalEntityCode": "legalEntityCode",
            "companyNetworkNodeId": "companyNetworkNodeId",
            "regulatoryCompanyIdentifiers": [
              {
                "regulatoryCompanyIdentifierTypeId": "13487f42-8b26-49e6-8268-ef899de71532",
                "regulatoryCompanyIdentifierType": "SGLN",
                "isPrimaryRegulatoryIdentifier": false,
                "lscRegulatoryIdentifier": "lscRegulatoryIdentifier",
                "regulatoryIdentifierValue": "OneOne1"
              },
              {
                "regulatoryCompanyIdentifierTypeId": "13487f42-8b26-49e6-8268-ef899de71533",
                "regulatoryCompanyIdentifierType": "GLN",
                "isPrimaryRegulatoryIdentifier": false,
                "lscRegulatoryIdentifier": "lscRegulatoryIdentifier",
                "regulatoryIdentifierValue": "123456"
              }
            ],
            "businessMasterDataCommon": {
              "businessType": [
                "MANUFACTURER"
              ],
              "lscBusinessVersion": "lscBusinessVersion",
              "businessName": "Time Magazin",
              "businessEmail": "businessEmail",
              "businessPhone": "businessPhone",
              "businessUrl": "businessUrl",
              "businessTaxRegistrationCode": "businessTaxRegistrationCode",
              "businessAddress": {
                "address1": "address1",
                "address2": "address2",
                "buildingNumber": "buildingNumber",
                "plantNumber": "plantNumber",
                "floorNumber": "floorNumber",
                "houseNumber": "houseNumber",
                "city": "city",
                "village": "village",
                "township": "township",
                "district": "district",
                "state": "state",
                "postalCode": "postalCode",
                "country": "US",
                "telephone": "telephone",
                "fax": "fax",
                "url": "url",
                "lscAddressIdentifier": "lscAddressIdentifier"
              },
              "regulatoryContact": {
                "regulatoryContactTitle": "regulatoryContactTitle",
                "regulatoryContactName": "regulatoryContactName",
                "regulatoryContactEmail": "regulatoryContactEmail",
                "regulatoryContactPhone": "regulatoryContactPhone"
              },
              "businessLogo": {
                "imageIdentifier": "imageIdentifier",
                "imageMimeType": "imageMimeType",
                "imagefileName": "imagefileName",
                "imagebase64": "imagebase64"
              }
            },
            "regulatoryCompanyIdentifiersDerivedField": "SGLN OneOne1,GLN 123456",
            "regulatoryCompanyIdentifiersWithBusinessNameDerivedField": "Time Magazin SGLN OneOne1,Time Magazin GLN 123456"
          },
          "schemaId": "masterdata-manager:companyMasterData",
          "id": "f8af495f-de32-4448-a197-2904dfb7dcd1",
          "objectType": "masterdata-manager:companyMasterData",
          "lastUpdatedDateTime": 1615473059186,
          "contextualOwnerId": "00000000-0000-0000-0000-000000000000",
          "lastUpdatedByUserId": "f9f35dd0-035d-11eb-8ec8-0242ac11000c",
          "ownerId": "00000000-0000-0000-0000-000000000000",
          "dataVersion": 1,
          "createdByUserId": "f9f35dd0-035d-11eb-8ec8-0242ac11000c",
          "creationDateTime": 1615473059186
        },
        "primaryKey": "masterdata-manager:companyMasterData#f8af495f-de32-4448-a197-2904dfb7dcd1"
      }
    ],
    "facets": [
    ]
  }
}

Errors

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.

Edit your Company Master Data

IT system administrators use this API to edit the full master data record for a company (e.g. name, address). IT system administrators should retrieve the existing company master data record, edit the values that need to change, and then submit the entire record. These APIs overwrite the full set of data previously added to the associated record.

Edit your Company Master Data request

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-company:v4`.
	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.
data				Object	Required. Contains the attributes for the object. The contents depend on the object schema specified when the event handlers were added.
	regulatoryCompanyIdentifiers			Array	Required. The identifiers for a company.
		regulatoryIdentifierValue		String	Required. The value of the company identifier.
		isPrimaryRegulatoryIdentifier		Boolean	Required. Indicates whether the given company identifier is the primary identifier. Only one identifier can be set as the primary identifier. TraceLink uses the primary company identifier to identify the correct partner when the user updates the Master Data with an asynchronous message. Valid values: `true` – The identifier is the primary identifier. `false` – (default) The identifier is not the primary identifier.
		regulatoryCompanyIdentifierType		String	Required. The type of company identifier. Valid values `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.
	businessMasterDataCommon			Object	Required. The company's headquarters information.
		businessType		Array (String)	Required. The different types of business the company conducts. Valid values: `CARRYING_AND_FORWARDING_AGENT` – The company facilitates the movement and transfer of goods. In India, CFAs are often involved in moving goods as interstate stock transfers. `CHEMIST` – The company specializes in the composition of substances, may mix substances in preparation for dispensation, and has a shop selling medicines and cosmetics. Also known as a compounding facility. `DISTRIBUTOR` – The company distributes pharmaceuticals. `EXPORTER` – The company exports products. For customs purposes, this company makes the export declaration and sells the products to a company in another country, known as the importer. `HEALTHCARE_FACILITY` – The company dispenses pharmaceuticals as a healthcare facility. `IMPORTER` – The company imports products. For customs purposes, this company makes the import declaration, the shipping document names the company as consignee, and the exporter's invoice names the company as buyer. `LOGISTICS` – The company provides logistics services (e.g. LSP, 3PL). `MANUFACTURER` – The license holder of the pharmaceutical product (e.g. Brand Owners, Generics, MAHs, Specialty Companies). `PACKAGER` – The company packages products. `PHARMACY` – The company sells product directly to patients. `RETURNS_PROCESSOR` – The company processes returns. `STOCKIST` – The company stocks the products and then distributes them. `WHOLESALER` – The company is a wholesaler of pharmaceuticals.
		businessName		String	Required. The company's name.
		businessEmail		String	The company's email address.
		businessPhone		String	The company's telephone number.
		businessURL		String	The company's URL.
		businessTaxRegistrationCode		String	The company's tax registration code. The code used to identify this entity for tax or other legal reporting purposes.
		businessAddress		Object	The company's address information.
			address1	String	Required. The street address, including number and street name.
			address2	String	The second line of the street address. Any additional address information, if available.
			buildingNumber	String	The company's building number.
			plantNumber	String	The company's plant number.
			floorNumber	String	The company's floor number.
			houseNumber	String	The unique number on the street for this company.
			city	String	Required. The city where the company is located.
			village	String	The village in which the company is located.
			township	String	The name of the town in which the company is located.
			district	String	The 3-digit numeric code of the district where the company is located in India.
			stateOrRegion	String	Required. The state, province, or region using the standard two– or three–letter abbreviation specified in the ISO 3166–2:1998 country subdivision code.
			country	String	Required. The country using the standard two–letter abbreviation specified in ISO 3166–1alpha-2:1997 country code.
			telephone	String	The phone number of the contact person or department at the company.
			fax	String	The company's fax number.
			url	String	The URL of the company's website.
			premisesCode	String	The internal identifier associated with this company (e.g. a company with 4 locations in the city of Mumbai internally refers to the 4th location as MUM4).
	regulatoryContact			Array	The contact information for the regulatory contact at the company. Each field can only appear once per company.
		regulatoryContactName		String	The regulatory contact's name in base64 format.
		regulatoryContactTitle		String	The regulatory contact's business title.
		regulatoryContactEmail		String	The regulatory contact's email address.
		regulatoryContactPhone		String	The regulatory contact's phone number.
	businessLogo			Object	The image file displaying the company logo.
		imagebase64		String	The readable string of the company's image in base64 format.
		imageMimeType		String	Required. The file type of the image. Valid values: `BMP` – Bitmap image file. `GIF` – Graphics Interchange Format. `JPG` – Image format developed by Joint Photographic Experts group. `PNG` – Portable Network Graphics.
		imagefileName		String	The file name of the image. If the file name is not provided, value defaults to `companyImage.[file type]`.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
{
    "header": {
        "headerVersion": 1,
        "eventName": "masterdata-manager:add-company:v4",
        "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "dataspace": "default",
        "appName": "masterdata-manager"
    },
    "payload": {
        "id": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "data": {
            "businessMasterDataCommon": {
                "businessEmail": "jbean@trace.com",
                "regulatoryContact": {
                    "regulatoryContactPhone": "+1-706-8752559",
                    "regulatoryContactEmail": "mary_garcia@yahoo.com",
                    "regulatoryContactTitle": "Job Title",
                    "regulatoryContactName": "Mary Garcia"
                },
                "businessLogo": {
                    "imagefileName": "",
                    "imageMimeType": "image/png",
                    "imagebase64": "base64data"
                },
                "businessName": "ZZAuto2022061015511055416",
                "businessUrl": "url",
                "businessPhone": "978-222-1112",
                "businessAddress": {
                    
                    "address1": "202 Main Street",
                    "address2": "RiverPark Drive",
                    "buildingNumber": "buildingNumber",
                    "plantNumber": "plantNumber",
                    "floorNumber": "floorNumber",
                    "houseNumber": "houseNumber",
                    "city": "North Reading",
                    "village": "village",
                    "township": "township"
                    "district": "district",
                    "state": "MA",
                    "postalCode": "01940",
                    "country": "US",
                    "fax": "978-224-3421",
                    "premisesCode": "premisesCode",
                },
                "businessType": [
                    "MANUFACTURER"
                ],
                "businessTaxRegistrationCode": "gbnffke"
            },
            "regulatoryCompanyIdentifiers": [
                {
                    "regulatoryCompanyIdentifierType": "GLN",
                    "lscRegulatoryIdentifier": "0c8a2a7d-aa3e-4afa-be7b-6d712f6d4919",
                    "regulatoryIdentifierValue": "3216805777987",
                    "isPrimaryRegulatoryIdentifier": true,
                    "normalizedRegulatoryIdentifierValue": "GLN|3216805777987"
                },
                {
                    "regulatoryCompanyIdentifierType": "SGLN",
                    "lscRegulatoryIdentifier": "f6cbef86-7941-486f-a1bb-bd45b35ca5ac",
                    "regulatoryIdentifierValue": "32168057.7798.0",
                    "isPrimaryRegulatoryIdentifier": false,
                    "normalizedRegulatoryIdentifierValue": "SGLN|3216805777980"
                },
                {
                    "regulatoryCompanyIdentifierType": "DUNS",
                    "lscRegulatoryIdentifier": "4c2b6322-7402-4b75-9123-3cd83641d9ae",
                    "regulatoryIdentifierValue": "216287609",
                    "isPrimaryRegulatoryIdentifier": false,
                    "normalizedRegulatoryIdentifierValue": "DUNS|216287609"
                },
                {
                    "regulatoryCompanyIdentifierType": "AR_CUIT",
                    "lscRegulatoryIdentifier": "5bcea934-5036-48cc-9055-303540482542",
                    "regulatoryIdentifierValue": "30-48336180-0",
                    "isPrimaryRegulatoryIdentifier": false,
                    "normalizedRegulatoryIdentifierValue": "AR_CUIT|30483361800"
                }
            ]
        }
    }
}

Edit your Company Master Data response

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-company-response:v4`.
	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	Conditionally required if the call is successful. The identifier for the updated company.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "header": {
        "headerVersion": 1,
        "eventName": "masterdata-manager:add-company-response:v4",
        "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "szZIA8-5LSqhV"
    },
    "payload": {
        "id": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07"
    }
}

Errors

Changed regulatoryPartnerIdentifiers to regulatoryCompanyIdentifiers in the element column in rows 2,3,4 and 5. Verify in the spec but Saurabh confirmed that this is probably a typo.

Element	Error Message	Description
isPrimaryRegulatoryIdentifier regulatoryCompanyIdentifierType businessType imageMimeType	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.
regulatoryCompanyIdentifiers	Your company does not have the Identifier [<type>] <value> set as the primary. Make sure the identifier is set as the primary for your company.	The error occurs if the regulatoryPartnerIdentifiers specifies a primary ID that is in use but is not the primary company Id.
regulatoryCompanyIdentifiers	Identifier [<type>] <value> does not exist for your company. Make sure the primary identifier in the request is currently set as the primary for your company.	The error occurs if the regulatoryPartnerIdentifiers specifies a primary ID that does not belong to the company.
regulatoryCompanyIdentifiers	Identifiers must be unique. Identifier [<type>] <value> already exists in company or Partner master data.	The error occurs if the non-primary Identifier [<type>] <value> that are being added already exist in another company or location in company master data or Partner master data.
regulatoryCompanyIdentifiers	Identifier Type <type> has two values. Only one identifier value for each type can be added for your company, except for COMPANYID and COMPANYSITEID.	The error occurs if regulatoryPartnerIdentifiers is set to to use an Identifier Type <type> more than once for each partner company, except for COMPANYID and COMPANYSITEID.
isPrimaryRegulatoryIdentifier	Multiple identifiers are currently set as the primary. Only one identifier can be set as the primary identifier.	The error occurs if isPrimaryRegulatoryIdentifier to set multiple identifiers as the primary identifier.
removeIdentifier	Identifier [<type>] <value> is set as the primary identifier. Set another identifier as the primary to remove it.	The error occurs if removeIdentifier is set to remove the primary identifier before setting another identifier as the primary.
businessEmail	An email address is not in the valid format.	The error occurs if an invalid email address is entered.
regulatoryContactEmail	An email address is not in the valid format.	The error occurs if an invalid email address is entered.

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.

Query your Company Master Data

IT system administrators and app developers use this API to retrieve the full master data record for a company (e.g. contact information, identifiers).

Query your Company Master Data request

Guidelines

Attribute					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:query-companyMasterData: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.
	predicates				Array	Required. The contents of the query.
		type			String	Required. The type of the predicate. Valid value is `PREDICATE`.
		logicalOperator			String	Required. The logical operator of the predicate. Valid values: `AND` `OR` `TRUE`
		clauses			Array	Required. The attributes and values to include in the response message.
			type		String	Required. The type of the clause. Valid value is `TERM`.
			comparisonOperator		String	Required. The operator of the term. Valid values: `CLOSED` - Search for values within a range, including the endpoints of the range `CLOSED_OPEN` - Search for values within a range, where the range includes the lower endpoint and does not include the upper endpoint `DB_FTS` - Perform a full-text search using the query term. Does not support wildcards. `EQ` - Equal to `GE` - Greater than or equal to `GT` - Greater than `IN` - Search for values that are included in the given list `LE` - Less than or equal to `LT` - Less than `LUCENE_FTS` - Perform a Lucene search using the contents of ftsInfo. Lucene wildcards are supported. `NE` - Not equal `OPEN` - Search for values within a range, not including the endpoints of the range `OPEN_CLOSED` - Search for values within a range, where the range does not include the lower endpoint and does include the upper endpoint `WILDCARD` - Perform a search that matches the wildcard query. Supported wildcards are `*` and `.`.
			schemaId		String	Required. The schema identifier of the network objects being queried.
			ftsInfo		Object	Required. The Lucene query info.
				value	String	Required. Determines the content the query searches for. Replace "[searchString]" with the search value. Valid values: `index-regulatoryPartnerIdentifiersWithBusinessNameDerivedField:[searchString]` Simultaneously searches for the [searchString] in the following fields: businessName regulatoryCompanyIdentifierTypeId regulatoryIdentifierValue `index-regulatoryPartnerIdentifiersDerivedField:[searchString]` Simultaneously searches for the [searchString] in the following fields: regulatoryCompanyIdentifierTypeId regulatoryIdentifierValue `index-businessMasterDataCommon.businessName:[searchString]` Searches the businessName field.
				pageIndex	Integer	Required. The index of the first page of results to display, starting at `0`.
				sortField	Object	Required. The method of sorting the values in the relevant indexes. Valid values: `ASCENDING` `DESCENDING`
	maximumResults				Integer	Required. The maximum number of results returned in the response.
	pagingInfo				String	Required. The query paging information representing where the previous query result ended. The pagingInfo from the previous query may be used as the starting point for the current query.
	keyFormat				String	Required. The format of the response to a key-only query. Valid values: `OBJECT_ID` – The object identifier of the document is returned in the response. `PRIMARY_KEY` – The primary key of the object in schemaId#objectId format is returned in the response.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "header": {
    "headerVersion": 1,
    "eventName": "masterdata-manager:query-companyMasterData:v1",
    "ownerId": "0510ad55-2abb-4316-bf60-e8578251c8fe",
    "dataspace": "default",
    "appName": "masterdata-manager"
  },
  "payload": {
    "predicates": [
      {
        "type": "PREDICATE",
        "logicalOperator": "TRUE",
        "clauses": [{
          "type": "TERM",
          "comparisonOperator": "LUCENE_FTS",
          "schemaId": "masterdata-manager:companyMasterData",
          "ftsInfo": {
            "value": "index-regulatoryCompanyIdentifiersWithBusinessNameDerivedField:*123*",
            "pageIndex": 0,
            "sortField": {
            }
          }
        }]
      }    
    ],
    "maximumResults": 10000,
    "pagingInfo": "",
    "keyFormat": "PRIMARY_KEY"
  }
}

Query your Company Master Data response

Guidelines

Attribute							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:query-companyMasterData:v1`.
	ownerId						String	Required. The identifier for the company providing the app.
	isErr						String	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 name. Valid values: `BadRequestException` – The request is missing fields or has invalid data. `NotFoundException` – The request references an object that does not exist in TraceLink.
payload							–	Required. The response body.
	pagingInfo						String	Required. The query paging information representing where the previous query result ended. The pagingInfo from the previous query may be used as the starting point for a new query.
	documents						Array	Required. Contains the results of the query request.
		metadata					Object	Required. The metadata about the object.
			schemaId				String	Required. The JSON schema that defines the object.
			schemaVersion				Integer	Required. The JSON schema version number.
			primaryKey				String	Required. The primary key of the object.
			dataVersion				Integer	Required. The current version number of the object.
			indexTarget				String	Required. The index target identifier of the object.
			dbTxid				Integer	Required. The transactional identifier of the object.
		payload					–	Required. The master data objects.
			schemaVersion				Integer	Required. The JSON schema version number.
			data				Object	Required. Contains the attributes for the object. The contents depend on the object schema specified when the event handlers were added.
				lscS3Identifier			String	Required. The identifier of the company object that S3 uses.
				isLegalEntity			Boolean	Specifies if the company is a legal entity. Valid values: `true` – The node is a legal entity. `false` – The node is not a legal entity.
				providerNetworkNodeIdentifier			String	Required. The network node of the originating company for the master data record.
				legalEntityCode			String	The legal entity code of the network node.
				companyNetworkNodeId			String	Required. The network node that the record belongs to.
				regulatoryCompanyIdentifiers			String	Required. The list of all identifiers of the company.
					regulatoryCompanyIdentifierTypeId		String	Required. The identifier type.
					isPrimaryRegulatoryIdentifier		String	Required. Specifies if the given identifier is the primary identifier.
					regulatoryIdentifierValue		String	Required. The identifier value.
				businessMasterDataCommon			TypeDef	Required. The common business information.
					businessType		String	The list of all business types of the company.
					lscBusinessVersion		String	Required. The business version identifier in Track & Trace Services.
					businessName		String	Required. The company's name.
					businessEmail		String	The company's email address.
					businessPhone		String	The company's phone number.
					businessUrl		String	The URL of the company's website.
					businessTaxRegistrationCode		String	The company's tax registration code.
					businessAddress		TypeDef	The company's address information.
						address1	String	The street address, including number and street name.
						address2	String	The second line of the street address. Any additional address information, if available.
						buildingNumber	String	The company's building number.
						plantNumber	String	The facility's plant number.
						floorNumber	String	The facility's floor number.
						houseNumber	String	The building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in address1.
						city	String	The city in which the company is located.
						village	String	The village in which the company is located.
						township	String	The name of the town in which the company is located.
						district	String	The 3-digit numeric code of the district where the company is located in India.
						state	String	The state in which the company is located.
						postalCode	String	Conditionally required if the country has a ZIP or other postal code. If the country does have a postal code and it is omitted, an error is generated. See Valid values for exclusions. Valid values Angola, AO Antigua and Barbuda, AG Aruba, AW Bahamas, BS Belize, BZ Benin, BJ Botswana, BW Burkina Faso, BF Burundi, BI Cameroon, CM Central African Republic, CF Comoros, KM Congo, CG Congo, the Democratic Republic of the, CD Cook Islands, CK Cote d'Ivoire, CI Djibouti, DJ Dominica, DM Equatorial Guinea, GQ Eritrea, ER Fiji, FJ French Southern Territories, TF Gambia, GM Ghana, GH Grenada, GD Guinea, GN Guyana, GY Hong Kong, HK Ireland, IE Jamaica, JM Kenya, KE Kiribati, KI Macao, MO Malawi, MW Mali, ML Mauritania, MR Mauritius, MU Montserrat, MS Nauru, NR Netherlands Antilles, AN Niue, NU North Korea, KP Panama, PA Qatar, QA Rwanda, RW Saint Kitts and Nevis, KN Saint Lucia, LC Sao Tome and Principe, ST Saudi Arabia, SA Seychelles, SC Sierra Leone, SL Solomon Islands, SB Somalia, SO South Africa, ZA Suriname, SR Syria, SY Tanzania, United Republic of, TZ Timor-Leste, TL Tokelau, TK Tonga, TO Trinidad and Tobago, TT Tuvalu, TV Uganda, UG United Arab Emirates, AE Vanuatu, VU Yemen, YE Zimbabwe, ZW
						country	String	Required. The country using the standard two–letter abbreviation specified in ISO 3166–1alpha-2:1997 country code. Valid values `AD` – ANDORRA `AE` – UNITED ARAB EMIRATES `AF` – AFGHANISTAN `AG` – ANTIGUA AND BARBUDA `AI` – ANGUILLA `AL` – ALBANIA `AM` – ARMENIA `AN` – NETHERLANDS ANTILLES `AO` – ANGOLA `AQ` – ANTARCTICA `AR` – ARGENTINA `AS` – AMERICAN SAMOA `AT` – AUSTRIA `AU` – AUSTRALIA `AW` – ARUBA `AX` – ÅLAND ISLANDS `AZ` – AZERBAIJAN `BA` – BOSNIA AND HERZEGOVINA `BB` – BARBADOS `BD` – BANGLADESH `BE` – BELGIUM `BF` – BURKINA FASO `BG` – BULGARIA `BH` – BAHRAIN `BI` – BURUNDI `BJ` – BENIN `BL` – SAINT BARTHÉLEMY `BM` – BERMUDA `BN` – BRUNEI DARUSSALAM `BO` – BOLIVIA, PLURINATIONAL STATE OF `BR` – BRAZIL `BS` – BAHAMAS `BT` – BHUTAN `BV` – BOUVET ISLAND `BW` – BOTSWANA `BY` – BELARUS `BZ` – BELIZE `CA` – CANADA `CC` – COCOS (KEELING) ISLANDS `CD` – CONGO, THE DEMOCRATIC REPUBLIC OF THE `CF` – CENTRAL AFRICAN REPUBLIC `CG` – CONGO `CH` – SWITZERLAND `CI` – CÔTE D'IVOIRE `CK` – COOK ISLANDS `CL` – CHILE `CM` – CAMEROON `CN` – CHINA `CO` – COLOMBIA `CR` – COSTA RICA `CU` – CUBA `CV` – CAPE VERDE `CX` – CHRISTMAS ISLAND `CY` – CYPRUS `CZ` – CZECH REPUBLIC `DE` – GERMANY `DJ` – DJIBOUTI `DK` – DENMARK `DM` – DOMINICA `DO` – DOMINICAN REPUBLIC `DZ` – ALGERIA `EC` – ECUADOR `EE` – ESTONIA `EG` – EGYPT `EH` – WESTERN SAHARA `ER` – ERITREA `ES` – SPAIN `ET` – ETHIOPIA `FI` – FINLAND `FJ` – FIJI `FK` – FALKLAND ISLANDS (MALVINAS) `FM` – MICRONESIA, FEDERATED STATES OF `FO` – FAROE ISLANDS `FR` – FRANCE `GA` – GABON `GB` – UNITED KINGDOM `GD` – GRENADA `GE` – GEORGIA `GF` – FRENCH GUIANA `GG` – GUERNSEY `GH` – GHANA `GI` – GIBRALTAR `GL` – GREENLAND `GM` – GAMBIA `GN` – GUINEA `GP` – GUADELOUPE `GQ` – EQUATORIAL GUINEA `GR` – GREECE `GS` – SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS `GT` – GUATEMALA `GU` – GUAM `GW` – GUINEA–BISSAU `GY` – GUYANA `HK` - HONG KONG `HM` – HEARD ISLAND AND MCDONALD ISLANDS `HN` – HONDURAS `HR` – CROATIA `HT` – HAITI `HU` – HUNGARY `ID` – INDONESIA `IE` – IRELAND `IL` – ISRAEL `IM` – ISLE OF MAN `IN` – INDIA `IO` – BRITISH INDIAN OCEAN TERRITORY `IQ` – IRAQ `IR` – IRAN, ISLAMIC REPUBLIC OF `IS` – ICELAND `IT` – ITALY `JE` – JERSEY `JM` – JAMAICA `JO` – JORDAN `JP` – JAPAN `KE` – KENYA `KG` – KYRGYZSTAN `KH` – CAMBODIA `KI` – KIRIBATI `KM` – COMOROS `KN` – SAINT KITTS AND NEVIS `KP` – KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF `KR` – KOREA, REPUBLIC OF `KW` – KUWAIT `KY` – CAYMAN ISLANDS `KZ` – KAZAKHSTAN `LA` – LAO PEOPLE'S DEMOCRATIC REPUBLIC `LB` – LEBANON `LC` – SAINT LUCIA `LI` – LIECHTENSTEIN `LK` – SRI LANKA `LR` – LIBERIA `LS` – LESOTHO `LT` – LITHUANIA `LU` – LUXEMBOURG `LV` – LATVIA `LY` – LIBYAN ARAB JAMAHIRIYA `MA` – MOROCCO `MC` – MONACO `MD` – MOLDOVA, REPUBLIC OF `ME` – MONTENEGRO `MF` – SAINT MARTIN `MG` – MADAGASCAR `MH` – MARSHALL ISLANDS `MK` – MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF `ML` – MALI `MM` – MYANMAR `MN` – MONGOLIA `MO` – MACAO `MP` – NORTHERN MARIANA ISLANDS `MQ` – MARTINIQUE `MR` – MAURITANIA `MS` – MONTSERRAT `MT` – MALTA `MU` – MAURITIUS `MV` – MALDIVES `MW` – MALAWIÂ `MX` – MEXICO `MY` – MALAYSIA `MZ` – MOZAMBIQUE `NA` – NAMIBIA `NC` – NEW CALEDONIA `NE` – NIGER `NF` – NORFOLK ISLAND `NG` – NIGERIA `NI` – NICARAGUA `NL` – NETHERLANDS `NO` – NORWAY `NP` – NEPAL `NR` – NAURU `NU` – NIUE `NZ` – NEW ZEALAND `OM` – OMAN `PA` – PANAMA `PE` – PERU `PF` – FRENCH POLYNESIA `PG` – PAPUA NEW GUINEA `PH` – PHILIPPINES `PK` – PAKISTAN `PL` – POLAND `PM` – SAINT PIERRE AND MIQUELON `PN` – PITCAIRN `PR` – PUERTO RICO `PS` – PALESTINIAN TERRITORY, OCCUPIED `PT` – PORTUGAL `PW` – PALAU `PY` – PARAGUAY `QA` – QATAR `RE` – RÉUNION `RO` – ROMANIA `RS` – SERBIA `RU` – RUSSIAN FEDERATION `RW` – RWANDA `SA` – SAUDI ARABIA `SB` – SOLOMON ISLANDS `SC` – SEYCHELLES `SD` – SUDAN `SE` – SWEDEN `SG` – SINGAPORE `SH` – SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA `SI` – SLOVENIA `SJ` – SVALBARD AND JAN MAYEN `SK` – SLOVAKIA `SL` – SIERRA LEONE `SM` – SAN MARINO `SN` – SENEGAL `SO` – SOMALIA `SR` – SURINAME `ST` – SAO TOME AND PRINCIPE `SV` – EL SALVADOR `SY` – SYRIAN ARAB REPUBLIC `SZ` – SWAZILAND `TC` – TURKS AND CAICOS ISLANDS `TD` – CHAD `TF` – FRENCH SOUTHERN TERRITORIES `TG` – TOGO `TH` – THAILAND `TJ` – TAJIKISTAN `TK` – TOKELAU `TL` – TIMOR–LESTE `TM` – TURKMENISTAN `TN` – TUNISIA `TO` – TONGA `TR` – TURKEY `TT` – TRINIDAD AND TOBAGO `TV` – TUVALU `TW` – TAIWAN `TZ` – TANZANIA, UNITED REPUBLIC OF `UA` – UKRAINE `UG` – UGANDA `UM` – UNITED STATES MINOR OUTLYING ISLANDS `US` – UNITED STATES `UY` – URUGUAY `UZ` – UZBEKISTAN `VA` – HOLY SEE (VATICAN CITY STATE) `VC` – SAINT VINCENT AND THE GRENADINES `VE` – VENEZUELA, BOLIVARIAN REPUBLIC OF `VG` – VIRGIN ISLANDS, BRITISH `VI` – VIRGIN ISLANDS, U.S. `VN` – VIET NAM `VU` – VANUATU `WF` – WALLIS AND FUTUNA `WS` – SAMOA `XK` – KOSOVO `YE` – YEMEN `YT` – MAYOTTE `ZA` – SOUTH AFRICA `ZM` – ZAMBIA `ZW` – ZIMBABWE
						telephone	String	The office's telephone number.
						fax	String	The office's fax number.
						premisesCode	String	The identifier representing a physical area within the company location (e.g. a location's second floor).
						lscAddressidentifier	String	The global identifier assigned by Russian Federation Information Address System (FIAS). Maximum 36 characters, using the digits 0-9 and letters A-F.
					regulatoryContact		Object	The contact information for the regulatory contact at the company.
						regulatoryContactTitle	String	The regulatory contact's business title.
						regulatoryContactName	String	The regulatory contact's name.
						regulatoryContactEmail	String	The regulatory contact's email address.
						regulatoryContactPhone	Integer	The regulatory contact's phone number.
					businessLogo		Object	Information for the business logo.
						imageIdentifier	String	The business logo's image identifier.
						imageMimeType	String	The business logo's image mime type.
						imagefileName	String	The business logo's file name.
						imagebase64	String	A readable string of the image.
				regulatoryCompanyIdentifiersDerivedField			String	The result of the query when ftsInfo \| value equals `index-regulatoryPartnerIdentifiersWithBusinessNameDerivedField:[searchString]` in the request. This includes the following fields: businessName regulatoryCompanyIdentifierTypeId regulatoryIdentifierValue
				regulatoryCompanyIdentifiersWithBusinessNameDerivedField			String	The result of the query when ftsInfo \| value equals `index-regulatoryPartnerIdentifiersDerivedField:[searchString]` in the request. This includes the following fields: regulatoryCompanyIdentifierTypeId* regulatoryIdentifierValue
			schemaId				String	Required. The JSON schema that defines the object.
			id				String	Required. The identifier of the master data object for one record.
			objectType				String	Required. The type of the object. Valid value is `masterdata-manager:productMasterData`.
			lastUpdatedDateTime				String	The identifier of the user that made the last update to the master data record.
			contextualOwnerId				String	Required.The identifier of the company sending the master data request.
			lastUpdatedByUserId				DateTime	The identifier of the user that made the last update to the master data record.
			ownerId				String	Required. The identifier of the company that owns the master data record.
			dataVersion				Integer	Required. The current version number of the object.
			createdByUserId				String	Required. The ID of the user that created the master data record.
			creationDateTime				DateTime	Required. The date and time when the master data record was created.
	primaryKey						String	Required. The primary key of the object.
facets							String	Required. Enables searches through a particular dataset.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
  "header": {
    "headerVersion": 1,
    "eventName": "masterdata-manager:query-companyMasterData-response:v1",
    "ownerId": "0510ad55-2abb-4316-bf60-e8578251c8fe",
    "isErr": false,
    "errCode": "200_OK",
    "licensePlate": "htdsgG"
  },
  "payload": {
    "pagingInfo": null,
    "documents": [
      {
        "metadata": {
          "schemaId": "masterdata-manager:companyMasterData",
          "schemaVersion": 1,
          "primaryKey": "masterdata-manager:companyMasterData#f8af495f-de32-4448-a197-2904dfb7dcd1",
          "dataVersion": 1,
          "indexTarget": "f8af495f-de32-4448-a197-2904dfb7dcd1",
          "dbTxId": 93446
        },
        "payload": {
          "schemaVersion": 1,
          "data": {
            "lscS3Identifier": "lscS3Identifier",
            "isLegalEntity": true,
            "providerNetworkNodeIdentifier": "providerNetworkNodeIdentifier",
            "legalEntityCode": "legalEntityCode",
            "companyNetworkNodeId": "companyNetworkNodeId",
            "regulatoryCompanyIdentifiers": [
              {
                "regulatoryCompanyIdentifierTypeId": "13487f42-8b26-49e6-8268-ef899de71532",
                "regulatoryCompanyIdentifierType": "SGLN",
                "isPrimaryRegulatoryIdentifier": false,
                "lscRegulatoryIdentifier": "lscRegulatoryIdentifier",
                "regulatoryIdentifierValue": "OneOne1"
              },
              {
                "regulatoryCompanyIdentifierTypeId": "13487f42-8b26-49e6-8268-ef899de71533",
                "regulatoryCompanyIdentifierType": "GLN",
                "isPrimaryRegulatoryIdentifier": false,
                "lscRegulatoryIdentifier": "lscRegulatoryIdentifier",
                "regulatoryIdentifierValue": "123456"
              }
            ],
            "businessMasterDataCommon": {
              "businessType": [
                "MANUFACTURER"
              ],
              "lscBusinessVersion": "lscBusinessVersion",
              "businessName": "Time Magazin",
              "businessEmail": "businessEmail",
              "businessPhone": "businessPhone",
              "businessUrl": "businessUrl",
              "businessTaxRegistrationCode": "businessTaxRegistrationCode",
              "businessAddress": {
                "address1": "address1",
                "address2": "address2",
                "buildingNumber": "buildingNumber",
                "plantNumber": "plantNumber",
                "floorNumber": "floorNumber",
                "houseNumber": "houseNumber",
                "city": "city",
                "village": "village",
                "township": "township",
                "district": "district",
                "state": "state",
                "postalCode": "postalCode",
                "country": "US",
                "telephone": "telephone",
                "fax": "fax",
                "url": "url",
                "lscAddressIdentifier": "lscAddressIdentifier"
              },
              "regulatoryContact": {
                "regulatoryContactTitle": "regulatoryContactTitle",
                "regulatoryContactName": "regulatoryContactName",
                "regulatoryContactEmail": "regulatoryContactEmail",
                "regulatoryContactPhone": "regulatoryContactPhone"
              },
              "businessLogo": {
                "imageIdentifier": "imageIdentifier",
                "imageMimeType": "imageMimeType",
                "imagefileName": "imagefileName",
                "imagebase64": "imagebase64"
              }
            },
            "regulatoryCompanyIdentifiersDerivedField": "SGLN OneOne1,GLN 123456",
            "regulatoryCompanyIdentifiersWithBusinessNameDerivedField": "Time Magazin SGLN OneOne1,Time Magazin GLN 123456"
          },
          "schemaId": "masterdata-manager:companyMasterData",
          "id": "f8af495f-de32-4448-a197-2904dfb7dcd1",
          "objectType": "masterdata-manager:companyMasterData",
          "lastUpdatedDateTime": 1615473059186,
          "contextualOwnerId": "00000000-0000-0000-0000-000000000000",
          "lastUpdatedByUserId": "f9f35dd0-035d-11eb-8ec8-0242ac11000c",
          "ownerId": "00000000-0000-0000-0000-000000000000",
          "dataVersion": 1,
          "createdByUserId": "f9f35dd0-035d-11eb-8ec8-0242ac11000c",
          "creationDateTime": 1615473059186
        },
        "primaryKey": "masterdata-manager:companyMasterData#f8af495f-de32-4448-a197-2904dfb7dcd1"
      }
    ],
    "facets": [
    ]
  }
}

Errors

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.

Get your Company Location Master Data

IT system administrators and app developers use this API to retrieve the full master data record for a company's location (e.g. name, address) based on the partner location's regulatory identifier information.

Get your Company Location Master Data request

Guidelines

Attribute		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:get-companyLocation-by-regulatory-identifier:v1`
	ownerId	String	Required. The identifier for the company providing the app.
	dataspace	String	Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is `default`.
	appName	String	Required. The application that owns the event. Valid value is `masterdata-manager`.
payload		–	Required. The request body.
	regulatoryCompanyIdentifier	String	The value of the regulatory identifier.
	regulatoryCompanyIdentifierType	String	The type of the regulatory identifier.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "header": {
    "headerVersion": 1,
    "eventName": "masterdata-manager:get-companyLocation-by-regulatory-identifier:v1",
    "ownerId": "0510ad55-2abb-4316-bf60-e8578251c8fe",
    "dataspace": "default",
    "appName": "masterdata-manager"
  },
  "payload": {
    "regulatoryCompanyIdentifier": "123456",
    "regulatoryCompanyIdentifierType": "GLN"
  }
}

Get your Company Location Master Data response

Guidelines

Attribute							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:get-companyLocation-by-regulatory-identifier:v1`
	ownerId						String	Required. The identifier for the company providing the app.
	isErr						String	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 name. Valid values: `BadRequestException` – The request is missing fields or has invalid data. `NotFoundException` – The request references an object that does not exist in TraceLink.
payload							–	Required. The response body.
	pagingInfo						String	Required. The query paging information representing where the previous query result ended. The pagingInfo from the previous query may be used as the starting point for a new query.
	documents						Array	Required. Contains the results of the query request.
		metadata					Object	Required. The metadata about the object.
			schemaId				String	Required. The JSON schema that defines the object.
			schemaVersion				Integer	Required. The JSON schema version number.
			primaryKey				String	Required. The primary key of the object.
			dataVersion				Integer	Required. The current version number of the object.
			indexTarget				String	Required. The index target identifier of the object.
			dbTxid				Integer	Required. The transactional identifier of the object.
		payload					–	Required. The master data objects.
			schemaVersion				Integer	Required. The JSON schema version number.
			data				Object	Required. Contains the attributes for the object. The contents depend on the object schema specified when the event handlers were added.
				dataStatus			Boolean	Required. Indicates if the master data for this location is active or inactive. Valid values: `true` – The master data for this location is active. `false` – The master data for this location is inactive.
				providerNetworkNodeIdentifier			String	Required. The network node of the originating company for the master data record.
				parentLegalEntityCode			String	Required. The legal code of the parent network node.
				isLegalEntity			Boolean	Specifies if the company is a legal entity. Valid values: `true` – The node is a legal entity. `false` – The node is not a legal entity.
				legalEntityCode			String	The legal entity code of the network node.
				companyNetworkNodeId			String	Required. The network node that the record belongs to.
				regulatoryCompanyIdentifiers			String	Required. The list of all identifiers of the company.
					regulatoryCompanyIdentifierTypeId		String	Required. The identifier type.
					isPrimaryRegulatoryIdentifier		String	Required. Specifies if the given identifier is the primary identifier.
					regulatoryIdentifierValue		String	Required. The identifier value.
				regulatoryLocationLicenses			Array	The partner location's license information.
					lscLicenseIdentifier		String	The license identifier in Track & Trace Services.
					licenseStateOrRegion		String	The state or region of the licensing agency.
					licenseIssuingAgency		String	The agency granting the regulatory license.
					licenseCountry		String	Required.The country of the licensing agency.
					licenseNumber		String	Required.The regulatory license number for the specified partner company location.
				businessMasterDataCommon			TypeDef	Required. The common business information.
					businesstype		String	The list of all business types of the company.
					lscBusinessVersion		String	Required. The business version identifier in Track & Trace Services.
					businessName		String	Required. The company's name.
					businessEmail		String	The company's email address.
					businessPhone		String	The company's phone number.
					businessUrl		String	The URL of the company's website.
					businessTaxRegistrationCode		String	The company's tax registration code.
					businessAddress		TypeDef	The company's address information.
						address1	String	The street address, including number and street name.
						address2	String	The second line of the street address. Any additional address information, if available.
						buildingNumber	Integer	The company's building number.
						plantNumber	Integer	The facility's plant number.
						floorNumber	Integer	The facility's floor number.
						houseNumber	String	The building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in address1.
						city	String	The city in which the company is located.
						village	String	The village in which the company is located in.
						township	String	The name of the town in which the company is located.
						district	String	The 3-digit numeric code of the district where the company is located in India.
						state	String	The state in which the company is located.
						postalCode	String	Conditionally required if the country has a ZIP or other postal code. If the country does have a postal code and it is omitted, an error is generated. See Valid values for exclusions. Valid values Angola, AO Antigua and Barbuda, AG Aruba, AW Bahamas, BS Belize, BZ Benin, BJ Botswana, BW Burkina Faso, BF Burundi, BI Cameroon, CM Central African Republic, CF Comoros, KM Congo, CG Congo, the Democratic Republic of the, CD Cook Islands, CK Cote d'Ivoire, CI Djibouti, DJ Dominica, DM Equatorial Guinea, GQ Eritrea, ER Fiji, FJ French Southern Territories, TF Gambia, GM Ghana, GH Grenada, GD Guinea, GN Guyana, GY Hong Kong, HK Ireland, IE Jamaica, JM Kenya, KE Kiribati, KI Macao, MO Malawi, MW Mali, ML Mauritania, MR Mauritius, MU Montserrat, MS Nauru, NR Netherlands Antilles, AN Niue, NU North Korea, KP Panama, PA Qatar, QA Rwanda, RW Saint Kitts and Nevis, KN Saint Lucia, LC Sao Tome and Principe, ST Saudi Arabia, SA Seychelles, SC Sierra Leone, SL Solomon Islands, SB Somalia, SO South Africa, ZA Suriname, SR Syria, SY Tanzania, United Republic of, TZ Timor-Leste, TL Tokelau, TK Tonga, TO Trinidad and Tobago, TT Tuvalu, TV Uganda, UG United Arab Emirates, AE Vanuatu, VU Yemen, YE Zimbabwe, ZW
						country	String	Required. The country using the standard two–letter abbreviation specified in ISO 3166–1alpha-2:1997 country code. Valid values `AD` – ANDORRA `AE` – UNITED ARAB EMIRATES `AF` – AFGHANISTAN `AG` – ANTIGUA AND BARBUDA `AI` – ANGUILLA `AL` – ALBANIA `AM` – ARMENIA `AN` – NETHERLANDS ANTILLES `AO` – ANGOLA `AQ` – ANTARCTICA `AR` – ARGENTINA `AS` – AMERICAN SAMOA `AT` – AUSTRIA `AU` – AUSTRALIA `AW` – ARUBA `AX` – ÅLAND ISLANDS `AZ` – AZERBAIJAN `BA` – BOSNIA AND HERZEGOVINA `BB` – BARBADOS `BD` – BANGLADESH `BE` – BELGIUM `BF` – BURKINA FASO `BG` – BULGARIA `BH` – BAHRAIN `BI` – BURUNDI `BJ` – BENIN `BL` – SAINT BARTHÉLEMY `BM` – BERMUDA `BN` – BRUNEI DARUSSALAM `BO` – BOLIVIA, PLURINATIONAL STATE OF `BR` – BRAZIL `BS` – BAHAMAS `BT` – BHUTAN `BV` – BOUVET ISLAND `BW` – BOTSWANA `BY` – BELARUS `BZ` – BELIZE `CA` – CANADA `CC` – COCOS (KEELING) ISLANDS `CD` – CONGO, THE DEMOCRATIC REPUBLIC OF THE `CF` – CENTRAL AFRICAN REPUBLIC `CG` – CONGO `CH` – SWITZERLAND `CI` – CÔTE D'IVOIRE `CK` – COOK ISLANDS `CL` – CHILE `CM` – CAMEROON `CN` – CHINA `CO` – COLOMBIA `CR` – COSTA RICA `CU` – CUBA `CV` – CAPE VERDE `CX` – CHRISTMAS ISLAND `CY` – CYPRUS `CZ` – CZECH REPUBLIC `DE` – GERMANY `DJ` – DJIBOUTI `DK` – DENMARK `DM` – DOMINICA `DO` – DOMINICAN REPUBLIC `DZ` – ALGERIA `EC` – ECUADOR `EE` – ESTONIA `EG` – EGYPT `EH` – WESTERN SAHARA `ER` – ERITREA `ES` – SPAIN `ET` – ETHIOPIA `FI` – FINLAND `FJ` – FIJI `FK` – FALKLAND ISLANDS (MALVINAS) `FM` – MICRONESIA, FEDERATED STATES OF `FO` – FAROE ISLANDS `FR` – FRANCE `GA` – GABON `GB` – UNITED KINGDOM `GD` – GRENADA `GE` – GEORGIA `GF` – FRENCH GUIANA `GG` – GUERNSEY `GH` – GHANA `GI` – GIBRALTAR `GL` – GREENLAND `GM` – GAMBIA `GN` – GUINEA `GP` – GUADELOUPE `GQ` – EQUATORIAL GUINEA `GR` – GREECE `GS` – SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS `GT` – GUATEMALA `GU` – GUAM `GW` – GUINEA–BISSAU `GY` – GUYANA `HK` - HONG KONG `HM` – HEARD ISLAND AND MCDONALD ISLANDS `HN` – HONDURAS `HR` – CROATIA `HT` – HAITI `HU` – HUNGARY `ID` – INDONESIA `IE` – IRELAND `IL` – ISRAEL `IM` – ISLE OF MAN `IN` – INDIA `IO` – BRITISH INDIAN OCEAN TERRITORY `IQ` – IRAQ `IR` – IRAN, ISLAMIC REPUBLIC OF `IS` – ICELAND `IT` – ITALY `JE` – JERSEY `JM` – JAMAICA `JO` – JORDAN `JP` – JAPAN `KE` – KENYA `KG` – KYRGYZSTAN `KH` – CAMBODIA `KI` – KIRIBATI `KM` – COMOROS `KN` – SAINT KITTS AND NEVIS `KP` – KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF `KR` – KOREA, REPUBLIC OF `KW` – KUWAIT `KY` – CAYMAN ISLANDS `KZ` – KAZAKHSTAN `LA` – LAO PEOPLE'S DEMOCRATIC REPUBLIC `LB` – LEBANON `LC` – SAINT LUCIA `LI` – LIECHTENSTEIN `LK` – SRI LANKA `LR` – LIBERIA `LS` – LESOTHO `LT` – LITHUANIA `LU` – LUXEMBOURG `LV` – LATVIA `LY` – LIBYAN ARAB JAMAHIRIYA `MA` – MOROCCO `MC` – MONACO `MD` – MOLDOVA, REPUBLIC OF `ME` – MONTENEGRO `MF` – SAINT MARTIN `MG` – MADAGASCAR `MH` – MARSHALL ISLANDS `MK` – MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF `ML` – MALI `MM` – MYANMAR `MN` – MONGOLIA `MO` – MACAO `MP` – NORTHERN MARIANA ISLANDS `MQ` – MARTINIQUE `MR` – MAURITANIA `MS` – MONTSERRAT `MT` – MALTA `MU` – MAURITIUS `MV` – MALDIVES `MW` – MALAWIÂ `MX` – MEXICO `MY` – MALAYSIA `MZ` – MOZAMBIQUE `NA` – NAMIBIA `NC` – NEW CALEDONIA `NE` – NIGER `NF` – NORFOLK ISLAND `NG` – NIGERIA `NI` – NICARAGUA `NL` – NETHERLANDS `NO` – NORWAY `NP` – NEPAL `NR` – NAURU `NU` – NIUE `NZ` – NEW ZEALAND `OM` – OMAN `PA` – PANAMA `PE` – PERU `PF` – FRENCH POLYNESIA `PG` – PAPUA NEW GUINEA `PH` – PHILIPPINES `PK` – PAKISTAN `PL` – POLAND `PM` – SAINT PIERRE AND MIQUELON `PN` – PITCAIRN `PR` – PUERTO RICO `PS` – PALESTINIAN TERRITORY, OCCUPIED `PT` – PORTUGAL `PW` – PALAU `PY` – PARAGUAY `QA` – QATAR `RE` – RÉUNION `RO` – ROMANIA `RS` – SERBIA `RU` – RUSSIAN FEDERATION `RW` – RWANDA `SA` – SAUDI ARABIA `SB` – SOLOMON ISLANDS `SC` – SEYCHELLES `SD` – SUDAN `SE` – SWEDEN `SG` – SINGAPORE `SH` – SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA `SI` – SLOVENIA `SJ` – SVALBARD AND JAN MAYEN `SK` – SLOVAKIA `SL` – SIERRA LEONE `SM` – SAN MARINO `SN` – SENEGAL `SO` – SOMALIA `SR` – SURINAME `ST` – SAO TOME AND PRINCIPE `SV` – EL SALVADOR `SY` – SYRIAN ARAB REPUBLIC `SZ` – SWAZILAND `TC` – TURKS AND CAICOS ISLANDS `TD` – CHAD `TF` – FRENCH SOUTHERN TERRITORIES `TG` – TOGO `TH` – THAILAND `TJ` – TAJIKISTAN `TK` – TOKELAU `TL` – TIMOR–LESTE `TM` – TURKMENISTAN `TN` – TUNISIA `TO` – TONGA `TR` – TURKEY `TT` – TRINIDAD AND TOBAGO `TV` – TUVALU `TW` – TAIWAN `TZ` – TANZANIA, UNITED REPUBLIC OF `UA` – UKRAINE `UG` – UGANDA `UM` – UNITED STATES MINOR OUTLYING ISLANDS `US` – UNITED STATES `UY` – URUGUAY `UZ` – UZBEKISTAN `VA` – HOLY SEE (VATICAN CITY STATE) `VC` – SAINT VINCENT AND THE GRENADINES `VE` – VENEZUELA, BOLIVARIAN REPUBLIC OF `VG` – VIRGIN ISLANDS, BRITISH `VI` – VIRGIN ISLANDS, U.S. `VN` – VIET NAM `VU` – VANUATU `WF` – WALLIS AND FUTUNA `WS` – SAMOA `XK` – KOSOVO `YE` – YEMEN `YT` – MAYOTTE `ZA` – SOUTH AFRICA `ZM` – ZAMBIA `ZW` – ZIMBABWE
						telephone	Integer	The office's telephone number.
						fax	Integer	The office's fax number.
						premisesCode	String	The identifier representing a physical area within the company location (e.g. a location's second floor).
						lscAddressidentifier	String	The global identifier assigned by Russian Federation Information Address System (FIAS). Maximum 36 characters, using the digits 0-9 and letters A-F.
					regulatoryContact		Object	The contact information for the regulatory contact at the company.
						regulatoryContactTitle	String	The regulatory contact's business title.
						regulatoryContactName	String	The regulatory contact's name.
						regulatoryContactEmail	String	The regulatory contact's email address.
						regulatoryContactPhone	Integer	The regulatory contact's phone number.
					businessLogo		Object	Information for the business logo.
						imageIdentifier	String	The business logo's image identifier.
						imageMimeType	String	The business logo's image mime type.
						imagefileName	String	The business logo's file name.
						imagebase64	String	A readable string of the image.
				regulatoryLocationIdentifiersDerivedField			String	The result of the query when ftsInfo \| value equals `index-regulatoryLocationIdentifiersDerivedField:searchString` in the request.
				regulatoryLocationIdentifiersWithBusinessNameDerivedField			String	The result of the query when ftsInfo \| value equals `*index-regulatoryLocationIdentifiersWithBusinessNameDerivedField:[searchString]` in the request.
				index-regulatoryLocationLicensesWithBusinessNameDerivedField			String	The result of the query when ftsInfo \| value equals `index-regulatoryPartnerIdentifiersWithBusinessNameDerivedField:[searchString]` in the request.
			schemaId				String	Required. The JSON schema that defines the object.
			id				String	Required. The identifier of the master data object.
			objectType				String	Required. The type of the object. Valid value is `masterdata-manager:productMasterData`.
			lastUpdatedDateTime				String	The identifier of the user that made the last update to the master data record.
			contextualOwnerId				String	Required. The identifier of the company sending the master data request.
			lastUpdatedByUserId				DateTime	The identifier of the user that made the last update to the master data record.
			ownerId				String	Required. The identifier of the company that owns the master data record.
			dataVersion				Integer	Required. The current version number of the object.
			createdByUserId				String	Required. The ID of the user that created the master data record.
			creationDateTime				DateTime	Required. The date and time when the master data record was created.
	primaryKey						String	Required. The primary key of the object.
facets							String	Required. Enables searches through a particular dataset.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
{
  "header": {
    "headerVersion": 1,
    "eventName": "masterdata-manager:get-companyLocation-by-regulatory-identifier-response:v1",
    "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
    "isErr": false,
    "errCode": "200_OK",
    "licensePlate": "fjjnne"
  },
  "payload": {
    "pagingInfo": null,
    "documents": [
      {
        "metadata": {
          "schemaId": "masterdata-manager:companyLocationMasterData",
          "schemaVersion": 1,
          "primaryKey": "masterdata-manager:companyLocationMasterData#0d1d7aa7-32c5-47f0-84b8-fdfa9219e67b",
          "dataVersion": 1,
          "indexTarget": "0d1d7aa7-32c5-47f0-84b8-fdfa9219e67b",
          "dbTxId": 53948
        },
        "payload": {
          "schemaVersion": 1,
          "data": {
            "lscS3Identifier": "lscS3Identifier",
            "isLegalEntity": true,
            "providerNetworkNodeIdentifier": "providerNetworkNodeIdentifier",
            "legalEntityCode": "legalEntityCode",
            "parentLegalEntityCode": "parentLegalEntityCode",
            "companyNetworkNodeId": "companyNetworkNodeId",
            "regulatoryCompanyIdentifiers": [
              {
                "regulatoryCompanyIdentifierTypeId": "SGLN",
                "isPrimaryRegulatoryIdentifier": false,
                "regulatoryIdentifierValue": "OneOne1"
              },
              {
                "regulatoryCompanyIdentifierTypeId": "GLN",
                "isPrimaryRegulatoryIdentifier": false,
                "regulatoryIdentifierValue": "123456"
              }
            ],
            "businessMasterDataCommon": {
              "businessType": [
                "MANUFACTURER"
              ],
              "lscBusinessVersion": "lscBusinessVersion",
              "businessName": "Time Magazine",
              "businessEmail": "businessEmail",
              "businessPhone": "businessPhone",
              "businessUrl": "businessUrl",
              "businessTaxRegistrationCode": "businessTaxRegistrationCode",
              "businessAddress": {
                "address1": "address1",
                "address2": "address2",
                "city": "city",
                "state": "state",
                "postalCode": "postalCode",
                "country": "US",
                "telephone": "telephone",
                "fax": "fax",
                "url": "url",
                "district": "district",
                "buildingNumber": "buildingNumber",
                "plantNumber": "plantNumber",
                "floorNumber": "floorNumber",
                "lscAddressIdentifier": "lscAddressIdentifier"
              },
              "regulatoryContact": {
                "regulatoryContactTitle": "regulatoryContactTitle",
                "regulatoryContactName": "regulatoryContactName",
                "regulatoryContactEmail": "regulatoryContactEmail",
                "regulatoryContactPhone": "regulatoryContactPhone"
              },
              "businessLogo": {
                "imageIdentifier": "imageIdentifier",
                "imageMimeType": "imageMimeType",
                "imagefileName": "imagefileName",
                "imagebase64": "imagebase64"
              }
            },
            "regulatoryLocationIdentifiersDerivedField": "SGLN OneOne1,GLN 123456",
            "regulatoryLocationIdentifiersWithBusinessNameDerivedField": "Time Magazin SGLN OneOne1,Time Magazin GLN 123456"
          },
          "schemaId": "masterdata-manager:companyLocationMasterData",
          "id": "0d1d7aa7-32c5-47f0-84b8-fdfa9219e67b",
          "objectType": "masterdata-manager:companyLocationMasterData",
          "lastUpdatedDateTime": 1614028698435,
          "contextualOwnerId": "00000000-0000-0000-0000-000000000000",
          "lastUpdatedByUserId": "f9f35dd0-035d-11eb-8ec8-0242ac11000c",
          "ownerId": "00000000-0000-0000-0000-000000000000",
          "dataVersion": 1,
          "createdByUserId": "f9f35dd0-035d-11eb-8ec8-0242ac11000c",
          "creationDateTime": 1614028698435
        },
        "primaryKey": "masterdata-manager:companyLocationMasterData#0d1d7aa7-32c5-47f0-84b8-fdfa9219e67b"
      }
    ],
    "facets": [
    ]
  }
}

Add or Edit your Company Location Master Data

IT system administrators use this API to add or edit the full master data record for a company's location (e.g. name, address). IT system administrators should retrieve the existing company location master data record, edit the values that need to change, and then submit the entire record. These APIs overwrite the full set of data previously added to the associated record.

Add or Edit your Company Location Master Data request

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-companyLocation:v4`.
	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.
data				Object	Required. Contains the attributes for the object. The contents depend on the object schema specified when the event handlers were added.
	dataStatus			String	Indicates if the company location data is active within TraceLink. Valid values: `DRAFT` – The data is in a draft state but not submitted. `ACTIVE` – The data can be used in messages and UI functions, and TraceLink pulls the data when necessary. `INACTIVE` – The data cannot be pulled for other functions within TraceLink.
	regulatoryLocationIdentifiers			Array	Required. The identifiers for a company's location.
		regulatoryIdentifierValue		String	Required. The identifier value.
		isPrimaryRegulatoryIdentifier		Boolean	Required. Indicates whether the given company's location identifier is the primary identifier. One only identifier can be set as the primary identifier. Not all identifiers can be set as the primary. TraceLink uses the primary company identifier to identify the correct partner when the user updates the Master Data with an asynchronous message. Valid values: `true` – The identifier is the primary identifier. `false` – (default) The identifier is not the primary identifier.
		regulatoryLocationIdentifierType		String	Required. The type of the regulatory company's location identifier. Valid values `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.
	regulatoryLocationLicenses			Array	The regulator license for a company's location.
		licenseStateOrRegion		String	The state or region of the licensing agency.
		licenseIssuingAgency		String	The agency that grants the regulatory license.
		licenseCountry		String	Required. The country of the licensing agency.
		licenseNumber		String	Required. The regulator license number for the location.
	businessMasterDataCommon			Object	Required. The company location's headquarters information.
		businessType		Array (String)	Required. The different types of business the company conducts. Valid values: `CARRYING_AND_FORWARDING_AGENT` – The company facilitates the movement and transfer of goods. In India, CFAs are often involved in moving goods as interstate stock transfers. `CHEMIST` – The company specializes in the composition of substances, may mix substances in preparation for dispensation, and has a shop selling medicines and cosmetics. Also known as a compounding facility. `DISTRIBUTOR` – The company distributes pharmaceuticals. `EXPORTER` – The company exports products. For customs purposes, this company makes the export declaration and sells the products to a company in another country, known as the importer. `HEALTHCARE_FACILITY` – The company dispenses pharmaceuticals as a healthcare facility. `IMPORTER` – The company imports products. For customs purposes, this company makes the import declaration, the shipping document names the company as consignee, and the exporter's invoice names the company as buyer. `LOGISTICS` – The company provides logistics services (e.g. LSP, 3PL). `MANUFACTURER` – The license holder of the pharmaceutical product (e.g. Brand Owners, Generics, MAHs, Specialty Companies). `PACKAGER` – The company packages products. `PHARMACY` – The company sells product directly to patients. `RETURNS_PROCESSOR` – The company processes returns. `STOCKIST` – The company stocks the products and then distributes them. `WHOLESALER` – The company is a wholesaler of pharmaceuticals.
		businessName		String	Required. The company location name.
		businessEmail		String	The company location's email address.
		businessPhone		String	The telephone number of the company location's corporate office.
		businessURL		String	The URL of the company location's website.
		businessTaxRegistrationCode		String	The company location's tax registration code. The code used to identify this entity for tax or other legal reporting purposes.
		businessAddress		Object	The company location address information.
			address1	String	Required. The street address, including number and street name.
			address2	String	The second line of the street address. Any additional address information, if available.
			buildingNumber	String	The company's building number.
			plantNumber	String	The company location's plant number.
			floorNumber	String	The company location's floor number.
			houseNumber	String	The unique number on the street for this company.
			city	String	Required. The city that the company location is located in.
			village	String	The village in which the company location is located in.
			township	String	The name of the town in which the company is located.
			district	String	The 3-digit numeric code of the district where the company is located in India.
			stateOrRegion	String	Required. The state, province, or region using the standard two– or three–letter abbreviation specified in the ISO 3166–2:1998 country subdivision code.
			postalCode	String	Conditionally required if the country has a ZIP or other postal code. If the country does have a postal code and it is omitted, an error is generated. See Valid values for exclusions. Valid values Angola, AO Antigua and Barbuda, AG Aruba, AW Bahamas, BS Belize, BZ Benin, BJ Botswana, BW Burkina Faso, BF Burundi, BI Cameroon, CM Central African Republic, CF Comoros, KM Congo, CG Congo, the Democratic Republic of the, CD Cook Islands, CK Cote d'Ivoire, CI Djibouti, DJ Dominica, DM Equatorial Guinea, GQ Eritrea, ER Fiji, FJ French Southern Territories, TF Gambia, GM Ghana, GH Grenada, GD Guinea, GN Guyana, GY Hong Kong, HK Ireland, IE Jamaica, JM Kenya, KE Kiribati, KI Macao, MO Malawi, MW Mali, ML Mauritania, MR Mauritius, MU Montserrat, MS Nauru, NR Netherlands Antilles, AN Niue, NU North Korea, KP Panama, PA Qatar, QA Rwanda, RW Saint Kitts and Nevis, KN Saint Lucia, LC Sao Tome and Principe, ST Saudi Arabia, SA Seychelles, SC Sierra Leone, SL Solomon Islands, SB Somalia, SO South Africa, ZA Suriname, SR Syria, SY Tanzania, United Republic of, TZ Timor-Leste, TL Tokelau, TK Tonga, TO Trinidad and Tobago, TT Tuvalu, TV Uganda, UG United Arab Emirates, AE Vanuatu, VU Yemen, YE Zimbabwe, ZW
			country	String	Required. The country using the standard two–letter abbreviation specified in ISO 3166–1alpha-2:1997 country code.
			telephone	String	The phone number of the contact person or department at the location.
			fax	String	The company's fax number.
			url	String	The URL of the company's website.
			premisesCode	String	The internal identifier associated with this location (e.g. a location with 4 locations in the city of Mumbai internally refers to the 4th location as MUM4).
		regulatoryContact		Array	The contact information for the regulatory contact at the company's location. Each field can only appear once per company location.
			regulatoryContactName	String	The regulatory contact's name in base64 format.
			regulatoryContactTitle	String	The regulatory contact's business title.
			regulatoryContactEmail	String	The regulatory contact's email address.
			regulatoryContactPhone	String	The regulatory contact's phone number.
		businessLogo		Object	The image file displaying the company location logo.
			imagebase64	String	The readable string of the company locations's image in base64 format.
			imageMimeType	String	Required. The file type of the image. Valid values: `BMP` – Bitmap image file. `GIF` – Graphics Interchange Format. `JPG` – Image format developed by Joint Photographic Experts group. `PNG` – Portable Network Graphics.
			imagefileName	String	The file name of the image. If the file name is not provided, value defaults to `companyImage.[file type]`.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
{
    "header": {
        "headerVersion": 1,
        "eventName": "masterdata-manager:add-companyLocation:v4",
        "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "dataspace": "default",
        "appName": "masterdata-manager"
    },
    "payload": {
        "data": {
            "dataStatus": "ACTIVE",
            "companyIdentifier": "companyIdentifier",
            "companyNetworkNodeId": "companyNetworkNodeId",
            "locationNetworkNodeId": "locationNetworkNodeId",
            "regulatoryLocationIdentifiers": [
            {
                "regulatoryIdentifierValue": "8888882021124",
                "lscRegulatoryIdentifier": "lscRegulatoryIdentifier",
                "isPrimaryRegulatoryIdentifier": true,
                "regulatoryLocationIdentifierType": "GLN"
            }
            ],
            "regulatoryLocationLicenses": [
            {
                "lscLicenseIdentifier": "lscLicenseIdentifier",
                "licenseStateOrRegion": "MA",
                "licenseIssuingAgency": "licenseIssuingAgency",
                "licenseCountry": "US",
                "licenseNumber": "100001"
            }
            ],
            "businessMasterDataCommon": {
                "businessType": ["MANUFACTURER"],
                "lscBusinessVersion": "lscBusinessVersion",
                "businessName": "businessName",
                "businessEmail": "m@m.com",
                "businessPhone": "businessPhone",
                "businessUrl": "businessUrl",
                "businessTaxRegistrationCode": "businessTaxRegistrationCode",
                "businessAddress": {
                    "address1": "address1",
                    "address2": "address2",
                    "buildingNumber": "buildingNumber",
                    "plantNumber": "plantNumber",
                    "floorNumber": "floorNumber",
                    "houseNumber": "houseNumber",
                    "city": "city",
                    "village": "village",
                    "township": "township",
                    "district": "district",
                    "state": "state",
                    "postalCode": "postalCode",
                    "country": "US",
                    "telephone": "telephone",
                    "fax": "fax",
                    "url": "url",
                    "lscAddressIdentifier": "lscAddressIdentifier""
                },
                "regulatoryContact": {
                    "regulatoryContactTitle": "regulatoryContactTitle",
                    "regulatoryContactName": "regulatoryContactName",
                    "regulatoryContactEmail": "m@m.com",
                    "regulatoryContactPhone": "regulatoryContactPhone"
                },
                "businessLogo": {
                    "imageIdentifier": "imageIdentifier",
                    "imageMimeType": "image/png",
                    "imagefileName": "imagefileName",
                    "imagebase64": "imagebase64"
                }
            }
        }
    }
}

Add or Edit your Company Location Master Data response

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-companyLocation-response:v4`.
	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	Conditionally required if the call is successful. The identifier for the new or edited company location.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "header": {
        "headerVersion": 1,
        "eventName": "masterdata-manager:add-companyLocation-response:v4",
        "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
        "isErr": false,
        "errCode": "200_OK",
        "licensePlate": "8zsf2G-lbcUxW"
    },
    "payload": {
        "id": "4f1cc1cd-fcfe-11ec-980a-1d5ac0247b8d"
    }
}

Errors

Element	Error Message	Description
dataStatus isPrimaryRegulatoryIdentifier regulatoryLocationIdentifierType businessType imageMimeType	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.
regulatoryLocationIdentifiers	Identifiers must be unique. Identifier [<type>] <value> already exists in company or Partner master data.	The error occurs if the regulatoryLocationIdentifiers specifies a primary ID that is in use but is not the primary company Id.
regulatoryLocationIdentifiers	Identifier Type <type> has two values. Only one identifier value for each type can be added for this location, except for COMPANYSITEID.	The error occurs if the regulatoryLocationIdentifiers specifies a primary ID that does not belong to the company.
isPrimaryRegulatoryIdentifier	No identifiers are currently set as the primary. One identifier must be set as the primary identifier.	The error occurs if no identifiers are set at the primary identifier.
isPrimaryRegulatoryIdentifier	Multiple identifiers are currently set as the primary. Only one identifier can be set as the primary identifier.	The error occurs if isPrimaryRegulatoryIdentifier is set to have multiple identifiers as the primary identifier.
regulatoryPartnerLicenses	License is already assigned to another Partner company or location.	The error occurs if regulatoryPartnerLicenses is set to assign a license to more than one Partner company or location.
removeIdentifier	Identifier [<type>] <value> is set as the primary identifier. Set another identifier as the primary to remove it.	The error occurs if removeIdentifier is set to remove the primary identifier before setting another identifier as the primary.
businessEmail	An email address is not in the valid format.	The error occurs if an invalid email address is entered.
regulatoryContactEmail	An email address is not in the valid format.	The error occurs if an invalid email address is entered.
businessAddress	The business address is missing a required field: <field name>.	The error occurs if mandatory fields are missing in the businessAddress.
postalCode	Postal code is required for <country>.	The error occurs if the postal code is missing for a country that requires the postal code.

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.

Query your Company Location Master Data

IT system administrators and app developers use this API to query a company's location information (e.g. contact information, identifiers).

Query your Company Location Master Data request

Guidelines

Attribute					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:query-companyLocationMasterData: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.
	predicates				Array	Required. The contents of the query.
		type			String	Required. The type of the predicate. Valid value is `PREDICATE`.
		logicalOperator			String	Required. The logical operator of the predicate. Valid values: `AND` `OR` `TRUE`
		clauses			Array	Required. The attributes and values to include in the response message.
			type		String	Required. The type of the clause. Valid value is `TERM`.
			comparisonOperator		String	Required. The operator of the term. Valid values: `CLOSED` - Search for values within a range, including the endpoints of the range `CLOSED_OPEN` - Search for values within a range, where the range includes the lower endpoint and does not include the upper endpoint `DB_FTS` - Perform a full-text search using the query term. Does not support wildcards. `EQ` - Equal to `GE` - Greater than or equal to `GT` - Greater than `IN` - Search for values that are included in the given list `LE` - Less than or equal to `LT` - Less than `LUCENE_FTS` - Perform a Lucene search using the contents of ftsInfo. Lucene wildcards are supported. `NE` - Not equal `OPEN` - Search for values within a range, not including the endpoints of the range `OPEN_CLOSED` - Search for values within a range, where the range does not include the lower endpoint and does include the upper endpoint `WILDCARD` - Perform a search that matches the wildcard query. Supported wildcards are `*` and `.`.
			schemaId		String	Required. The schema identifier of the network objects being queried.
			ftsInfo		Object	Required. The Lucene query info.
				value	String	Required. Determines the content the query searches for. Replace "[searchString]" with the search value. Valid values: `index-regulatoryLocationIdentifiersDerivedField:[searchString]` Simultaneously searches for the [searchString] in the following fields: Identifier Type Identifier Value `index-regulatoryLocationIdentifiersWithBusinessNameDerivedField:[searchString]` Simultaneously searches for the [searchString] in the following fields: Location Name Identifier Type Identifier Value `index-businessMasterDataCommon.businessName:[searchString]` `index-companyIdentifier INDEX ON /data/companyIdentifier/*` `(index-regulatoryLocationLicenseWithBusinessNameDerivedField`
				pageIndex	Integer	Required. The index of the first page of results to display, starting at `0`.
				sortField	Object	Required. The method of sorting the values in the relevant indexes. Valid values: `ASCENDING` `DESCENDING`
	maximumResults				Integer	Required. The maximum number of results returned in the response.
	pagingInfo				String	Required. The query paging information representing where the previous query result ended. The pagingInfo from the previous query may be used as the starting point for the current query.
	keyFormat				String	Required. The format of the response to a key-only query. Valid values: `OBJECT_ID` – The object identifier of the document is returned in the response. `PRIMARY_KEY` – The primary key of the object in schemaId#objectId format is returned in the response.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "header": {
    "headerVersion": 1,
    "eventName": "masterdata-manager:query-companyLocationMasterData:v1",
    "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
    "dataspace": "default",
    "appName": "masterdata-manager"
  },
  "payload": {
    "predicates": [
      {
        "type": "PREDICATE",
        "logicalOperator": "TRUE",
        "clauses": [{
          "type": "TERM",
          "comparisonOperator": "LUCENE_FTS",
          "schemaId": "masterdata-manager:companyLocationMasterData",
          "ftsInfo": {
            "value": "index-regulatoryLocationIdentifiersWithBusinessNameDerivedField:*123*",
            "pageIndex": 0,
            "sortField": {
            }
          }
        }]
      }    
    ],
    "maximumResults": 10000,
    "pagingInfo": "",
    "keyFormat": "PRIMARY_KEY"
  }
}

Query your Company Location Master Data response

Guidelines

Attribute							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:query-companyLocationMasterData:v1`.
	ownerId						String	Required. The identifier for the company providing the app.
	isErr						String	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 name. Valid values: `BadRequestException` – The request is missing fields or has invalid data. `NotFoundException` – The request references an object that does not exist in TraceLink.
payload							–	Required. The response body.
	pagingInfo						String	Required. The query paging information representing where the previous query result ended. The pagingInfo from the previous query may be used as the starting point for a new query.
	documents						Array	Required. Contains the results of the query request.
		metadata					Object	Required. The metadata about the object.
			schemaId				String	Required. The JSON schema that defines the object.
			schemaVersion				Integer	Required. The JSON schema version number.
			primaryKey				String	Required. The primary key of the object.
			dataVersion				Integer	Required. The current version number of the object.
			indexTarget				String	Required. The index target identifier of the object.
			dbTxid				Integer	Required. The transactional identifier of the object.
		payload					–	Required. The master data objects.
			schemaVersion				Integer	Required. The JSON schema version number.
			data				Object	Required. Contains the attributes for the object. The contents depend on the object schema specified when the event handlers were added.
				dataStatus			Boolean	Required. Indicates if the master data for this location is active or inactive. Valid values: `true` – The master data for this location is active. `false` – The master data for this location is inactive.
				providerNetworkNodeIdentifier			String	Required. The network node of the originating company for the master data record.
				parentLegalEntityCode			String	Required. The legal code of the parent network node.
				isLegalEntity			Boolean	Specifies if the company is a legal entity. Valid values: `true` – The node is a legal entity. `false` – The node is not a legal entity.
				legalEntityCode			String	The legal entity code of the network node.
				companyNetworkNodeId			String	Required. The network node that the record belongs to.
				regulatoryCompanyIdentifiers			String	Required. The list of all identifiers of the company.
					regulatoryCompanyIdentifierTypeId		String	Required. The identifier type.
					isPrimaryRegulatoryIdentifier		String	Required. Specifies if the given identifier is the primary identifier.
					regulatoryIdentifierValue		String	Required. The identifier value.
				regulatoryLocationLicenses			Array	The partner location's license information.
					lscLicenseIdentifier		String	The license identifier in Track & Trace Services.
					licenseStateOrRegion		String	The state or region of the licensing agency.
					licenseIssuingAgency		String	The agency granting the regulatory license.
					licenseCountry		String	Required. The country of the licensing agency.
					licenseNumber		String	Required. The regulatory license number for the specified partner company location.
				businessMasterDataCommon			TypeDef	Required. The common business information.
					businesstype		String	The list of all business types of the company.
					lscBusinessVersion		String	Required. The business version identifier in Track & Trace Services.
					businessName		String	Required. The company's name.
					businessEmail		String	The company's email address.
					businessPhone		String	The company's phone number.
					businessUrl		String	The URL of the company's website.
					businessTaxRegistrationCode		String	The company's tax registration code.
					businessAddress		TypeDef	The company's address information.
						address1	String	The street address, including number and street name.
						address2	String	The second line of the street address. Any additional address information, if available.
						buildingNumber	Integer	The company's building number.
						plantNumber	Integer	The facility's plant number.
						floorNumber	Integer	The facility's floor number.
						houseNumber	String	The building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in address1.
						city	String	The city in which the company is located.
						village	String	The village in which the company location is located in.
						township	String	The name of the town in which the company is located.
						district	String	The 3-digit numeric code of the district where the company is located in India.
						state	String	The state in which the company is located.
						postalCode	String	Conditionally required if the country has a ZIP or other postal code. If the country does have a postal code and it is omitted, an error is generated. See Valid values for exclusions. Valid values Angola, AO Antigua and Barbuda, AG Aruba, AW Bahamas, BS Belize, BZ Benin, BJ Botswana, BW Burkina Faso, BF Burundi, BI Cameroon, CM Central African Republic, CF Comoros, KM Congo, CG Congo, the Democratic Republic of the, CD Cook Islands, CK Cote d'Ivoire, CI Djibouti, DJ Dominica, DM Equatorial Guinea, GQ Eritrea, ER Fiji, FJ French Southern Territories, TF Gambia, GM Ghana, GH Grenada, GD Guinea, GN Guyana, GY Hong Kong, HK Ireland, IE Jamaica, JM Kenya, KE Kiribati, KI Macao, MO Malawi, MW Mali, ML Mauritania, MR Mauritius, MU Montserrat, MS Nauru, NR Netherlands Antilles, AN Niue, NU North Korea, KP Panama, PA Qatar, QA Rwanda, RW Saint Kitts and Nevis, KN Saint Lucia, LC Sao Tome and Principe, ST Saudi Arabia, SA Seychelles, SC Sierra Leone, SL Solomon Islands, SB Somalia, SO South Africa, ZA Suriname, SR Syria, SY Tanzania, United Republic of, TZ Timor-Leste, TL Tokelau, TK Tonga, TO Trinidad and Tobago, TT Tuvalu, TV Uganda, UG United Arab Emirates, AE Vanuatu, VU Yemen, YE Zimbabwe, ZW
						country	String	Required. The country using the standard two–letter abbreviation specified in ISO 3166–1alpha-2:1997 country code. Valid values `AD` – ANDORRA `AE` – UNITED ARAB EMIRATES `AF` – AFGHANISTAN `AG` – ANTIGUA AND BARBUDA `AI` – ANGUILLA `AL` – ALBANIA `AM` – ARMENIA `AN` – NETHERLANDS ANTILLES `AO` – ANGOLA `AQ` – ANTARCTICA `AR` – ARGENTINA `AS` – AMERICAN SAMOA `AT` – AUSTRIA `AU` – AUSTRALIA `AW` – ARUBA `AX` – ÅLAND ISLANDS `AZ` – AZERBAIJAN `BA` – BOSNIA AND HERZEGOVINA `BB` – BARBADOS `BD` – BANGLADESH `BE` – BELGIUM `BF` – BURKINA FASO `BG` – BULGARIA `BH` – BAHRAIN `BI` – BURUNDI `BJ` – BENIN `BL` – SAINT BARTHÉLEMY `BM` – BERMUDA `BN` – BRUNEI DARUSSALAM `BO` – BOLIVIA, PLURINATIONAL STATE OF `BR` – BRAZIL `BS` – BAHAMAS `BT` – BHUTAN `BV` – BOUVET ISLAND `BW` – BOTSWANA `BY` – BELARUS `BZ` – BELIZE `CA` – CANADA `CC` – COCOS (KEELING) ISLANDS `CD` – CONGO, THE DEMOCRATIC REPUBLIC OF THE `CF` – CENTRAL AFRICAN REPUBLIC `CG` – CONGO `CH` – SWITZERLAND `CI` – CÔTE D'IVOIRE `CK` – COOK ISLANDS `CL` – CHILE `CM` – CAMEROON `CN` – CHINA `CO` – COLOMBIA `CR` – COSTA RICA `CU` – CUBA `CV` – CAPE VERDE `CX` – CHRISTMAS ISLAND `CY` – CYPRUS `CZ` – CZECH REPUBLIC `DE` – GERMANY `DJ` – DJIBOUTI `DK` – DENMARK `DM` – DOMINICA `DO` – DOMINICAN REPUBLIC `DZ` – ALGERIA `EC` – ECUADOR `EE` – ESTONIA `EG` – EGYPT `EH` – WESTERN SAHARA `ER` – ERITREA `ES` – SPAIN `ET` – ETHIOPIA `FI` – FINLAND `FJ` – FIJI `FK` – FALKLAND ISLANDS (MALVINAS) `FM` – MICRONESIA, FEDERATED STATES OF `FO` – FAROE ISLANDS `FR` – FRANCE `GA` – GABON `GB` – UNITED KINGDOM `GD` – GRENADA `GE` – GEORGIA `GF` – FRENCH GUIANA `GG` – GUERNSEY `GH` – GHANA `GI` – GIBRALTAR `GL` – GREENLAND `GM` – GAMBIA `GN` – GUINEA `GP` – GUADELOUPE `GQ` – EQUATORIAL GUINEA `GR` – GREECE `GS` – SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS `GT` – GUATEMALA `GU` – GUAM `GW` – GUINEA–BISSAU `GY` – GUYANA `HK` - HONG KONG `HM` – HEARD ISLAND AND MCDONALD ISLANDS `HN` – HONDURAS `HR` – CROATIA `HT` – HAITI `HU` – HUNGARY `ID` – INDONESIA `IE` – IRELAND `IL` – ISRAEL `IM` – ISLE OF MAN `IN` – INDIA `IO` – BRITISH INDIAN OCEAN TERRITORY `IQ` – IRAQ `IR` – IRAN, ISLAMIC REPUBLIC OF `IS` – ICELAND `IT` – ITALY `JE` – JERSEY `JM` – JAMAICA `JO` – JORDAN `JP` – JAPAN `KE` – KENYA `KG` – KYRGYZSTAN `KH` – CAMBODIA `KI` – KIRIBATI `KM` – COMOROS `KN` – SAINT KITTS AND NEVIS `KP` – KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF `KR` – KOREA, REPUBLIC OF `KW` – KUWAIT `KY` – CAYMAN ISLANDS `KZ` – KAZAKHSTAN `LA` – LAO PEOPLE'S DEMOCRATIC REPUBLIC `LB` – LEBANON `LC` – SAINT LUCIA `LI` – LIECHTENSTEIN `LK` – SRI LANKA `LR` – LIBERIA `LS` – LESOTHO `LT` – LITHUANIA `LU` – LUXEMBOURG `LV` – LATVIA `LY` – LIBYAN ARAB JAMAHIRIYA `MA` – MOROCCO `MC` – MONACO `MD` – MOLDOVA, REPUBLIC OF `ME` – MONTENEGRO `MF` – SAINT MARTIN `MG` – MADAGASCAR `MH` – MARSHALL ISLANDS `MK` – MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF `ML` – MALI `MM` – MYANMAR `MN` – MONGOLIA `MO` – MACAO `MP` – NORTHERN MARIANA ISLANDS `MQ` – MARTINIQUE `MR` – MAURITANIA `MS` – MONTSERRAT `MT` – MALTA `MU` – MAURITIUS `MV` – MALDIVES `MW` – MALAWIÂ `MX` – MEXICO `MY` – MALAYSIA `MZ` – MOZAMBIQUE `NA` – NAMIBIA `NC` – NEW CALEDONIA `NE` – NIGER `NF` – NORFOLK ISLAND `NG` – NIGERIA `NI` – NICARAGUA `NL` – NETHERLANDS `NO` – NORWAY `NP` – NEPAL `NR` – NAURU `NU` – NIUE `NZ` – NEW ZEALAND `OM` – OMAN `PA` – PANAMA `PE` – PERU `PF` – FRENCH POLYNESIA `PG` – PAPUA NEW GUINEA `PH` – PHILIPPINES `PK` – PAKISTAN `PL` – POLAND `PM` – SAINT PIERRE AND MIQUELON `PN` – PITCAIRN `PR` – PUERTO RICO `PS` – PALESTINIAN TERRITORY, OCCUPIED `PT` – PORTUGAL `PW` – PALAU `PY` – PARAGUAY `QA` – QATAR `RE` – RÉUNION `RO` – ROMANIA `RS` – SERBIA `RU` – RUSSIAN FEDERATION `RW` – RWANDA `SA` – SAUDI ARABIA `SB` – SOLOMON ISLANDS `SC` – SEYCHELLES `SD` – SUDAN `SE` – SWEDEN `SG` – SINGAPORE `SH` – SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA `SI` – SLOVENIA `SJ` – SVALBARD AND JAN MAYEN `SK` – SLOVAKIA `SL` – SIERRA LEONE `SM` – SAN MARINO `SN` – SENEGAL `SO` – SOMALIA `SR` – SURINAME `ST` – SAO TOME AND PRINCIPE `SV` – EL SALVADOR `SY` – SYRIAN ARAB REPUBLIC `SZ` – SWAZILAND `TC` – TURKS AND CAICOS ISLANDS `TD` – CHAD `TF` – FRENCH SOUTHERN TERRITORIES `TG` – TOGO `TH` – THAILAND `TJ` – TAJIKISTAN `TK` – TOKELAU `TL` – TIMOR–LESTE `TM` – TURKMENISTAN `TN` – TUNISIA `TO` – TONGA `TR` – TURKEY `TT` – TRINIDAD AND TOBAGO `TV` – TUVALU `TW` – TAIWAN `TZ` – TANZANIA, UNITED REPUBLIC OF `UA` – UKRAINE `UG` – UGANDA `UM` – UNITED STATES MINOR OUTLYING ISLANDS `US` – UNITED STATES `UY` – URUGUAY `UZ` – UZBEKISTAN `VA` – HOLY SEE (VATICAN CITY STATE) `VC` – SAINT VINCENT AND THE GRENADINES `VE` – VENEZUELA, BOLIVARIAN REPUBLIC OF `VG` – VIRGIN ISLANDS, BRITISH `VI` – VIRGIN ISLANDS, U.S. `VN` – VIET NAM `VU` – VANUATU `WF` – WALLIS AND FUTUNA `WS` – SAMOA `XK` – KOSOVO `YE` – YEMEN `YT` – MAYOTTE `ZA` – SOUTH AFRICA `ZM` – ZAMBIA `ZW` – ZIMBABWE
						telephone	Integer	The office's telephone number.
						fax	Integer	The office's fax number.
						premisesCode	String	The identifier representing a physical area within the company location (e.g. a location's second floor).
						lscAddressidentifier	String	The global identifier assigned by Russian Federation Information Address System (FIAS). Maximum 36 characters, using the digits 0-9 and letters A-F.
					regulatoryContact		Object	The contact information for the regulatory contact at the company.
						regulatoryContactTitle	String	The regulatory contact's business title.
						regulatoryContactName	String	The regulatory contact's name.
						regulatoryContactEmail	String	The regulatory contact's email address.
						regulatoryContactPhone	Integer	The regulatory contact's phone number.
					businessLogo		Object	Information for the business logo.
						imageIdentifier	String	The business logo's image identifier.
						imageMimeType	String	The business logo's image mime type.
						imagefileName	String	The business logo's file name.
						imagebase64	String	A readable string of the image.
				regulatoryLocationIdentifiersDerivedField			String	The result of the query when ftsInfo \| value equals `index-regulatoryLocationIdentifiersDerivedField:searchString` in the request.
				regulatoryLocationIdentifiersWithBusinessNameDerivedField			String	The result of the query when ftsInfo \| value equals `*index-regulatoryLocationIdentifiersWithBusinessNameDerivedField:[searchString]` in the request.
				index-regulatoryLocationLicensesWithBusinessNameDerivedField			String	The result of the query when ftsInfo \| value equals `index-regulatoryPartnerIdentifiersWithBusinessNameDerivedField:[searchString]` in the request.
			schemaId				String	Required. The JSON schema that defines the object.
			id				String	Required. The identifier of the master data object.
			objectType				String	Required. The type of the object. Valid value is `masterdata-manager:productMasterData`.
			lastUpdatedDateTime				String	The identifier of the user that made the last update to the master data record.
			contextualOwnerId				String	Required. The identifier of the company sending the master data request.
			lastUpdatedByUserId				DateTime	The identifier of the user that made the last update to the master data record.
			ownerId				String	Required. The identifier of the company that owns the master data record.
			dataVersion				Integer	Required. The current version number of the object.
			createdByUserId				String	Required. The ID of the user that created the master data record.
			creationDateTime				DateTime	Required. The date and time when the master data record was created.
	primaryKey						String	Required. The primary key of the object.
facets							String	Required. Enables searches through a particular dataset.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
{
  "header": {
    "headerVersion": 1,
    "eventName": "masterdata-manager:query-companyLocationMasterData-response:v1",
    "ownerId": "bb40845c-8912-4b98-9c9a-f08bd5a9bd07",
    "isErr": false,
    "errCode": "200_OK",
    "licensePlate": "fjjnne"
  },
  "payload": {
    "pagingInfo": null,
    "documents": [
      {
        "metadata": {
          "schemaId": "masterdata-manager:companyLocationMasterData",
          "schemaVersion": 1,
          "primaryKey": "masterdata-manager:companyLocationMasterData#0d1d7aa7-32c5-47f0-84b8-fdfa9219e67b",
          "dataVersion": 1,
          "indexTarget": "0d1d7aa7-32c5-47f0-84b8-fdfa9219e67b",
          "dbTxId": 53948
        },
        "payload": {
          "schemaVersion": 1,
          "data": {
            "lscS3Identifier": "lscS3Identifier",
            "isLegalEntity": true,
            "providerNetworkNodeIdentifier": "providerNetworkNodeIdentifier",
            "legalEntityCode": "legalEntityCode",
            "parentLegalEntityCode": "parentLegalEntityCode",
            "companyNetworkNodeId": "companyNetworkNodeId",
            "regulatoryCompanyIdentifiers": [
              {
                "regulatoryCompanyIdentifierTypeId": "SGLN",
                "isPrimaryRegulatoryIdentifier": false,
                "regulatoryIdentifierValue": "OneOne1"
              },
              {
                "regulatoryCompanyIdentifierTypeId": "GLN",
                "isPrimaryRegulatoryIdentifier": false,
                "regulatoryIdentifierValue": "123456"
              }
            ],
            "businessMasterDataCommon": {
              "businessType": [
                "MANUFACTURER"
              ],
              "lscBusinessVersion": "lscBusinessVersion",
              "businessName": "Time Magazine",
              "businessEmail": "businessEmail",
              "businessPhone": "businessPhone",
              "businessUrl": "businessUrl",
              "businessTaxRegistrationCode": "businessTaxRegistrationCode",
              "businessAddress": {
                "address1": "address1",
                "address2": "address2",
                "buildingNumber": "buildingNumber",
                "plantNumber": "plantNumber",
                "floorNumber": "floorNumber",
                "houseNumber": "houseNumber",
                "city": "city",
                "village": "village",
                "township": "township",
                "district": "district",
                "state": "state",
                "postalCode": "postalCode",
                "country": "US",
                "telephone": "telephone",
                "fax": "fax",
                "url": "url",
                "lscAddressIdentifier": "lscAddressIdentifier"
              },
              "regulatoryContact": {
                "regulatoryContactTitle": "regulatoryContactTitle",
                "regulatoryContactName": "regulatoryContactName",
                "regulatoryContactEmail": "regulatoryContactEmail",
                "regulatoryContactPhone": "regulatoryContactPhone"
              },
              "businessLogo": {
                "imageIdentifier": "imageIdentifier",
                "imageMimeType": "imageMimeType",
                "imagefileName": "imagefileName",
                "imagebase64": "imagebase64"
              }
            },
            "regulatoryLocationIdentifiersDerivedField": "SGLN OneOne1,GLN 123456",
            "regulatoryLocationIdentifiersWithBusinessNameDerivedField": "Time Magazin SGLN OneOne1,Time Magazin GLN 123456"
          },
          "schemaId": "masterdata-manager:companyLocationMasterData",
          "id": "0d1d7aa7-32c5-47f0-84b8-fdfa9219e67b",
          "objectType": "masterdata-manager:companyLocationMasterData",
          "lastUpdatedDateTime": 1614028698435,
          "contextualOwnerId": "00000000-0000-0000-0000-000000000000",
          "lastUpdatedByUserId": "f9f35dd0-035d-11eb-8ec8-0242ac11000c",
          "ownerId": "00000000-0000-0000-0000-000000000000",
          "dataVersion": 1,
          "createdByUserId": "f9f35dd0-035d-11eb-8ec8-0242ac11000c",
          "creationDateTime": 1614028698435
        },
        "primaryKey": "masterdata-manager:companyLocationMasterData#0d1d7aa7-32c5-47f0-84b8-fdfa9219e67b"
      }
    ],
    "facets": [
    ]
  }
}

Errors

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.

Enable Company Location Linking

IT system administrators use these APIs to enable company location linking. Locations must already exist as members of the TraceLink Network, and the identifiers added using the Add Identifiers to Master Data APIs must match an identifier that Tracelink verified for the company. If linking is enabled, individuals with certain roles can link to specific locations. If linking is not allowed, then all individuals with the proper roles and permissions can access all of the company's location master data.

Enable Company Location Linking request

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:enable-company-location-linking:v1`.
	ownerId	String	Required. The identifier for the Owner company associated with the request.
	dataspace	String	Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is `default`.
	appName	String	Required. The application that owns the event. Valid value is `masterdata-manager`.
payload		–	Required. The request body.
	companyLocationId	String	Required. The GUID identifying the company location record against which the network node is being created. Use the Query your Company Location Master Data API to find the `id` which is the GUID (company ID).

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
{
    "header": {
        "headerVersion": 1,
        "eventName": "masterdata-manager:enable-company-location-linking:v1",
        "ownerId": "5af8699f-9e71-474b-a5eb-113cad41d518",
        "dataspace": "default",
        "appName": "masterdata-manager"
    },
    "payload": {
        "companyLocationId": "e5f57895-0daf-4ef6-8a26-297f2dea637a"
    }
}

Enable Company Location Linking response

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:enable-company-location-linking-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.
	companyLocationId	String	Required. The GUID of the company location record.
	companyLocationNeworkNodeId	String	Required. The GUID of the network node ID.

Example

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
                        "header": {
                        "headerVersion": 1,
                        "eventName": "masterdata-manager:enable-company-location-linking-response:v1",
                        "ownerId": "5af8699f-9e71-474b-a5eb-113cad41d518",
                        "isErr": false,
                        "errCode": "200_OK",
                        "licensePlate": "nwE2h3-nzd9Zl"
                        },
                        "payload": {
                        "companyLocationId": "e5f57895-0daf-4ef6-8a26-297f2dea637a",
                        "companyLocationNetworkNodeId": "639634cd-9e85-4066-a0c5-6dffad406cc8"
                        }
                    }

Errors

Element Error Message Description

Element	Error Message	Description
companyLocationId	Invalid company location ID [companyLocationId] does not match an existing company location.	The error occurs if the companyLocationId does not match an existing company location on the TraceLink Network. Use the Query your Company Location Master Data API to find the `id` which is the GUID (company ID).

companyLocationId

Invalid company location ID [companyLocationId] does not match an existing company location.

The error occurs if the companyLocationId does not match an existing company location on the TraceLink Network.

Use the Query your Company Location Master Data API to find the id which is the GUID (company ID).

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.