Table of contents
The full master data record for a product includes the product item code, description, and item status on TraceLink. IT system administrators and app developers use these APIs to read the full master data record for a product by submitting a query that finds the product based on the contents of one or more fields. Additionally, IT system administrators use these APIs to edit the full master data record for the product.

Get Product Master Data by Item Code
IT system administrators and app developers use this API to retrieve the full master data record for a product (e.g. item code, description, item status) based on the product's item code.

Get Product Master Data by Item Code request
Guidelines
Example
{
"header": {
"headerVersion": 1,
"eventName": "masterdata-manager:get-product-by-itemcode:v1",
"ownerId": "0510ad55-2abb-4316-bf60-e8578251c8fe",
"dataspace": "default",
"appName": "masterdata-manager"
},
"payload": {
"regulatoryItemCodeType": "US_NDC532",
"regulatoryItemCodeValue": "48343-839-27"
}
}

Get Product Master Data by Item Code response
Guidelines
Example
{
"header": {
"headerVersion": 1,
"eventName": "masterdata-manager:get-product-by-itemcode-response:v1",
"ownerId": "94b23797-36e1-4bdb-82a0-9c38d93893bc",
"isErr": false,
"errCode": "200_OK",
"licensePlate": "zF1oKI-1kn8mQ"
},
"payload": {
"createdByUserId": "",
"schemaVersion": 3,
"data": {
"lscLastSaveTimestamp": 1654107049756,
"productDataStatus": "ACTIVE",
"productTargetMarkets": [
{
"pointOfDispenseVerification": false,
"productImage": {
},
"targetMarketCountry": "CN",
"distributionPartnerIdentifier": [
],
"lscTargetMarketIdentifier": "f3887560-7a53-4d3d-883e-990e765321b6",
"productOrigin": "ORIGINATOR_EXCLUSIVE_DISTRIBUTOR",
"traceabilityRequired": false
}
],
"productCode": "07BGF7P",
"lscProductVersion": "1",
"productCommercialStatus": "RELEASED",
"lscCompanyIdentifier": "94b23797-36e1-4bdb-82a0-9c38d93893bc",
"packagingInformation": [
{
"packagingUom": "EA",
"companyPrefix": "2722439903",
"requiresAggregation": "NOT_AGGREGATED",
"filterValue": "0",
"lscPackagingInformationIdentifier": "a6d8f882-a87e-4c09-8709-4dd5259a7b85",
"serializationType": "NONE",
"packagingCode": {
"normalizedPackagingCodeValue": "GTIN_14|52722439903617",
"packagingCodeValue": "52722439903617",
"packagingCodeType": "GTIN_14"
},
"isActive": true
}
],
"productExportMarkets": [
],
"productItemInformation": [
{
"lscProductItemInformationIdentifier": "0262e9ea-b10a-4592-80ea-a74bbe8e1e02",
"packSize": "20",
"productCode": "6917353",
"strength": "200 MG",
"productLanguageCode": "ZH",
"dosageForm": "TABLET",
"productName": "Flu Med",
"productDescription": "200 MG Flu Med TABLET",
"manufacturer": "Kendall Pharma"
}
],
"regulatoryItemCodes": [
{
"isPrimaryItemCode": true,
"regulatoryItemCode": {
"regulatoryItemCodeValue": "48343-839-27",
"normalizedRegulatoryItemCodeValue": "US_NDC532|4834383927",
"regulatoryItemCodeType": "US_NDC532"
},
"lscRegulatoryItemCodeIdentifier": "6b70a6a3-b4ca-4830-b4de-64994065cb5f",
"isActive": true
},
{
"isPrimaryItemCode": false,
"regulatoryItemCode": {
"regulatoryItemCodeValue": "JNHKF4EMI",
"normalizedRegulatoryItemCodeValue": "INTERNAL_MATERIAL_CODE|jnhkf4emi",
"regulatoryItemCodeType": "INTERNAL_MATERIAL_CODE"
},
"lscRegulatoryItemCodeIdentifier": "27a5f359-fe87-4848-99bd-7a9eba488a1b",
"isActive": true
},
{
"isPrimaryItemCode": false,
"regulatoryItemCode": {
"regulatoryItemCodeValue": "1959196174",
"normalizedRegulatoryItemCodeValue": "CN_SUBTYPE|1959196174",
"regulatoryItemCodeType": "CN_SUBTYPE"
},
"lscRegulatoryItemCodeIdentifier": "aa8429ee-4aad-49a0-88c5-fba5458509c0",
"isActive": true
},
{
"isPrimaryItemCode": false,
"regulatoryItemCode": {
"regulatoryItemCodeValue": "8330-6640-26",
"normalizedRegulatoryItemCodeValue": "US_NDC442|8330664026",
"regulatoryItemCodeType": "US_NDC442"
},
"lscRegulatoryItemCodeIdentifier": "ea2eaa03-00a1-4343-b34a-4cdb85406731",
"isActive": true
},
{
"isPrimaryItemCode": false,
"regulatoryItemCode": {
"regulatoryItemCodeValue": "91334-8564-9",
"normalizedRegulatoryItemCodeValue": "US_NDC541|9133485649",
"regulatoryItemCodeType": "US_NDC541"
},
"lscRegulatoryItemCodeIdentifier": "7d6f5d3a-de7e-4158-a248-d14a833f2b89",
"isActive": true
},
{
"isPrimaryItemCode": false,
"regulatoryItemCode": {
"regulatoryItemCodeValue": "00629050738",
"normalizedRegulatoryItemCodeValue": "US_NDC542|00629050738",
"regulatoryItemCodeType": "US_NDC542"
},
"lscRegulatoryItemCodeIdentifier": "98fe7d2f-65bc-40a4-b770-cdbaf907af7d",
"isActive": true
}
],
"packagingInformationDerivedField": "GTIN-14 52722439903617",
"packagingInformationAndRegulatoryItemCodesDerivedField": "US_NDC532 48343-839-27,INTERNAL_MATERIAL_CODE JNHKF4EMI,CN_SUBTYPE 1959196174,US_NDC442 8330-6640-26,US_NDC541 91334-8564-9,US_NDC542 00629050738,GTIN_14 52722439903617",
"regulatoryItemCodesDerivedField": "US_NDC532 48343-839-27,INTERNAL_MATERIAL_CODE JNHKF4EMI,CN_SUBTYPE 1959196174,US_NDC442 8330-6640-26,US_NDC541 91334-8564-9,US_NDC542 00629050738"
},
"dataVersion": 2,
"schemaId": "masterdata-manager:productMasterData",
"lastUpdatedByUserId": "",
"contextualOwnerId": "94b23797-36e1-4bdb-82a0-9c38d93893bc",
"id": "05b7e441-0379-449d-a64b-033e75537d37",
"lastUpdatedDateTime": 1654110557808,
"ownerId": "94b23797-36e1-4bdb-82a0-9c38d93893bc",
"objectType": "masterdata-manager:productMasterData",
"creationDateTime": 1654110557808
}
}
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.
Review TraceLink's API: Terms of Use
Add or Edit Product Master Data
IT system administrators use this API to add or edit the full master data record for a product (e.g. product item code, description, and item) based on the product's regulatory item code. IT system administrators should retrieve the existing company master data record using the Get Product Master Data by Item Code API, 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 Product Master Data request
Guidelines
Example
{
"header": {
"headerVersion": 1,
"eventName": "masterdata-manager:add-product:v1",
"ownerId": "0510ad55-2abb-4316-bf60-e8578251c8fe",
"dataspace": "default",
"appName": "masterdata-manager"
},
"payload": {
"data": {
"lscLastSaveTimestamp": 1667310927999,
"productDataStatus": "ACTIVE",
"lscProductVersion": "1",
"productCommercialStatus": "RELEASED",
"productTargetMarkets": [
{
"pointOfDispenseVerification": false,
"productImage": {
},
"targetMarketCountry": "AU",
"distributionPartnerIdentifier": [
],
"lscTargetMarketIdentifier": "02f443d5-e967-49aa-ae0c-fa32022d5999",
"productOrigin": "DIRECT_PURCHASE_REPACKKAGER",
"traceabilityRequired": false
}
],
"productCode": "NNICBFD",
"packagingInformationDerivedField": "CN-RESCODE 30748",
"regulatoryItemCodesDerivedField": "CN_SUBTYPE 6750548335",
"lscCompanyIdentifier": "4c5bf0ec-a9b2-4487-8dd5-f58f4f08aa7e",
"packagingInformation": [
{
"packagingUom": "EA",
"requiresAggregation": "NOT_AGGREGATED",
"codeVersion": "81",
"codeLevel": "3",
"packagingRatio": "1:20:100",
"lscPackagingInformationIdentifier": "07072b36-cebd-412a-bb85-22d92f789b7e",
"serializationType": "NONE",
"packagingCode": {
"normalizedPackagingCodeValue": "CN_RESCODE|30748",
"packagingCodeValue": "30748",
"packagingCodeType": "CN_RESCODE"
},
"isActive": true,
"containerAggregationQuantity": "0"
}
],
"productExportMarkets": [
],
"packagingInformationAndRegulatoryItemCodesDerivedField": "CN_SUBTYPE 6750548334,CN_RESCODE 30748",
"productItemInformation": [
{
"lscProductItemInformationIdentifier": "21ae2f90-b416-42d6-b679-7d5d32dcf457",
"packSize": "12",
"productCode": "7360862",
"strength": "750 MG",
"productLanguageCode": "ZH",
"dosageForm": "TABLET",
"productName": "Flu Med",
"productDescription": "750 MG Flu Med TABLET",
"manufacturer": "Kendall Pharma"
}
],
"regulatoryItemCodes": [
{
"isPrimaryItemCode": true,
"regulatoryItemCode": {
"regulatoryItemCodeValue": "6750548335",
"normalizedRegulatoryItemCodeValue": "CN_SUBTYPE|6750548334",
"regulatoryItemCodeType": "CN_SUBTYPE"
},
"lscRegulatoryItemCodeIdentifier": "ef4bb628-1dd4-495d-9b8d-f56378f10cda",
"isActive": true
}
]
}
}
}

Add or Edit Product 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-product-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:
| |
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:
| |
payload | – | The payload containing the response body. If the call is unsuccessful, payload is id . | |
processid | String | Conditionally required if the call is successful. The identifier for the new product. |
Example
{
"header": {
"headerVersion": 1,
"eventName": "masterdata-manager:add-product-response:v1",
"ownerId": "0510ad55-2abb-4316-bf60-e8578251c8fe",
"isErr": false,
"errCode": "200_OK",
"licensePlate": "bGfJR9-Z7SqzI"
},
"payload": {
"id": "9bfd0232-8dda-11ed-9ef0-fb5120225fe5"
}
}
Errors
Element | Error Message | Description |
---|---|---|
Any field that has an enumeration list. | "Invalid value for
| The error occurs if the value is not in the list of valid values. |
regulatoryItemCodes | “Item codes must be unique. Item Code [
| The error occurs if the non-primary Item Code [ |
regulatoryItemCodes | “Item Code Type
| The error occurs if the regulatoryItemCode is set to use an Item Code Type |
isPrimaryItemCode | “No item codes are currently set as the primary. One item code must be set as the primary item code.”
| The error occurs if no item codes are set as the primary item code. |
isPrimaryItemCode | “Multiple item codes are currently set as the primary. Only one item code can be the primary item code.” | The error occurs if isPrimaryItemCode is set to have multiple item codes as the primary item code. |
productLanguageCode | “Language Code
| The error occurs if and operator attempts to set the same productLanguageCode to multiple sets of item information. |
productName | “Product Name is required.” | The error occurs if the productName field is empty. |
manufacturedBy | “Manufacturer is required.” | The error occurs if the manufacturedBy field is empty. |
productDescription | “Product Description is required.” | The error occurs if the productDescription field is empty. |
This app also uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.
Review TraceLink's API: Terms of Use
Query Product Master Data
IT system administrators and app developers use this API to retrieve the full master data record for products (e.g. country drug codes, internal material codes, product attributes).

Query Product 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-productMasterData: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:
| ||||
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:
| ||||
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:
| ||||
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:
| ||||
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:
|
Example
{
"header": {
"headerVersion": 1,
"eventName": "masterdata-manager:query-productMasterData:v1",
"ownerId": "00000000-0000-0000-0000-000000000000",
"dataspace": "default",
"appName": "masterdata-manager"
},
"payload": {
"predicates": [
{
"type": "PREDICATE",
"logicalOperator": "TRUE",
"clauses": [{
"type": "TERM",
"comparisonOperator": "LUCENE_FTS",
"schemaId": "masterdata-manager:productMasterData",
"ftsInfo": {
"value": "index-itemCodeAndPackagingCodeDerivedField:searchString*",
"pageIndex": 0,
"sortField": {
}
}
}]
}
],
"maximumResults": 10000,
"pagingInfo": "",
"keyFormat": "PRIMARY_KEY",
}
}

Query Product Master Data response
Guidelines
Example
{
"header": {
"headerVersion": 1,
"eventName": "masterdata-manager:query-productMasterData-response:v1",
"ownerId": "00000000-0000-0000-0000-000000000000",
"isErr": false,
"errCode": "200_OK",
"licensePlate": "nRlxSo"
},
"payload": {
"pagingInfo": null,
"documents": [
{
"metadata": {
"schemaId": "masterdata-manager:productMasterData",
"schemaVersion": 1,
"primaryKey": "masterdata-manager:productMasterData#723cdf0d-0a96-4035-adbf-2f01a45ea3f0",
"dataVersion": 1,
"indexTarget": "723cdf0d-0a96-4035-adbf-2f01a45ea3f0",
"dbTxId": 91614
},
"payload": {
"schemaVersion": 1,
"data": {
"lscLastSaveTimestamp": "2021-03-10T15:37:07.542627",
"lscCompanyIdentifier": "lscCompanyIdentifier",
"lscProductVersion": "lscProductVersion",
"productCode": "productCode",
"productEffectiveDate": "",
"productCommercialStatus": "ALTERNATE_ITEMS_AVAILABLE",
"productDataStatus": "ACTIVE",
"providerNetworkNodeIdentifier": "providerNetworkNodeIdentifier",
"productItemInformation": [
{
"maxTemperature": "maxTemperature",
"minTemperature": "minTemperature",
"manufacturerIdentifier": {
"regulatoryCompanyIdentifierType": "RU_ACCOUNT_NUMBER",
"regulatoryCompanyIdentifier": "regulatoryCompanyIdentifier"
},
"lscProductItemInformationIdentifier": "lscProductItemInformationIdentifier",
"productCode": "productCode",
"productName": "productName",
"manufacturer": "manufacturer",
"genericName": "genericName",
"productLanguageCode": "EN",
"strength": "strength",
"packSize": "packSize",
"dosageForm": "dosageForm",
"composition": "composition",
"remarks": "remarks",
"lscEmVSDosageFormEn": "lscEmVSDosageFormEn",
"marketDosageForm": "marketDosageForm",
"temperatureScale": "CELSIUS",
"isLightSensitive": "true",
"lscEmvsDosageFormDE": "lscEmvsDosageFormDE",
"shelfLife": {
"shelfLifeValue": "shelfLifeValue",
"shelfLifeUOT": "MONTHS"
},
"packType": "ADMINISTRATIONSYSTEM",
"productDescription": "productDescription"
}
],
"regulatoryItemCodes": [
{
"regulatoryItemCode": {
"regulatoryItemCodeValue": "regulatoryItemCodeValue",
"regulatoryItemCodeTypeId": "795841a9-ce61-40f0-962a-b17e2612dc17",
"regulatoryItemCodeType": "SGLN"
},
"lscRegulatoryItemCodeIdentifier": "lscRegulatoryItemCodeIdentifier",
"isPrimaryItemCode": false,
"isActive": true
}
],
"packagingInformation": [
{
"packagingCode": {
"packagingCodeValue": "packagingCodeValue3",
"packagingCodeType": "GTIN_14",
"packagingUom": "EA"
},
"lscPackagingInformationIdentifier": "lscPackagingInformationIdentifier",
"packagingUom": "EA",
"containerAggregationQuantity": "containerAggregationQuantity",
"maxBatchSize": 0,
"acceptableYield": 0,
"minimumYield": "minimumYield",
"serializationType": "SEQUENTIAL",
"requiresAggregation": "AGGREGATED",
"filterValue": "1",
"companyPrefix": "companyPrefix",
"codeVersion": "codeVersion",
"codeLevel": "codeLevel",
"isActive": true
}
],
"productExportMarkets": [
{
"manufacturedIdentifier": {
"regulatoryCompanyIdentifierType": "BR_CNES",
"regulatoryCompanyIdentifier": "regulatoryCompanyIdentifier"
},
"exportFromCountry": "RU",
"currencyCode": "USD",
"exportToCountry": "US",
"manufacturedBy": "MAH",
"lscExportMarketIdentifier": "lscExportMarketIdentifier",
"targetMarketExemption": false,
"exportCountryExemptionCode": "IN_CONSIGNMENT",
"exemptionDate": "",
"exemptionReference": "exemptionReference",
"unitPrice": "unitPrice"
}
],
"productTargetMarkets": [
{
"mahIdentifier": {
"regulatoryCompanyIdentifierType": "AM_TIN",
"regulatoryCompanyIdentifier": "regulatoryCompanyIdentifier"
},
"reportingItemCode": {
"regulatoryItemCodeValue": "regulatoryItemCodeValue",
"regulatoryItemCodeType": "BR_ANVISA_REGISTRATION"
},
"vcmoIdentifier": {
"regulatoryCompanyIdentifierType": "BY_TIN",
"regulatoryCompanyIdentifier": "regulatoryCompanyIdentifier"
},
"distributionPartnerIdentifier": [
{
"regulatoryCompanyIdentifierType": "IN_PRODUCT_CODE",
"regulatoryCompanyIdentifier": "regulatoryCompanyIdentifier"
}
],
"productImage": {
"imageMimeType": "imageMimeType",
"imagefileName": "imagefileName",
"imagebase64": "imagebase64",
"imageIdentifier": "imageIdentifier"
},
"cmoIdentifier": {
"regulatoryCompanyIdentifierType": "RU_ACCOUNT_NUMBER",
"regulatoryCompanyIdentifier": "regulatoryCompanyIdentifier"
},
"lscTargetMarketIdentifier": "lscTargetMarketIdentifier",
"targetMarketCountry": "US",
"productType": "MEDICAL_DEVICE",
"pointOfDispenseVerification": false,
"traceabilityRequired": false,
"productOrigin": "DIRECT_PURCHASE_EXCLUSIVE_DISTRIBUTOR",
"scheduledDrug": false,
"packagedMedicinalID": "packagedMedicinalID",
"productCategoryIdentifier": "productCategoryIdentifier",
"productionType": "IMPORTED_AND_REPACKAGED_LOCALLY",
"manufacturedBy": "MAH",
"mahInternalMaterialCode": "mahInternalMaterialCode",
"cmoInternalMaterialCode": "cmoInternalMaterialCode",
"vcmoInternalMaterialCode": "vcmoInternalMaterialCode",
"repackagerIdentifier": {
"regulatoryCompanyIdentifierType": "RU_ACCOUNT_NUMBER",
"regulatoryCompanyIdentifier": "regulatoryCompanyIdentifier"
},
"registrationClassification": "PATENT_MEDICINE",
"importerIdentifier": {
"regulatoryCompanyIdentifierType": "RU_ACCOUNT_NUMBER",
"regulatoryCompanyIdentifier": "regulatoryCompanyIdentifier"
},
"temporaryImportLicense": {
"licenseNumber": "1234",
"expirationDate": "2020-11-20"
},
"repackagingLicense": {
"licenseNumber": "1234",
"expirationDate": "2020-11-20"
},
"permanentImportLicense": {
"licenseNumber": "1234",
"expirationDate": "2020-11-20"
},
"prescriptionDrugType": "ANABOLICSTEROID"
}
],
"packagingInformationDerivedField": "GTIN-14 packagingCodeValue3",
"packagingInformationAndRegulatoryItemCodesDerivedField": "SGLN regulatoryItemCodeValue,GTIN_14 packagingCodeValue3",
"regulatoryItemCodesDerivedField": "SGLN regulatoryItemCodeValue"
},
"schemaId": "masterdata-manager:productMasterData",
"id": "723cdf0d-0a96-4035-adbf-2f01a45ea3f0",
"objectType": "masterdata-manager:productMasterData",
"lastUpdatedDateTime": 1615410068486,
"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": 1615410068486
},
"primaryKey": "masterdata-manager:productMasterData#723cdf0d-0a96-4035-adbf-2f01a45ea3f0"
}
],
"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.
Review TraceLink's API: Terms of Use