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.
Guidelines
Attribute | Type | Description | ||||
---|---|---|---|---|---|---|
header | – | Required. The request header. | ||||
headerVersion | Integer | Required. The version identifier for the request. Valid value is | ||||
eventName | String | Required. The fully qualified name of the request event. Valid value is | ||||
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 | ||||
appName | String | Required. The application that owns the event. Valid value is | ||||
payload | – | Required. The request body. | ||||
regulatoryItemCodeType | String | The unique regulatoryItemCodeType that identifies this product. Valid values
| ||||
regulatoryItemCodeValue | String | The value of the regulatoryitemCodeType. The value must be unique within the itemCodeType, and special characters (e.g. -, ., /. \) are removed from this value. | ||||
predicates | Array | Required. The contents of the query. | ||||
clauses | Array | Required. The attributes and values to include in the response message. | ||||
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 | ||||
sortField | Object | Required. The method of sorting the values in the relevant indexes. Valid values:
|
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"
}
}
Guidelines
Element | Type | Description | ||||
---|---|---|---|---|---|---|
header | – | Required. The response header. | ||||
headerVersion | Integer | Required. The version identifier for the response. Valid value is | ||||
eventName | String | Required. The fully qualified name of the response event. Valid value is | ||||
ownerId | String | Required. The identifier for the company providing the app. | ||||
isErr | String | Required. Indicates whether the request was successful. Valid values:
| ||||
errCode | String | Required. The status code of the request. | ||||
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. | ||||
payload | – | Required. The response body. | ||||
createdByUserID | String | Required. The ID of the user that created the master data record. | ||||
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. | ||||
lscLastSaveTimestamp | String | Required. The latest saved data and the associated timestamp from Track & Trace Services (TTS). | ||||
productDataStatus | String | Required. Specifies if the product data is active within TraceLink. Valid values:
| ||||
productTargetMarkets | Array | Contains a list of one or more target market countries where the product is distributed. | ||||
mahIdentifier | Object | Conditionally required if the target market is EU and the company publishes an EU service. The company or location identifier of the Pharmaceutical Manufacturer, which must exist in Company or Partner Master Data. The value must correlate to the company or company location in the publisher's company master data or to a Partner or a Partner location in the Partner master data. If the target market is India, this value must be the GS1 company prefix. | ||||
regulatoryCompanyIdentifierType | String | Required. The manufacturer identifier type. If the target market is India, this value must be the GS1 company prefix. Valid values
| ||||
regulatoryCompanyIdentifier | String | Required. The identifier value of the Pharmaceutical Manufacturer. | ||||
reportingItemCode | Object | The product's item code that is used in a specific target market instead of the target market's default item code for compliance reporting. The reportingItemCodeType and reportingItemCodeValue cannot already be entered on the Items Codes tab and the reportingItemCodeValue cannot be the same as the item code value. The item code is [Type], [Value]. | ||||
reportingItemCodeType | String | Required.The reporting item code specified for the product and the associated target market. The reportingItemCodeType and reportingItemCodeValue cannot already be entered on the Items Codes tab and the reportingItemCodeValue cannot be the same as the item code value. The item code is [Type], [Value]. Valid values
| ||||
reportingItemCodeValue | String | Required. The reporting item code value specified for the product and the associated target market. The reportingItemCodeType and reportingItemCodeValue cannot already be entered on the Items Codes tab and the reportingItemCodeValue cannot be the same as the item code value. The item code is [Type], [Value]. | ||||
cmoIdentifier | Object | The company identifier for the CMO manufacturing the product. | ||||
reportingItemCodeType | String | Required. The company or location identifier type of the CMO, which must exist in company or Partner master data. If the target market is India, this value must be the GS1 company prefix. Valid values
| ||||
reportingItemCodeValue | String | Required. The company or location identifier of the CMO. | ||||
vcmoIdentifier | Object | The identifier type for a third-party contracted to oversee the CMO. | ||||
reportingItemCodeType | String | Required. The virtual CMO identifier type. Valid values
| ||||
reportingItemCodeValue | String | Required. The virtual CMO identifier. | ||||
importerIdentifier | Object | The importing organization identifier. | ||||
reportingItemCodeType | String | Required. The importing organization identifier type. Valid values
| ||||
reportingItemCodeValue | String | Required. The importing organization identifier. | ||||
repackagerIdentifier | Object | The product identifier for the repackager company. Examples of repackaging include:
| ||||
reportingItemCodeType | String | Required. The repackager identifier type. Valid values
| ||||
reportingItemCodeValue | String | Required. The repackager identifier value. | ||||
distributionPartnerIdentifier | Object | The trade partner companies or internal locations that the MAH uses to distribute the product in the target market (e.g. 3PL). The value must align to a Partner company or Partner location in the Partner master data or a company location configured in company master data. | ||||
reportingItemCodeType | String | Required. The distribution Partner identifier type. Valid values
| ||||
reportingItemCodeValue | String | Required. The distribution Partner identifier. | ||||
productType | String | Conditionally required if the country code is one of the EU countries, the EU FMD countries or Turkey. The type of product. Valid values:
When DEVICE , OTC , NUTRITIONAL , or DERIVATIVE are selected, the following item information fields are optional when the targetMarketCountry is US: Strength, Dosage Form, Package Size (i.e., only Description, Drug Name and Manufacturer are required). | ||||
pointOfDispenseVerification | Boolean | Conditionally required if the country targetMarketCountry is one of the EU countries. Specifies if the product has a point of dispense verification requirement. Valid values:
| ||||
productImage | Object | The image file displaying the product's appearance or packaging. | ||||
imagebase64 | String | Required. The readable string of the image. | ||||
imageMimeType | String | Required. The file type of the image. Valid values:
| ||||
imagefileName | String | Required.The file name of the image. If the file name is not provided, value defaults to ProductImage | ||||
targetMarketCountry | String | Conditionally required if the country is one of the reporting to the EU Hub. The country using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The primary key for the target market instance. Only one target market can exist for each targetMarketCountryCode. Valid values
| ||||
distributionPartnerIdentifier | Object | The trade partner companies or internal locations that the MAH uses to distribute the product in the target market (e.g. 3PL). The value must align to a Partner company or Partner location in the Partner master data or a company location configured in company master data. | ||||
lscTargetMarketIdentifier | String | The target market identifier in TTS. | ||||
registrationClassification | String | Required. The product classification at the time of registration. Valid values:
| ||||
productOrigin | String | Conditionally required if the targetMarketCountry is the US. Specifies how the product was sourced by the company selling the product. Valid va lues:
| ||||
scheduledDrug | Boolean | Specifies if a drug is classified under one of the given schedules in India's Drugs and Cosmetic Rules (1945). Specific guidelines for storage, sale, display, and prescription pertains to each given schedule. India users must configure India as a target market, even when only manufacturing and exporting from within India. India regulations require transparency into if the medicine is a scheduled drug in India, even if the medicine is not considered a scheduled drug in the destination market. | ||||
packagedMedicinalID | String | The medicinal product package identifier (i.e. PCID) that determines the EU Hub's Article 57 Code on master data compliance reports. | ||||
productCategoryIdentifier | String | Specifics the commodity tariff code that classifies the product when determining its customs value. | ||||
productionType | String | Specifies where the product is manufactured relative to the country defined in targetMarketCountry. Valid values:
| ||||
manufacturedBy | String | The manufacturer of the product as it appears on the product label. Valid values:
| ||||
mahInternalMaterialCode | String | The internal material code of the Pharmaceutical Manufacturer for the product. | ||||
cmoInternalMaterialCode | String | The internal material code used by the CMO that manufactured the product. | ||||
vcmoInternalMaterialCode | String | The internal material code used by the virtual CMO for the product. | ||||
temporaryImportLicense | Object | The license number granted to import the product that will remain in a country temporarily before being re-exported. | ||||
licenseNumber | String | Required. The temporary importer license number. For imported products, this is the unique proprietary number of a specific medicine produced by a domestic manufacturer, then reviewed and approved by regulatory authorities. | ||||
expirationDate | String | Required. The last valid date for the imported product license in XML YYYY-MM-DD format. | ||||
repackagingLicense | Object | Required. The repackager license number. | ||||
licenseNumber | String | Required. The last valid date for the repackaged product license in XML YYYY-MM-DD format. | ||||
expirationDate | String | The date when the repackaging license number expires. | ||||
permanentImportLicense | Object | The license number granted to import a product that cannot be exported and will remain in the country permanently. | ||||
licenseNumber | String | Required. The permanent importer license number. | ||||
expirationDate | String | Required. The last valid date for the permanent import drug license in XML YYYY-MM-DD format. | ||||
prescriptionDrugType | String | The medicine classification for a product (e.g. narcotic). Valid values
| ||||
marketingAuthorizationNumber | String | The product’s authorization number issued by a government agency. | ||||
traceabilityRequired | Boolean | Conditionally required if the targetMarketCountry is the US or India. Specifies whether the product legally needs to be traced through the pharmaceutical supply chain. Valid values:
| ||||
productCode | String | Conditionally required if the targetMarketCountry is China. The regulatory product code associated with the product in China, or an additional product code in other target markets. | ||||
lscProductVersion | String | Required. The latest product version on TTS. | ||||
productEffectiveDate | String | The date that the master data record becomes effective in YYYY-MM-DD format. | ||||
productCommercialStatus | String | Required. The item status of the product in the marketplace or company. Valid values:
| ||||
lscCompanyIdentifier | String | Required. The identifier of the company object for TTS. | ||||
packagingInformation | Object | A list of one or more packaging codes and associated serialization attributes. This information is used for both serialization management and for populating regulatory reports. | ||||
packagingUom | String | Required. The unit of measure for the packaging code. If multiple packaging codes are defined, serial numbers can be generated for each level of the packaging hierarchy. Valid values:
| ||||
companyPrefix | String | Conditionally required if the packagingCodeType is | ||||
codeVersion | String | Conditionally required if the packagingItemCodeType is | ||||
maxBatchSize | String | The maximum batch size that is acceptable for the product. Used only when the value of packagingUom is | ||||
requiresAggregation | String | Specifies if each packagingUom requires serial numbers. Valid values:
| ||||
filterValue | String | The value that allows an RFID reader to select only the packaging code for this packaging level. Must be a number value from 0-7. | ||||
codeLevel | String | Conditionally required if the packagingItemCodeType is | ||||
acceptableYield | String | Conditionally required if maxBatchSize is populated. The percentage value of the maximum batch size that is considered the standard acceptable range for the batch size. The value must be a number greater than 0 and less than 100. Decimals are acceptable, including values less than 1 (e.g. 0.5). Used only when packagingUom is | ||||
lscPackagingInformationIdentifier | String | Required. The packaging information identifier of the product in TTS. | ||||
serializationType | String | The type of serialization required for the packaging code. Valid values:
| ||||
minimumYield | String | Conditionally required if maxBatchSize is populated. The percentage value of the maximum batch size that is considered the lowest end of an acceptable batch size. The value must be a number greater than 0 and less than the value of acceptableYield. Decimals are acceptable, including values less than 1 (e.g. 0.5). Used only when packagingUom is | ||||
containerAggregationQuantity | String | Conditionally required if the:
The number of the lowest packaging UOM contained in this level of shipment. (e.g. The number of inner packs contained in each case for a case.) If the value of packagingUom is | ||||
packagingRatio | String | Conditionally required if the packagingCodeType is CN-ResCode . The ratio of the packaging levels included within this packaging code (e.g. 1:5:10 refers to one large Case, with 5 smaller inner packs or bundles inside, each of which contain 2 eaches for a total of 10 eaches). | ||||
packagingCode | String | Required. The packaging code that identifies the unit of measure for the product (e.g. each, inner pack, case). Valid values:
| ||||
normalizedPackagingCodeValue | String | The combination of the regulatoryItemCodeType and the regulatoryItemCodeValue. | ||||
packagingCodeType | String | Required. The serial numbers for the product are generated according to the packaging code type. If necessary, define a packaging code for each packagingUom that needs to be tracked. | ||||
packagingCodeValue | String | Required. The serialization packaging code identifier value for the unit of measure (e.g. | ||||
isActive | Boolean | Required. Specifies if the packaging code data is active or inactive within TraceLink. Valid values:
| ||||
productExportMarkets | Array | A list of one or more target market countries where the product can be distributed. | ||||
exportFromCountry | String | Required. The country from which port the product will be shipped from by the seller to a buyer that is abroad. The country is identified using standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. There should be unique combination for each Export From and Export To country codes pairing. Individual country can not appear as an ExportToCountry or ExportForCountry more than once. | ||||
exportToCountry | String | The country where the exported products are being received. The country is identified using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. There should be a unique combination for each Export From and Export To country codes pairing. Individual countries can not appear as an ExportToCountry or ExportForCountry more than once. Valid values
| ||||
manufacturedBy | String | The manufacturer of the product as it appears on the product label. Valid values:
| ||||
manufacturedIdentifier | Object | The identifier of the manufacturer. | ||||
regulatoryCompanyIdentifierType | String | Required. The manufactured identifier type. Valid values
| ||||
regulatoryCompanyIdentifier | String | Required. The manufacturer identifier value. | ||||
unitPrice | String | Price per unit of the product in the target market. The currency symbol should not be provided and the decimal separator must be a period ( | ||||
currencyCode | String | Conditionally required if unitPrice is present. The currency code for the product's unit price in ISO 4217:2015 format. Valid values
| ||||
targetMarketExemption | String | Specifies if the product is exempt from regulatory compliance in the exportToCountry. | ||||
exportCountryExemptionCode | String | The exemption category code for exempted product with the enumeration values in India. Valid values:
| ||||
exemptionDate | String | The date the exemption request has been granted to the exporter by the governing agency of the destination country (can be the date of the published law). | ||||
exemptionReference | String | The name of the law or regulation in the destination country for which the exporter has obtained exemption permission. | ||||
productItemInformation | Array | Required. A list of product attributes in one or more languages. | ||||
lscProductItemInformationIdentifier | String | Required. The product item information identifier for a specific language in TTS. | ||||
productLanguageCode | String | Required. The language using the standard two- or three-letter abbreviation specified in ISO 639-1 language code. Valid values
| ||||
productName | String | Required. The name of the medicine that is displayed on the product label. | ||||
manufacturer | String | Required. The name of the manufacturer or re-packager of the product as it appears on the product label. | ||||
manufacturerIdentifier | Object | Conditionally required if Brazil is the targetMarketCountry and Portuguese is the productLanguageCode. The identifier of the manufacturer of the drug. The value and type must exist in company or company location master data or Partner or Partner location master data. | ||||
productDescription | String | Required. The description of the product (e.g. allergy medicine 90 mg caps 30). | ||||
productCode | String | Conditionally required if the targetMarketCountry is China. The regulatory product code associated with the product in China, or an additional product code in other target markets. | ||||
genericName | String | Conditionally required if the targetMarketCountry is China, India, and any EU country. Specifies the chemical or non-proprietary name of the product. The generic name describes the chemical make up (atomic or molecular structure) of the product in contrast to the brand name that is used to market it. | ||||
regulatoryCompanyIdentifierType | String | Required. The manufacturer identifier type. Valid values
| ||||
regulatoryCompanyIdentifier | String | Required. The company or location identifier of the manufacturer. | ||||
strength | String | Conditionally required if the targetMarketCountry is China, India, and any EU country. The strength of the product (e.g. 100 mg). If the targetMarketCountry is the US and the productType is not | ||||
maxTemperature | String | The hottest temperature the product can be exposed to without compromising its quality and safety. If the maxTemperature and the minTemperature values are both provided, the maxTemperature value must be greater than or equal to the minTemperature value. The value must be numeric characters. Negative and decimals characters are acceptable. | ||||
minTemperature | The coldest temperature the product can be exposed without compromising its quality and safety. If the maxTemperature and minTemperature values are both provided, the minTemperature must be less than or equal to the maxTemperature value. The value must be numeric characters. Negative and decimals characters are acceptable. | |||||
packSize | String | Conditionally required if the targetMarketCountry is China. The number of individual doses in the package (e.g. 30 count). If the targetMarketCountry is the US and the productType is not | ||||
packType | String | Conditionally required if the EU is the specified targetMarketCountry, and the productLanguageCode EN entry must contain a value in the emvsFormType field. The way the product is packaged to be sold according to the EU's standard set of values. Valid values
| ||||
lscEmVSDosageFormEn | String | Conditionally required if an EU country is specified as the targetMarketCountry. The dosage form of the product (e.g. tablet, capsule) using English version of EU list. If a country is specified as the targetMarketCountry, then the productLanguageCode EN entry must contain a value in the emvsFormTypeEN field. Valid values
| ||||
dosageForm | String | The dosage form of the product (e.g. tablet, capsule). If the targetMarketCountry is the US and the productType is not | ||||
temperatureScale | String | Conditionally required if maxTemperature or minTempature are populated. The temperature scale for the minimum and maximum temperature requirements. Valid values:
| ||||
marketDosageForm | String | The form in which the product is dispensed (e.g. tablet or pill). Valid values
| ||||
composition | String | Specifies the active and inactive ingredients of the drug product. | ||||
isLightSensitive | Boolean | Specifies whether exposure to light can compromise the product's quality and safety. Valid values:
| ||||
shelfLife | Object | Specifies the length of time that a product remains consumable. The value must be a number between 1-9999. | ||||
shelfLifeValue | String | Required. The shelf-life value. | ||||
shelfLifeUOT | String | Required. The shelf-life unit of time. Valid values:
| ||||
remarks | String | Product-related instructions or comments not described in the previous fields. | ||||
regulatoryItemCodes | Array | Required. The unique item code that identifies this product. | ||||
isPrimaryItemCode | Boolean | Indicates whether the identifier is the primary item code for this product. TraceLink uses the primary product item code to identify the correct product when the user updates the master data by importing a CSV file or with an asynchronous message. At least one regulatoryItemCodes must have isPrimaryItemCode set to True. Valid values:
| ||||
regulatoryItemCode | Array | Required. The item code type and value for this product. The item code type and value cannot already exist in another product master data record. Each item code type can only be used once for each product except for the | ||||
regulatoryItemCodeValue | String | Required. The value of the itemCodeType. The value must be unique within the itemCodeType, and special characters (e.g. -, ., /. \) are removed from this value. | ||||
normalizedRegulatoryItemCodeValue | String | The combination of the regulatoryItemCodeType and the regulatoryItemCodeValue. | ||||
regulatoryItemCodeType | String | Required. The unique regulatoryItemCodeType that identifies this product. Valid values
| ||||
lscRegulatoryItemCodeIdentifier | Array | Required. The item code identifier of the product in TTS. | ||||
isActive | Boolean | Specifies if the identifier is active. Valid values:
| ||||
isPrimaryItemCode | Boolean | Indicates whether the identifier is the primary item code for this product. TraceLink uses the primary product item code to identify the correct product when the user updates the master data by importing a CSV file or with an asynchronous message. At least one regulatoryItemCodes must have isPrimaryItemCode set to True. Valid values:
| ||||
regulatoryItemCodeValue | String | Required. The value of the itemCodeType. The value must be unique within the itemCodeType, and special characters (e.g. -, ., /. \) are removed from this value. | ||||
normalizedRegulatoryItemCodeValue | String | The combination of the regulatoryItemCodeType and the regulatoryItemCodeValue. | ||||
regulatoryItemCodeType | String | Required. The unique regulatoryItemCodeType that identifies this product. Valid values
| ||||
regulatoryItemCodeValue | String | Required. The value of the itemCodeType. The value must be unique within the itemCodeType, and special characters (e.g. -, ., /. \) are removed from this value. | ||||
regulatoryItemCodeValue | String | Required. The value of the itemCodeType. The value must be unique within the itemCodeType, and special characters (e.g. -, ., /. \) are removed from this value. | ||||
normalizedRegulatoryItemCodeValue | String | The combination of the regulatoryItemCodeType and the regulatoryItemCodeValue. | ||||
.. | regulatoryItemCodeType | String | Required. The unique regulatoryItemCodeType that identifies this product. Valid values
| |||
lscRegulatoryItemCodeIdentifier | Array | Required. The item code identifier of the product in TTS. | ||||
isActive | Boolean | Specifies if the identifier is active. Valid values:
| ||||
packagingInformationDerivedField | String | The result of the query when ftsInfo | value equals This includes the following fields:
| ||||
packagingInformationAndRegulatoryItemCodesDerivedField | String | The result of the query when ftsInfo | value equals This includes the following fields:
| ||||
regulatoryItemCodesDerivedField | String | The result of the query when ftsInfo | value equals This includes the following fields:
| ||||
dataVersion | Integer | Required. The current version number of the object. | ||||
schemaId | String | Required. The JSON schema that defines the object. | ||||
lastUpdatedByUserId | 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. | ||||
id | String | Required. Identifier of the master data object for one record. | ||||
lastUpdatedDateTime | DateTime | The date and time of the last master data record update. | ||||
ownerId | String | Required. The identifier of the company that owns the master data record. | ||||
objectType | String | Required. The type of the object. Valid value is masterdata-manager:productMasterData . | ||||
creationDateTime | DateTime | Required. The date and time when the master data record was created. |
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.
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-product-response: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 . | |||
processNetworkId | String | Required. The network that contains the company process. This must be a valid network at the company. | |||
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 | – | Required. Contains the attributes for the object. The contents depend on the object schema specified when the event handlers were added. | |||
productDataStatus | String | Required. Specifies if the product data is active within TraceLink. Valid values:
| |||
productCode | String | Conditionally required if the targetMarketCountry is China. The regulatory product code associated with the product in China, or an additional product code in other target markets. | |||
productEffectiveDate | String | The date that the master data record becomes effective in YYYY-MM-DD format. | |||
productCommericalStatus | String | Required. The item status of the product in the marketplace or company. Valid values:
| |||
regulatoryItemCodes | Array | Required. The unique item code that identifies this product. | |||
regulatoryItemCode | Object | The item code type and value for this product. The item code type and value cannot already exist in another product master data record. Each Item Code type can only be used once for each product except for | |||
regulatoryItemCodeType | String | Required. The unique regulatoryItemCodeType that identifies this product. Valid values
| |||
regulatoryItemCodeValue | String | Required. The value of the itemCodeType. The value must be unique within the itemCodeType, and special characters (e.g. -, ., /. \) are removed from this value. | |||
isPrimaryItemCode | Boolean | Indicates whether the identifier is the primary item code for this product. TraceLink uses the primary product item code to identify the correct product when the user updates the master data by importing a CSV file or with an asynchronous message. At least one regulatoryItemCodes must have isPrimaryItemCode set to True. Valid values:
| |||
isActive | Boolean | Specifies if the identifier is active. Valid values:
| |||
productTargetMarkets | Array | Contains a list of one or more target market countries where the product is distributed. | |||
mahIdentifier | Object | Conditionally required if the target market is EU and the company publishes an EU service. The company or location identifier of the Pharmaceutical Manufacturer, which must exist in Company or Partner Master Data. The value must correlate to the company or company location in the publisher's company master data or to a Partner or a Partner location in the Partner master data. If the target market is India, this value must be the GS1 company prefix. | |||
regulatoryCompanyIdentifierType | String | Required. The manufacturer identifier type. If the target market is India, this value must be the GS1 company prefix. Valid values
| |||
regulatoryCompanyIdentifier | String | Required. The identifier value of the Pharmaceutical Manufacturer. | |||
reportingItemCode | Object | The product's item code that is used in a specific target market instead of the target market's default item code for compliance reporting. The reportingItemCodeType and reportingItemCodeValue cannot already be entered on the Items Codes tab and the reportingItemCodeValue cannot be the same as the item code value. The item code is [Type], [Value]. | |||
reportingItemCodeType | String | Required.The reporting item code specified for the product and the associated target market. The reportingItemCodeType and reportingItemCodeValue cannot already be entered on the Items Codes tab and the reportingItemCodeValue cannot be the same as the item code value. The item code is [Type], [Value]. Valid values
| |||
reportingItemCodeValue | String | Required. The reporting item code value specified for the product and the associated target market. The reportingItemCodeType and reportingItemCodeValue cannot already be entered on the Items Codes tab and the reportingItemCodeValue cannot be the same as the item code value. The item code is [Type], [Value]. | |||
vcmoIdentifier | Object | The identifier type for a third-party contracted to oversee the CMO. | |||
regulatoryCompanyIdentifierType | String | Required. The virtual CMO identifier type. Valid values
| |||
regulatoryCompanyIdentifier | String | Required. The virtual CMO identifier. | |||
importerIdentifier | Object | The importing organization identifier. | |||
regulatoryCompanyIdentifierType | String | Required. The importing organization identifier type. Valid values
| |||
regulatoryCompanyIdentifier | String | Required. The importing organization identifier. | |||
repackagerIdentifier | Object | The product identifier for the repackager company. Examples of repackaging include:
| |||
regulatoryCompanyIdentifierType | String | Required. The repackager identifier type. Valid values
| |||
regulatoryCompanyIdentifier | String | Required. The repackager identifier value. | |||
distributionPartnerIdentifier | Object | The trade partner companies or internal locations that the MAH uses to distribute the product in the target market (e.g. 3PL). The value must align to a Partner company or Partner location in the Partner master data or a company location configured in company master data. | |||
regulatoryCompanyIdentifierType | String | Required. The distribution Partner identifier type. Valid values
| |||
regulatoryCompanyIdentifier | String | Required. The distribution Partner identifier. | |||
cmoIdentifier | Object | The company identifier for the CMO manufacturing the product. | |||
regulatoryCompanyIdentifierType | String | Required. The company or location identifier type of the CMO, which must exist in company or Partner master data. If the target market is India, this value must be the GS1 company prefix. Valid values
| |||
regulatoryCompanyIdentifier | String | Required. The company or location identifier of the CMO. | |||
productImage | Object | The image file displaying the product's appearance or packaging. | |||
imagebase64 | String | Required. The readable string of the image. | |||
imageMimeType | String | Required. The file type of the image. Valid values:
| |||
imagefileName | String | Required. The file name of the image. If the file name is not provided, value defaults to ProductImage | |||
targetMarketCountry | String | Conditionally required if the country is one of the reporting to the EU Hub. The country using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The primary key for the target market instance. Only one target market can exist for each targetMarketCountryCode. Valid values
| |||
productType | String | Conditionally required if the country code is one of the EU countries, the EU FMD countries or Turkey. The type of product. Valid values:
When DEVICE , OTC , NUTRITIONAL , or DERIVATIVE are selected, the following item information fields are optional when the targetMarketCountry is US: Strength, Dosage Form, Package Size (i.e., only Description, Drug Name and Manufacturer are required). | |||
pointOfDispenseVerification | Boolean | Conditionally required if the country targetMarketCountry is one of the EU countries. Specifies if the product has a point of dispense verification requirement. Valid values:
| |||
traceabilityRequired | Boolean | Conditionally required if the targetMarketCountry is the US or India. Specifies whether the product legally needs to be traced through the pharmaceutical supply chain. Valid values:
| |||
registrationClassification | String | Required. The product classification at the time of registration. Valid values:
| |||
productOrigin | String | Conditionally required if the targetMarketCountry is the US. Specifies how the product was sourced by the company selling the product. Valid values:
| |||
scheduledDrug | Boolean | Specifies if a drug is classified under one of the given schedules in India's Drugs and Cosmetic Rules (1945). Specific guidelines for storage, sale, display, and prescription pertains to each given schedule. India users must configure India as a target market, even when only manufacturing and exporting from within India. India regulations require transparency into if the drug is a scheduled drug in India, even if the drug is not considered a scheduled drug in the destination market. | |||
packagedMedicinalID | String | The medicinal product package identifier (i.e. PCID) that determines the EU Hub's Article 57 Code on master data compliance reports. | |||
productCategoryIdentifier | String | Specifics the commodity tariff code that classifies the product when determining its customs value. | |||
productionType | String | Specifies where the product is manufactured relative to the country defined in targetMarketCountry. Valid values:
| |||
manufacturedBy | String | The manufacturer of the product as it appears on the product label. Valid values:
| |||
mahInternalMaterialCode | String | The internal material code of the Pharmaceutical Manufacturer for the product. | |||
cmoInternalMaterialCode | String | The internal material code used by the CMO that manufactured the product. | |||
vcmoInternalMaterialCode | String | The internal material code used by the virtual CMO for the product. | |||
temporaryImportLicense | Object | The license number granted to import the product that will remain in a country temporarily before being re-exported. | |||
licenseNumber | String | Required. The temporary importer license number. For imported products, this is the unique proprietary number of a specific medicine produced by a domestic manufacturer, then reviewed and approved by regulatory authorities. | |||
expirationDate | String | Required. The last valid date for the imported product license in XML YYYY-MM-DD format. | |||
repackagingLicense | Object | Required. The repackager license number. | |||
licenseNumber | String | Required. The last valid date for the repackaged product license in XML YYYY-MM-DD format. | |||
expirationDate | String | The date when the repackaging license number expires. | |||
permanentImportLicense | Object | The license number granted to import a product that cannot be exported and will remain in the country permanently. | |||
licenseNumber | String | Required. The permanent importer license number. | |||
expirationDate | String | Required. The last valid date for the permanent import drug license in XML YYYY-MM-DD format. | |||
prescriptionDrugType | String | The medicine classification for a product (e.g. narcotic). Valid values
| |||
marketingAuthorizationNumber | String | The product’s authorization number issued by a government agency. | |||
productItemInformation | Array | Required. A list of product attributes in one or more languages. | |||
productLanguageCode | String | Required. The language using the standard two- or three-letter abbreviation specified in ISO 639-1 language code. Valid values
| |||
productName | String | Required. The name of the medicine that is displayed on the product label. | |||
manufacturer | String | Required. The name of the manufacturer or re-packager of the product as it appears on the product label. | |||
productDescription | String | Required. The description of the product (e.g. allergy medicine 90 mg caps 30). | |||
maxTemperature | String | The hottest temperature the product can be exposed to without compromising its quality and safety. If the maxTemperature and the minTemperature values are both provided, the maxTemperature value must be greater than or equal to the minTemperature value. The value must be numeric characters. Negative and decimals characters are acceptable. | |||
minTemperature | The coldest temperature the product can be exposed without compromising its quality and safety. If the maxTemperature and minTemperature values are both provided, the minTemperature must be less than or equal to the maxTemperature value. The value must be numeric characters. Negative and decimals characters are acceptable. | ||||
packSize | String | Conditionally required if the targetMarketCountry is China. The number of individual doses in the package (e.g. 30 count). If the targetMarketCountry is the US and the productType is not | |||
manufacturerIdentifier | Object | Conditionally required if Brazil is the targetMarketCountry and Portuguese is the productLanguageCode. The identifier of the manufacturer of the drug. The value and type must exist in company or company location master data or Partner or Partner location master data. | |||
regulatoryCompanyIdentifierType | String | Required. The manufacturer identifier type. Valid values
| |||
regulatoryCompanyIdentifier | String | Required. The company or location identifier of the manufacturer. | |||
strength | String | Conditionally required if the targetMarketCountry is China, India, and any EU country. The strength of the product (e.g. 100 mg). If the targetMarketCountry is the US and the productType is not | |||
genericName | String | Conditionally required if the targetMarketCountry is China, India, and any EU country. Specifies the chemical or non-proprietary name of the product. The generic name describes the chemical make up (atomic or molecular structure) of the product in contrast to the brand name that is used to market it. | |||
packType | String | Conditionally required if the EU is the specified targetMarketCountry, and the productLanguageCode EN entry must contain a value in the emvsFormType field. The way the product is packaged to be sold according to the EU's standard set of values. Valid values
| |||
lscEmVSDosageFormEn | String | Conditionally required if an EU country is specified as the targetMarketCountry. The dosage form of the product (e.g. tablet, capsule) using English version of EU list. If a country is specified as the targetMarketCountry, then the productLanguageCode EN entry must contain a value in the emvsFormTypeEN field. Valid values
| |||
dosageForm | String | The dosage form of the product (e.g. tablet, capsule). If the targetMarketCountry is the US and the productType is not | |||
temperatureScale | String | Conditionally required if maxTemperature or minTempature are populated. The temperature scale for the minimum and maximum temperature requirements. Valid values:
| |||
productCode | String | Conditionally required if the targetMarketCountry is China. The regulatory product code associated with the product in China, or an additional product code in other target markets. | |||
marketDosageForm | String | The form in which the product is dispensed (e.g. tablet or pill). Valid values
| |||
composition | String | Specifies the active and inactive ingredients of the drug product. | |||
isLightSensitive | Boolean | Specifies whether exposure to light can compromise the product's quality and safety. Valid values:
| |||
shelfLife | Object | Specifies the length of time that a product remains consumable. The value must be a number between 1-9999. | |||
shelfLifeValue | String | Required. The shelf-life value. | |||
shelfLifeUOT | String | Required. The shelf-life unit of time. Valid values:
| |||
remarks | String | Product-related instructions or comments not described in the previous fields. | |||
packagingInformation | Object | A list of one or more packaging codes and associated serialization attributes. This information is used for both serialization management and for populating regulatory reports. | |||
companyPrefix | String | Conditionally required if the packagingCodeType is | |||
codeVersion | String | Conditionally required if the packagingItemCodeType is | |||
maxBatchSize | String | The maximum batch size that is acceptable for the product. Used only when the value of packagingUom is | |||
packagingCode | String | Required. The packaging code that identifies the unit of measure for the product (e.g. each, innerpack, case). Valid values:
| |||
packagingCodeType | String | Required. The serial numbers for the product are generated according to the packaging code type. If necessary, define a packaging code for each packagingUom that needs to be tracked. | |||
packagingCodeValue | String | Required. The serialization packaging code identifier value for the unit of measure (e.g. | |||
isActive | Boolean | Required. Specifies if the packaging information data is active or inactive within TraceLink. Valid values:
| |||
packagingUom | String | Required. The unit of measure for the packaging code. If multiple packaging codes are defined, serial numbers can be generated for each level of the packaging hierarchy. Valid values:
| |||
requiresAggregation | String | Specifies if each packagingUom requires serial numbers. Valid values:
| |||
filterValue | String | The value that allows an RFID reader to select only the packaging code for this packaging level. Must be a number value from 0-7. | |||
codeLevel | String | Conditionally required if the packagingItemCodeType is | |||
acceptableYield | String | Conditionally required if maxBatchSize is populated. The percentage value of the maximum batch size that is considered the standard acceptable range for the batch size. The value must be a number greater than 0 and less than 100. Decimals are acceptable, including values less than 1 (e.g. 0.5). Used only when packagingUom is | |||
serializationType | String | The type of serialization required for the packaging code. Valid values:
| |||
minimumYield | String | Conditionally required if maxBatchSize is populated. The percentage value of the maximum batch size that is considered the lowest end of an acceptable batch size. The value must be a number greater than 0 and less than the value of acceptableYield. Decimals are acceptable, including values less than 1 (e.g. 0.5). Used only when packagingUom is | |||
containerAggregationQuantity | String | Conditionally required if the:
The number of the lowest packaging UOM contained in this level of shipment. (e.g. The number of inner packs contained in each case for a case.) If the value of packagingUom is | |||
packagingRatio | String | Conditionally required if the packagingCodeType is CN-ResCode . The ratio of the packaging levels included within this packaging code (e.g. 1:5:10 refers to one large Case, with 5 smaller inner packs or bundles inside, each of which contain 2 eaches for a total of 10 eaches). | |||
productExportMarkets | Array | A list of one or more target market countries where the product can be distributed. | |||
exportFromCountry | |||||
unitPrice | String | Price per unit of the product in the target market. The currency symbol should not be provided and the decimal separator must be a period ( | |||
manufacturedIdentifier | Object | The identifier of the manufacturer. | |||
regulatoryCompanyIdentifierType | String | Required. The manufactured identifier type. Valid values
| |||
regulatoryCompanyIdentifier | String | Required. The manufacturer identifier value. | |||
exemptionDate | String | The date the exemption request has been granted to the exporter by the governing agency of the destination country (can be the date of the published law). | |||
exportToCountry | String | The country where the exported products are being received. The country is identified using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. There should be a unique combination for each Export From and Export To country codes pairing. Individual countries can not appear as an ExportToCountry or ExportForCountry more than once. Valid values
| |||
exemptionReference | String | The name of the law or regulation in the destination country for which the exporter has obtained exemption permission. | |||
targetMarketExemption | String | Specifies if the product is exempt from regulatory compliance in the exportToCountry. | |||
exportFromCountry | String | Required. The country from which port the product will be shipped from by the seller to a buyer that is abroad. The country is identified using standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. There should be unique combination for each Export From and Export To country codes pairing. Individual country can not appear as an ExportToCountry or ExportForCountry more than once. | |||
currencyCode | String | Conditionally required if unitPrice is present. The currency code for the product's unit price in ISO 4217:2015 format. Valid values
| |||
manufacturedBy | String | The manufacturer of the product as it appears on the product label. Valid values:
| |||
exportCountryExemptionCode | String | The exemption category code for exempted product with the enumeration values in India. Valid values:
|
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
}
]
}
}
}
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).
Guidelines
Attribute | Type | Description | ||||
---|---|---|---|---|---|---|
header | – | Required. The request header. | ||||
headerVersion | Integer | Required. The version identifier for the request. Valid value is | ||||
eventName | String | Required. The fully qualified name of the request event. Valid value is | ||||
ownerId | String | Required. The identifier for the company providing the app. | ||||
appName | String | Required. The application that owns the event. Valid value is | ||||
dataspace | String | Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is | ||||
payload | – | Required. The request body. | ||||
predicates | Array | Required. The contents of the query. | ||||
type | String | Required. The type of the predicate. Valid value is | ||||
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 | ||||
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 | ||||
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",
}
}
Guidelines
Attribute | Type | Description | |||||
---|---|---|---|---|---|---|---|
header | – | Required. The response header. | |||||
headerVersion | Integer | Required. The version identifier for the response. Valid value is | |||||
eventName | String | Required. The fully qualified name of the response event. Valid value is | |||||
ownerId | String | Required. The identifier for the company providing the app. | |||||
isErr | Boolean | Required. Indicates whether the request was successful. Valid values:
| |||||
errCode | String | Required. The status code of the request. | |||||
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:
| |||||
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 the current 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. | |||||
lscLastSaveTimestamp | String | Required. The latest save data and associated timestamp from Track & Trace Services (TTS). | |||||
lscCompanyIdentifier | String | Required. The identifier of the company object for TTS. | |||||
lscProductVersion | String | Required. The latest product version on TTS. | |||||
productCode | String | Conditionally required if the targetMarketCountry is China. The regulatory product code associated with the product in China, or an additional product code in other target markets. | |||||
productEffectiveDate | String | The date that the master data record becomes effective in YYYY-MM-DD format. | |||||
productCommercialStatus | String | Required. The item status of the product in the marketplace or company. Valid values:
| |||||
productDataStatus | String | Required. Specifies if the product data is active within TraceLink. Valid values:
| |||||
providerNetworkNodeIdentifier | String | The company's network node for the originating master data record. | |||||
productItemInformation | Array | Required. A list of product attributes in one or more languages. | |||||
maxTemperature | String | The hottest temperature the product can be exposed to without compromising its quality and safety. If the maxTemperature and the minTemperature values are both provided, the maxTemperature value must be greater than or equal to the minTemperature value. The value must be numeric characters. Negative and decimals characters are acceptable. | |||||
minTemperature | String | The coldest temperature the product can be exposed without compromising its quality and safety. If the maxTemperature and minTemperature values are both provided, the minTemperature must be less than or equal to the maxTemperature value. The value must be numeric characters. Negative and decimals characters are acceptable. | |||||
manufacturerIdentifier | TypeDef | Conditionally required if Brazil is the targetMarketCountry and Portuguese is the productLanguageCode. The identifier of the manufacturer of the drug. The value and type must exist in company or company location master data or Partner or Partner location master data. | |||||
regulatoryCompanyIdentifierType | String | The manufacturer identifier type. Valid values
Only one of the following values may be used at once: Only one of the following values may be used at once: Only one of the following values may be used at once: | |||||
regulatoryCompanyIdentifer | String | Required. The identifier value of the manufacturer. | |||||
lscProductItemInformationIdentifier | String | Required. The product item information identifier for a specific language in TTS. | |||||
productCode | String | Conditionally required if the targetMarketCountry is China. The regulatory product code associated with the product in China, or an additional product code in other target markets. | |||||
productName | String | Required. The name of the medicine that is displayed on the product label. | |||||
manufacturer | String | Required. The name of the manufacturer or re-packager of the product as it appears on the product label. | |||||
genericName | String | Conditionally required if the targetMarketCountry is China, India, and any EU country. Specifies the chemical or non-proprietary name of the product. The generic name describes the chemical make up (atomic or molecular structure) of the product in contrast to the brand name that is used to market it. | |||||
productLanguageCode | String | Required. The language using the standard two- or three-letter abbreviation specified in ISO 639-1 language code. Valid values
| |||||
strength | String | Conditionally required if the targetMarketCountry is China, India, and any EU country. The strength of the product (e.g. 100 mg). If the targetMarketCountry is the US and the productType is not | |||||
packSize | String | Conditionally required if the targetMarketCountry is China. The number of individual doses in the package (e.g. 30 count). If the targetMarketCountry is the US and the productType is not | |||||
dosageForm | String | The dosage form of the product (e.g. tablet, capsule). If the targetMarketCountry is the US and the productType is not | |||||
composition | String | The active and inactive ingredients of the drug product. | |||||
remarks | String | Product-related instructions or comments not described in the previous fields. | |||||
lscEmVSDosageFormEn | String | Conditionally required if an EU country is specified as the targetMarketCountry. The dosage form of the product (e.g. tablet, capsule) using English version of EU list. If a country is specified as the targetMarketCountry, the productLanguageCode EN entry must contain a value in the emvsFormTypeEN field. Valid values
| |||||
marketDosageForm | String | The form in which the product is dispensed. Valid values
| |||||
temperatureScale | String | Conditionally required if maxTemperature or minTempature are populated. The temperature scale for the minimum and maximum temperature requirements. Valid values:
| |||||
isLightSensitive | Boolean | Specifies whether exposure to light can compromise the product's quality and safety. Valid values:
| |||||
lscEmvsDosageFormDE | String | The dosage form of the product (e.g. tablet, capsule) using the German version of the EU list. | |||||
shelfLife | Object | The time period for which the product remains viable. | |||||
shelfLifeValue | String | The length of the shelf life. | |||||
shelfLifeUOT | String | Required. The shelf-life unit of time. Valid values:
| |||||
packType | String | Conditionally required if the EU is the specified targetMarketCountry, and the productLanguageCode EN entry must contain a value in the emvsFormType field. The way the product is packaged to be sold according to the EU's standard set of values. Valid values
| |||||
productDescription | String | Required. The description of the product (e.g. ALLERGY MED 90 MG CAPS 30). | |||||
regulatoryItemCodes | Array | Required. List of one or more item codes used to refer to this product. | |||||
regulatoryItemCode | TypeDef | Required. The item code type and value for this product. The item code type and value cannot already exist in another product master data record. Each item code type can only be used once for each product except for the | |||||
regulatoryItemCodeValue | String | Required. The value of the Item Code Type. The value must be unique within the Item Code Type, and special characters (e.g. -, ., /. \) are removed from this value. | |||||
regulatoryItemCodeTypeId | String | Required. The ID of the identifier code and type combination. | |||||
regulatoryItemCodeType | String | Required. The unique regulatoryItemCodeType that identifies this product. Valid values
| |||||
lscRegulatoryItemCodeIdentifier | String | Required. The item code identifier of the product in TTS. | |||||
isPrimaryItemCode | Boolean | Required. Specifies whether the identifier is the primary item code for this product. TraceLink uses the primary product item code to identify the correct product when the user updates the master data by importing a CSV file or with an asynchronous message. At least one regulatoryItemCodes must have isPrimaryItemCode set to True. Valid values:
| |||||
isActive | Boolean | Specifies if the identifier is active. Valid values:
| |||||
packagingInformation | Array | A list of one or more packaging codes and associated serialization attributes. This information is used for both serialization management and for populating regulatory reports. | |||||
packagingCode | TypeDef | Required. The packaging code that identifies the unit of measure for the product (e.g. each, innerpack, case). Valid values:
| |||||
packagingCodeValue | String | Required. The serial numbers for the product are generated according to the packaging code type. If necessary, define a packaging code for each packagingUom that needs to be tracked. | |||||
packagingCodeType | String | Required. The serialization packaging code identifier value for the unit of measure (e.g. | |||||
packagingUom | String | Required. The unit of measure for the packaging code. If multiple packaging codes are defined, serial numbers can be generated for each level of the packaging hierarchy. Valid values:
| |||||
lscPackagingInformationIdentifier | String | Required. The packaging information identifier of the product in TTS. | |||||
packagingUom | String | Required. The unit of measure for the packaging code. If multiple packaging codes are defined, serial numbers can be generated for each level of the packaging hierarchy. Valid values:
| |||||
containerAggregationQuantity | String | Conditionally required if the:
The number of the lowest packaging UOM contained in this level of shipment. (e.g. The number of inner packs contained in each case for a case.) If the value of packagingUom is | |||||
maxBatchSize | String | The maximum batch size that is acceptable for the product. Used only when the value of packagingUom is | |||||
acceptableYield | String | Conditionally required if maxBatchSize is populated. The percentage value of the maximum batch size that is considered the standard acceptable range for the batch size. The value must be a number greater than 0 and less than 100. Decimals are acceptable, including values less than 1 (e.g. 0.5). Used only when packagingUom is | |||||
minimumYield | String | Conditionally required if maxBatchSize is populated. The percentage value of the maximum batch size that is considered the lowest end of an acceptable batch size. The value must be a number greater than 0 and less than the value of acceptableYield. Decimals are acceptable, including values less than 1 (e.g. 0.5). Used only when packagingUom is | |||||
serializationType | String | The type of serialization required for the packaging code. Valid values:
| |||||
requiresAggregation | String | Specifies if each packagingUom requires serial numbers. Valid values:
| |||||
filterValue | String | The value that allows an RFID reader to select only the packaging code for this packaging level. Must be a number value from 0-7. | |||||
companyPrefix | String | Conditionally required if the packagingCodeType is | |||||
codeVersion | String | Conditionally required if the packagingItemCodeType is | |||||
codeLevel | String | Conditionally required if the packagingItemCodeType is | |||||
isActive | Boolean | Required. Specifies if the packaging code data is active or inactive within TraceLink. Valid values:
| |||||
productExportMarkets | Array | A list of one or more target market countries where the product can be distributed. | |||||
unitPrice | String | Price per unit of the product in the target market. The currency symbol should not be provided and the decimal separator must be a period ( | |||||
manufacturedIdentifier | TypeDef | The identifier of the manufacturer. | |||||
regulatoryCompanyIdentifierType | String | Required. The manufactured identifier type. Valid values
Only one of the following values may be used at once: Only one of the following values may be used at once: Only one of the following values may be used at once: | |||||
regulatoryCompanyIdentifier | String | Required. The identifier value of the manufacturer. | |||||
exportFromCountry | String | Required. The country port where the product is shipped (from the seller to a buyer that is abroad). The country is identified using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. Valid values
| |||||
currencyCode | String | The currency code in ISO 4217:2015 format. Valid values
| |||||
exportToCountry | String | The country where the exported products are being received. The country is identified using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. There should be a unique combination for each Export From and Export To country codes pairing. Individual countries can not appear as an ExportToCountry or ExportForCountry more than once. Valid values
| |||||
manufacturedBy | String | The manufacturer of the product. Valid values:
| |||||
lscExportMarketIdentifier | String | The export market identifier in TTS. | |||||
targetMarketExemption | Boolean | Specifies if the product is exempt from regulatory compliance in the exportToCountry. | |||||
exportCountryExemptionCode | String | The exemption category code for exempted product with the enumeration values in India. Valid values:
| |||||
exemptionDate | String | The date the exemption request is granted to the exporter by the governing agency of the destination country (can be the date of the published law). | |||||
exemptionReference | String | The name of the law or regulation in the destination country for which the exporter has obtained exemption permission. | |||||
unitPrice | String | Price per unit of the product in the target market. The currency symbol should not be provided. The decimal separator must be a period ( | |||||
productTargetMarkets | Array | Contains a list of one or more target market countries where the product is distributed. | |||||
mahIdentifier | TypeDef | Conditionally required if the target market is EU and the company publishes an EU service. The company or location identifier of the Pharmaceutical Manufacturer, which must exist in Company or Partner Master Data. The value must correlate to the company or company location in the publisher's company master data or to a Partner or a Partner location in the Partner master data. If the target market is India, this value must be the GS1 company prefix. | |||||
regulatoryCompanyIdentifierType | String | Required. The manufacturer identifier type. If the target market is India, this value must be the GS1 company prefix. Valid values
| |||||
regulatoryCompanyIdentifier | String | Required. The identifier value of the Pharmaceutical Manufacturer. | |||||
reportingItemCode | TypeDef | The product's item code that is used in a specific target market instead of the target market's default item code for compliance reporting. The reportingItemCodeType and reportingItemCodeValue cannot already be entered on the Items Codes tab and the reportingItemCodeValue cannot be the same as the item code value. The item code is [Type], [Value]. | |||||
regulatoryItemCodeType | String | The unique regulatoryItemCodeType that identifies this product. Valid values
| |||||
regulatoryItemCodeValue | String | The value of the regulatoryItemCode. | |||||
vcmoIdentifier | TypeDef | The identifier for the virtual CMO. | |||||
regulatoryCompanyIdentifierType | String | The virtual CMO identifier type. Valid values
Only one of the following values may be used at once: Only one of the following values may be used at once: Only one of the following values may be used at once: | |||||
regulatoryCompanyIdentifier | String | Required. The identifier value of the virtual CMO. | |||||
distributionPartnerIdentifier | TypeDef | The trade partner companies or internal locations that the MAH uses to distribute the product in the target market (e.g. 3PL). The value must align to a Partner company or Partner location in the Partner master data or a company location configured in company master data. | |||||
regulatoryCompanyIdentifierType | String | The distribution Partner identifier type. Valid values
Only one of the following values may be used at once: Only one of the following values may be used at once: Only one of the following values may be used at once: | |||||
regulatoryCompanyIdentifier | String | Required. The identifier value of the distribution partner. | |||||
productImage | TypeDef | The image file displaying the product's appearance or packaging. | |||||
imageMimeType | String | Mime type of the image from the permitted enumeration list. Valid values:
| |||||
imagefileName | String | File name of the image. If the file name is not provided, value defaults to ProductImage. . | |||||
imagebase64 | String | The readable string of the image. | |||||
imageIdentifier | String | The identifier of the product image. | |||||
cmoIdentifier | TypeDef | The company identifier for the CMO manufacturing the product. | |||||
regulatoryCompanyIdentifierType | String | Required. The company or location identifier type of the CMO, which must exist in company or Partner master data. If the target market is India, this value must be the GS1 company prefix. Valid values
Only one of the following values may be used at once: Only one of the following values may be used at once: Only one of the following values may be used at once: | |||||
regulatoryCompanyIdentifier | String | Required. The identifier value of the CMO. | |||||
lscTargetMarketIdentifier | String | The target market identifier in TTS. | |||||
targetMarketCountry | String | Conditionally required for master data reporting to EFPIA EMVS Hub. The country using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. The primary key for the target market instance. Only one target market can exist for each targetMarketCountryCode. Valid values
| |||||
productType | String | The type of product. Valid values:
| |||||
pointOfDispenseVerification | Boolean | Conditionally required if the country targetMarketCountry is one of the EU countries. Specifies if the product has a point of dispense verification requirement. Valid values:
| |||||
traceabilityRequired | Boolean | Conditionally required if the targetMarketCountry is the US or India. Specifies whether the product legally needs to be traced through the pharmaceutical supply chain. Valid values:
| |||||
productOrigin | String | Conditionally required if the targetMarketCountry is the US. Specifies how the product was sourced by the company selling the product. Valid values:
| |||||
scheduledDrug | Boolean | Specifies if a drug is classified under one of the given schedules in India's Drugs and Cosmetic Rules (1945). Specific guidelines for storage, sale, display, and prescription pertains to each given schedule. India users must configure India as a target market, even when only manufacturing and exporting from within India. India regulations require transparency into if the drug is a scheduled drug in India, even if the drug is not considered a scheduled drug in the destination market. | |||||
packagedMedicinalID | String | The medicinal product package identifier (i.e. PCID) that determines the EU Hub's Article 57 Code on master data compliance reports. | |||||
productCategoryIdentifier | String | The tariff code that classifies the product when determining the customs value. | |||||
productionType | String | Specifies where the product is manufactured relative to the country defined in targetMarketCountry. Valid values:
| |||||
manufacturedBy | String | Manufacturer of the product. Valid values:
| |||||
mahInternalMaterialCode | String | The internal material code of the Pharmaceutical Manufacturer for the product. | |||||
cmoInternalMaterialCode | String | The internal material code of the CMO for the product. | |||||
vcmoInternalMaterialCode | String | The internal material code of the virtual CMO for the product. | |||||
repackagerIdentifier | TypeDef | The product identifier for the repackager company. Examples of repackaging include:
This organization occurs after the production process of the finished pharmaceutical preparations for the drug are completed overseas. | |||||
regulatoryCompanyIdentifierType | String | Required. The repackager identifier type. Valid values
Only one of the following values may be used at once: Only one of the following values may be used at once: Only one of the following values may be used at once: | |||||
regulatoryCompanyIdentifier | String | Required. The identifier value of the repackager. | |||||
registrationClassification | String | Required. The product classification at the time of registration. Valid values:
| |||||
importerIdentifier | TypeDef | The importing organization identifier. | |||||
regulatoryCompanyIdentifierType | String | The importer identifier type. Valid values
Only one of the following values may be used at once: Only one of the following values may be used at once: Only one of the following values may be used at once: | |||||
regulatoryCompanyIdentifier | String | Required. The identifier value of the importer. | |||||
temporaryImportLicense | TypeDef | The license information of the importer. | |||||
licenseNumber | String | Required. The importer license number. For imported drugs, this is the unique proprietary number of a specific drug produced by a domestic manufacturer, then reviewed and approved by regulatory authorities. | |||||
expirationDate | String | Required. The last valid date for the imported drug license in XML YYYY-MM-DD format. | |||||
repackagingLicense | TypeDef | The license information of the repackager. | |||||
licenseNumber | String | Required. The repackager license number. | |||||
expirationDate | String | Required. The last valid date for the repackaged drug license in XML YYYY-MM-DD format. | |||||
permanentImportLicense | TypeDef | The registration number of the imported drug license for drugs that cannot be exported and will remain in the country permanently. | |||||
licenseNumber | String | Required. The permanent license number. | |||||
expirationDate | String | Required. The last valid date for the permanent import drug license in XML YYYY-MM-DD format. | |||||
prescriptionDrugType | String | The prescription drug type indicating the nature of the drug, regulations and requirements, accepted medical use, or potential for abuse. Valid values
| |||||
packagingInformationDerivedField | String | The result of the query when ftsInfo | value equals This includes the following fields:
| |||||
packagingInformationAndRegulatoryItemCodesDerivedField | String | The result of the query when ftsInfo | value equals This includes the following fields:
| |||||
regulatoryItemCodesDerivedField | String | The result of the query when ftsInfo | value equals This includes the following fields:
| |||||
schemaId | String | Required. The JSON schema that defines the object. | |||||
id | String | Required. Identifier of the master data object. | |||||
objectType | String | Required. The type of the object. Valid value is masterdata-manager:productMasterData . | |||||
lastUpdatedByUserId | 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. | |||||
lastUpdatedDateTime | 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
{
"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