| header | – | Required. The response header. |
| | headerVersion | Integer | Required. The version identifier for the response. Valid value is 1. |
| | eventName | String | Required. The fully qualified name of the response event. Valid value is masterdata-manager:get-product-by-itemcode-response:v1. |
| | ownerId | String | Required. The identifier for the company providing the app. |
| | isErr | String | Required. Indicates whether the request was successful. Valid values: true – The request was successful.false – The request was not successful. The errCode field provides error information for troubleshooting.
|
| | errCode | String | Required. The status code of the request. 200_OK indicates that the request was successful. |
| | errMsg | String | Conditionally required if the call is unsuccessful. The message associated with the error code. |
| | licensePlate | String | Required. The unique identifier for the request and response instance. |
| 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: ACTIVE – The data can be used in messages and UI functions, and TraceLink pulls the data when necessary.INACTIVE – The data cannot be pulled for other functions within TraceLink.
|
| | | 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 AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).IN_COMPANY_ID – India Company ID (e.g. 5423695784236).IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.IN_LOCATION_ID – India Location ID (e.g. 65874532).IN_MFR – India Manufacturing Code (e.g. 00552101).IN_MRCH – India Merchant Exporter Code (e.g. 601227644).IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.SGLN – 15-character SGLN format representation of Global Location Number:- Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
- Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
|
| | | | | 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 AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).IN_COMPANY_ID – India Company ID (e.g. 5423695784236).IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.IN_LOCATION_ID – India Location ID (e.g. 65874532).IN_MFR – India Manufacturing Code (e.g. 00552101).IN_MRCH – India Merchant Exporter Code (e.g. 601227644).IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.SGLN – 15-character SGLN format representation of Global Location Number:- Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
- Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
|
| | | | | 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 AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).IN_COMPANY_ID – India Company ID (e.g. 5423695784236).IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.IN_LOCATION_ID – India Location ID (e.g. 65874532).IN_MFR – India Manufacturing Code (e.g. 00552101).IN_MRCH – India Merchant Exporter Code (e.g. 601227644).IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.SGLN – 15-character SGLN format representation of Global Location Number:- Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
- Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
|
| | | | | 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 AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).IN_COMPANY_ID – India Company ID (e.g. 5423695784236).IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.IN_LOCATION_ID – India Location ID (e.g. 65874532).IN_MFR – India Manufacturing Code (e.g. 00552101).IN_MRCH – India Merchant Exporter Code (e.g. 601227644).IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.SGLN – 15-character SGLN format representation of Global Location Number:- Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
- Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
|
| | | | | reportingItemCodeValue | String | Required. The virtual CMO identifier. |
| | | | importerIdentifier | | Object | The importing organization identifier. |
| | | | | reportingItemCodeType | String | Required. The importing organization identifier type.  Valid values AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).IN_COMPANY_ID – India Company ID (e.g. 5423695784236).IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.IN_LOCATION_ID – India Location ID (e.g. 65874532).IN_MFR – India Manufacturing Code (e.g. 00552101).IN_MRCH – India Merchant Exporter Code (e.g. 601227644).IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.SGLN – 15-character SGLN format representation of Global Location Number:- Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
- Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
|
| | | | | reportingItemCodeValue | String | Required. The importing organization identifier. |
| | | | repackagerIdentifier | | Object | The product identifier for the repackager company. Examples of repackaging include: - Dividing a large package into smaller ones.
- Adding an outer package to a product with an inner-package.
- Placing insert sheets and attaching labels after the production process of the finished pharmaceutical preparations for the drug are completed overseas.
|
| | | | | reportingItemCodeType | String | Required. The repackager identifier type.  Valid values AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).IN_COMPANY_ID – India Company ID (e.g. 5423695784236).IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.IN_LOCATION_ID – India Location ID (e.g. 65874532).IN_MFR – India Manufacturing Code (e.g. 00552101).IN_MRCH – India Merchant Exporter Code (e.g. 601227644).IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.SGLN – 15-character SGLN format representation of Global Location Number:- Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
- Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
|
| | | | | 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 AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).IN_COMPANY_ID – India Company ID (e.g. 5423695784236).IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.IN_LOCATION_ID – India Location ID (e.g. 65874532).IN_MFR – India Manufacturing Code (e.g. 00552101).IN_MRCH – India Merchant Exporter Code (e.g. 601227644).IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.SGLN – 15-character SGLN format representation of Global Location Number:- Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
- Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
|
| | | | | 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: BULK – Bulk pharmaceutical product.DERIVATIVE – Derivative product.DEVICE – Medical device.FOOD_SUPPLEMENT – Nutritional product.NUTRITION – Nutritional product.OTC – Over the counter drug.PHARMACEUTICAL – Prescription drug.
 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: true – (default) The product has a point of dispense verification requirement.false – The product does not have a point of dispense verification requirement.
|
| | | | 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: BMP – Bitmap image file.GIF – Graphics Interchange Format.JPG – Image format developed by Joint Photographic Experts group.PNG – Portable Network Graphics.
|
| | | | | 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 AD – ANDORRAAE – UNITED ARAB EMIRATESAF – AFGHANISTANAG – ANTIGUA AND BARBUDAAI – ANGUILLAAL – ALBANIAAN – NETHERLANDS ANTILLESAO – ANGOLAAQ – ANTARCTICAAR – ARGENTINAAS – AMERICAN SAMOAAT – AUSTRIAAU – AUSTRALIAAW – ARUBAAX – ÅLAND ISLANDSAZ – AZERBAIJANBA – BOSNIA AND HERZEGOVINABB – BARBADOSBD – BANGLADESHBE – BELGIUMBF – BURKINA FASOBG – BULGARIABH – BAHRAINBI – BURUNDIBJ – BENINBL – SAINT BARTHÉLEMYBM – BERMUDABN – BRUNEI DARUSSALAMBO – BOLIVIA, PLURINATIONAL STATE OFBR – BRAZILBS – BAHAMASBT – BHUTANBV – BOUVET ISLANDBW – BOTSWANABY – BELARUSBZ – BELIZECA – CANADACC – COCOS (KEELING) ISLANDSCD – CONGO, THE DEMOCRATIC REPUBLIC OF THECF – CENTRAL AFRICAN REPUBLICCG – CONGOCH – SWITZERLANDCI – CÔTE D'IVOIRECK – COOK ISLANDSCL – CHILECM – CAMEROONCN – CHINACO – COLOMBIACR – COSTA RICACU – CUBACV – CAPE VERDECX – CHRISTMAS ISLANDCY – CYPRUSCZ – CZECH REPUBLICDE – GERMANYDJ – DJIBOUTIDK – DENMARKDM – DOMINICADO – DOMINICAN REPUBLICDZ – ALGERIAEC – ECUADOREE – ESTONIAEG – EGYPTEH – WESTERN SAHARAER – ERITREAES – SPAINET – ETHIOPIAFI – FINLANDFJ – FIJIFK – FALKLAND ISLANDS (MALVINAS)FM – MICRONESIA, FEDERATED STATES OFFO – FAROE ISLANDSFR – FRANCEGA – GABONGB – UNITED KINGDOMGD – GRENADAGE – GEORGIAGF – FRENCH GUIANAGG – GUERNSEYGH – GHANAGI – GIBRALTARGL – GREENLANDGM – GAMBIAGN – GUINEAGP – GUADELOUPEGQ – EQUATORIAL GUINEAGR – GREECEGS – SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDSGT – GUATEMALAGU – GUAMGW – GUINEA–BISSAUGY – GUYANAHK – HONG KONGHM – HEARD ISLAND AND MCDONALD ISLANDSHN – HONDURASHR – CROATIAHT – HAITIHU – HUNGARYID – INDONESIAIE – IRELANDIL – ISRAELIM – ISLE OF MANIN – INDIAIO – BRITISH INDIAN OCEAN TERRITORYIQ – IRAQIR – IRAN, ISLAMIC REPUBLIC OFIS – ICELANDIT – ITALYJE – JERSEYJM – JAMAICAJO – JORDANJP – JAPANKE – KENYAKG – KYRGYZSTANKH – CAMBODIAKI – KIRIBATIKM – COMOROSKN – SAINT KITTS AND NEVISKP – KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OFKR – KOREA, REPUBLIC OFKW – KUWAITKY – CAYMAN ISLANDSKZ – KAZAKHSTANLA – LAO PEOPLE'S DEMOCRATIC REPUBLICLB – LEBANONLC – SAINT LUCIALI – LIECHTENSTEINLK – SRI LANKALR – LIBERIALS – LESOTHOLT – LITHUANIALU – LUXEMBOURGLV – LATVIALY – LIBYAN ARAB JAMAHIRIYAMA – MOROCCOMC – MONACOMD – MOLDOVA, REPUBLIC OFME – MONTENEGROMF – SAINT MARTINMG – MADAGASCARMH – MARSHALL ISLANDSMK – MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OFML – MALIMM – MYANMARMN – MONGOLIAMO – MACAOMP – NORTHERN MARIANA ISLANDSMQ – MARTINIQUEMR – MAURITANIAMS – MONTSERRATMT – MALTAMU – MAURITIUSMV – MALDIVESMW – MALAWIMX – MEXICOMY – MALAYSIAMZ – MOZAMBIQUENA – NAMIBIANC – NEW CALEDONIANE – NIGERNF – NORFOLK ISLANDNG – NIGERIANI – NICARAGUANL – NETHERLANDSNO – NORWAYNP – NEPALNR – NAURUNU – NIUENZ – NEW ZEALANDOM – OMANPA – PANAMAPE – PERUPF – FRENCH POLYNESIAPG – PAPUA NEW GUINEAPH – PHILIPPINESPK – PAKISTANPL – POLANDPM – SAINT PIERRE AND MIQUELONPN – PITCAIRNPR – PUERTO RICOPS – PALESTINIAN TERRITORY, OCCUPIEDPT – PORTUGALPW – PALAUPY – PARAGUAYQA – QATARRE – RÉUNIONRO – ROMANIARS – SERBIARU – RUSSIAN FEDERATIONRW – RWANDASA – SAUDI ARABIASB – SOLOMON ISLANDSSC – SEYCHELLESSD – SUDANSE – SWEDENSG – SINGAPORESH – SAINT HELENA, ASCENSION AND TRISTAN DA CUNHASI – SLOVENIASJ – SVALBARD AND JAN MAYENSK – SLOVAKIASL – SIERRA LEONESM – SAN MARINOSN – SENEGALSO – SOMALIASR – SURINAMEST – SAO TOME AND PRINCIPESV – EL SALVADORSY – SYRIAN ARAB REPUBLICSZ – SWAZILANDTC – TURKS AND CAICOS ISLANDSTD – CHADTF – FRENCH SOUTHERN TERRITORIESTG – TOGOTH – THAILANDTJ – TAJIKISTANTK – TOKELAUTL – TIMOR–LESTETM – TURKMENISTANTN – TUNISIATO – TONGATR – TURKEYTT – TRINIDAD AND TOBAGOTV – TUVALUTW – TAIWANTZ – TANZANIA, UNITED REPUBLIC OFUA – UKRAINEUG – UGANDAUM – UNITED STATES MINOR OUTLYING ISLANDSUS – UNITED STATESUY – URUGUAYUZ – UZBEKISTANVA – HOLY SEE (VATICAN CITY STATE)VC – SAINT VINCENT AND THE GRENADINESVE – VENEZUELA, BOLIVARIAN REPUBLIC OFVG – VIRGIN ISLANDS, BRITISHVI – VIRGIN ISLANDS, U.S.VN – VIETNAMVU – VANUATUWF – WALLIS AND FUTUNAWS – SAMOAXK – KOSOVOYE – YEMENYT – MAYOTTEZA – SOUTH AFRICAZM – ZAMBIAZW – ZIMBABWE
|
| | | | 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: BIOLOGICAL – The product is classified as biological.CHEMICAL – The product is classified as chemical.PATENT_MEDICINE – The product is classified as a patented medicine.
|
| | | | 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: DirectPurchaseExclusiveDistributor – The company acquires the product as a direct purchase from the exclusive distributor of the manufacturer.DirectPurchaseManufacturer – The company acquires the product as a direct purchase from the manufacturer.DirectPurchaseRepackager – The company acquires a product as a direct purchase from a repackager who purchased directly from the manufacturer.IndirectPurchase – The company acquires a product as an indirect purchase from a supplier or repackager that did not acquire the product directly from the manufacturer.Originator – The company is the manufacturer of the product and sells the product into the supply chain.OriginatorExclusiveDistributor – The company that purchased the product is the exclusive distributor of the product. In this case, the exclusive distributor sets the productOrigin to be OriginatorExclusiveDistributor, and not DirectPurchaseManufacturer, even though the exclusive distributor did purchase from the manufacturer. This ensures that outbound transaction histories for this product will start with the exclusive distributor and not continue the received transaction history.
|
| | | | 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: LocallyManufactured – Product is manufactured locally.Imported – Product is imported.ImportedAndRepackagedLocally – Product is manufactured outside the Target Market but it is packaged locally.
|
| | | | manufacturedBy | String | The manufacturer of the product as it appears on the product label. Valid values: CMO – Contract Manufacturing OrganizationMAH – Market Authorization Holder
|
| | | | 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 ANABOLICSTEROID – Anabolic steroidANTIRETROVIRAL – AntiretroviralCONTROLLEDPLANT – Controlled PlantIMMUNOSUPPRESSIVE – ImmunosuppressiveNARCOTIC – Narcotic
 This value is applicable if the target market for this product is India. OTHER – Other
 This value is applicable if the target market for this product is India. PHARMACEUTICALPRECURSORCHEMICAL – Pharmaceutical Precursor ChemicalPROHIBITEDSUBSTANCE – Prohibited SubstancePSYCHOACTIVEANORECTIC – Psychoactive - Anorectic
 This value is applicable if the target market for this product is India. PSYCHOACTIVEANTIANXIETY – Psychoactive - Anti-anxiety
 This value is applicable if the target market for this product is India. PSYCHOACTIVEANTIDEPRESSANT – Psychoactive - Antidepressant
 This value is applicable if the target market for this product is India. PSYCHOACTIVEANTIEPILEPTIC – Psychoactive - Antiepileptic
 This value is applicable if the target market for this product is India. PSYCHOACTIVEANTIPSYCHOTIC – Psychoactive - Antipsychotic
 This value is applicable if the target market for this product is India. PSYCHOACTIVEMOODSTABILIZER – Psychoactive - Mood Stabilizer
 This value is applicable if the target market for this product is India. PSYCHOACTIVESLEEPINDUCER – Psychoactive - Sleep Inducer
 This value is applicable if the target market for this product is India. PSYCHOACTIVESTIMULANT – Psychoactive - Stimulant
 This value is applicable if the target market for this product is India. RADIOACTIVE – RadioactiveRETINOID – RetinoidTOXICDRUGFORMEDICALUSE – Toxic drug for medical use
|
| | | | 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: Required – The product requires tracking.Not Required – The product is exempt from tracking.
|
| | | 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: ALTERNATE_ITEM_AVAILABLE – Alternate product is available.ITEMS_NO_LONGER_STOCKED – The product is not currently stocked.PHASE_OUT – The product is no longer available for production or sale.RELEASED – The product is approved for commercial sale.WITHDRAWN – The product is removed from the market.
|
| | | 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: NONE – This option is only available if the packagingCodeType is GTIN-14.PRIMARY – The level of packaging that physically touches the product (i.e. blister packs). This option is not available if the packagingCodeType is CN-ResCode.EACH – The smallest salable unit of the product.INNERPACK – A grouping of eaches.CASE – A grouping of inner packs, bundle, or a grouping of eaches if the packaging hierarchy does not include inner packs or bundles.PALLET – The level of packaging with cases grouped together on a pallet. This option is not available if the packagingCodeType is CN-ResCode.
|
| | | | companyPrefix | String | Conditionally required if the packagingCodeType is GTIN-14. A prefix is included in the packaging code and assigned by the GS1 organization. |
| | | | codeVersion | String | Conditionally required if the packagingItemCodeType is CN-ResCode. The product code version number (e.g. 81, 88). |
| | | | maxBatchSize | String | The maximum batch size that is acceptable for the product. Used only when the value of packagingUom is EACH. |
| | | | requiresAggregation | String | Specifies if each packagingUom requires serial numbers. Valid values: Aggregated – Each packagingUom requires serial numbers.NotAggregated – Not every packagingUom requires serial numbers.
|
| | | | 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 CN-ResCode. The packaging level associated with the packaging code type. Must be a numeric value between 1-9, where 1 is the innermost packaging level. |
| | | | 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 EACH. |
| | | | 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: SEQUENTIAL – Sequential serialization.RANDOM – Random serialization.NONE – No serialization.
|
| | | | 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 EACH. |
| | | | 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 EACH, this value should be 0. |
| | | | 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: CN-ResCode – This packaging code type is specific to China (must be 5 digits).GTIN-14 – (Global Trade Item Number) This packaging code type is accepted in any country (must be 14 digits).NTIN – (National Trade Item Number) This packaging code type is specific to a single country (must be 14 digits).
|
| | | | | 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. each, innerpack, case). |
| | | | isActive | Boolean | Required. Specifies if the packaging code data is active or inactive within TraceLink. Valid values: ACTIVE – The data can be used in messages and UI functions, and TraceLink pulls the data when necessary.INACTIVE – The data cannot be pulled for other functions within TraceLink.
|
| | | 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 AD – ANDORRAAE – UNITED ARAB EMIRATESAF – AFGHANISTANAG – ANTIGUA AND BARBUDAAI – ANGUILLAAL – ALBANIAAM – ARMENIAAN – NETHERLANDS ANTILLESAO – ANGOLAAQ – ANTARCTICAAR – ARGENTINAAS – AMERICAN SAMOAAT – AUSTRIAAU – AUSTRALIAAW – ARUBAAX – ÅLAND ISLANDSAZ – AZERBAIJANBA – BOSNIA AND HERZEGOVINABB – BARBADOSBD – BANGLADESHBE – BELGIUMBF – BURKINA FASOBG – BULGARIABH – BAHRAINBI – BURUNDIBJ – BENINBL – SAINT BARTHÉLEMYBM – BERMUDABN – BRUNEI DARUSSALAMBO – BOLIVIA, PLURINATIONAL STATE OFBR – BRAZILBS – BAHAMASBT – BHUTANBV – BOUVET ISLANDBW – BOTSWANABY – BELARUSBZ – BELIZECA – CANADA CC – COCOS (KEELING) ISLANDSCD – CONGO, THE DEMOCRATIC REPUBLIC OF THECF – CENTRAL AFRICAN REPUBLICCG – CONGOCH – SWITZERLANDCI – CÔTE D'IVOIRECK – COOK ISLANDSCL – CHILECM – CAMEROONCN – CHINACO – COLOMBIACR – COSTA RICACU – CUBACV – CAPE VERDECX – CHRISTMAS ISLANDCY – CYPRUSCZ – CZECH REPUBLICDE – GERMANYDJ – DJIBOUTIDK – DENMARKDM – DOMINICADO – DOMINICAN REPUBLICDZ – ALGERIAEC – ECUADOREE – ESTONIAEG – EGYPTEH – WESTERN SAHARAER – ERITREAES – SPAINET – ETHIOPIAFI – FINLANDFJ – FIJIFK – FALKLAND ISLANDS (MALVINAS)FM – MICRONESIA, FEDERATED STATES OFFO – FAROE ISLANDSFR – FRANCEGA – GABONGB – UNITED KINGDOMGD – GRENADAGE – GEORGIAGF – FRENCH GUIANAGG – GUERNSEYGH – GHANAGI – GIBRALTARGL – GREENLANDGM – GAMBIAGN – GUINEAGP – GUADELOUPEGQ – EQUATORIAL GUINEAGR – GREECEGS – SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDSGT – GUATEMALAGU – GUAMGW – GUINEA–BISSAUGY – GUYANAHK - HONG KONGHM – HEARD ISLAND AND MCDONALD ISLANDSHN – HONDURASHR – CROATIAHT – HAITIHU – HUNGARYID – INDONESIAIE – IRELANDIL – ISRAELIM – ISLE OF MANIN – INDIAIO – BRITISH INDIAN OCEAN TERRITORYIQ – IRAQIR – IRAN, ISLAMIC REPUBLIC OFIS – ICELANDIT – ITALYJE – JERSEYJM – JAMAICAJO – JORDANJP – JAPANKE – KENYAKG – KYRGYZSTANKH – CAMBODIAKI – KIRIBATIKM – COMOROSKN – SAINT KITTS AND NEVISKP – KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OFKR – KOREA, REPUBLIC OFKW – KUWAITKY – CAYMAN ISLANDSKZ – KAZAKHSTANLA – LAO PEOPLE'S DEMOCRATIC REPUBLICLB – LEBANONLC – SAINT LUCIALI – LIECHTENSTEINLK – SRI LANKALR – LIBERIALS – LESOTHOLT – LITHUANIALU – LUXEMBOURGLV – LATVIALY – LIBYAN ARAB JAMAHIRIYAMA – MOROCCOMC – MONACOMD – MOLDOVA, REPUBLIC OFME – MONTENEGROMF – SAINT MARTINMG – MADAGASCARMH – MARSHALL ISLANDSMK – MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OFML – MALIMM – MYANMARMN – MONGOLIAMO – MACAOMP – NORTHERN MARIANA ISLANDSMQ – MARTINIQUEMR – MAURITANIAMS – MONTSERRATMT – MALTAMU – MAURITIUSMV – MALDIVESMW – MALAWIÂ MX – MEXICOMY – MALAYSIAMZ – MOZAMBIQUENA – NAMIBIANC – NEW CALEDONIANE – NIGERNF – NORFOLK ISLANDNG – NIGERIANI – NICARAGUANL – NETHERLANDSNO – NORWAYNP – NEPALNR – NAURUNU – NIUENZ – NEW ZEALANDOM – OMANPA – PANAMAPE – PERUPF – FRENCH POLYNESIAPG – PAPUA NEW GUINEAPH – PHILIPPINESPK – PAKISTANPL – POLANDPM – SAINT PIERRE AND MIQUELONPN – PITCAIRNPR – PUERTO RICOPS – PALESTINIAN TERRITORY, OCCUPIEDPT – PORTUGALPW – PALAUPY – PARAGUAYQA – QATARRE – RÉUNIONRO – ROMANIARS – SERBIARU – RUSSIAN FEDERATIONRW – RWANDASA – SAUDI ARABIASB – SOLOMON ISLANDSSC – SEYCHELLESSD – SUDANSE – SWEDENSG – SINGAPORESH – SAINT HELENA, ASCENSION AND TRISTAN DA CUNHASI – SLOVENIASJ – SVALBARD AND JAN MAYENSK – SLOVAKIASL – SIERRA LEONESM – SAN MARINOSN – SENEGALSO – SOMALIASR – SURINAMEST – SAO TOME AND PRINCIPESV – EL SALVADORSY – SYRIAN ARAB REPUBLICSZ – SWAZILANDTC – TURKS AND CAICOS ISLANDSTD – CHADTF – FRENCH SOUTHERN TERRITORIESTG – TOGOTH – THAILANDTJ – TAJIKISTANTK – TOKELAUTL – TIMOR–LESTETM – TURKMENISTANTN – TUNISIATO – TONGATR – TURKEYTT – TRINIDAD AND TOBAGOTV – TUVALUTW – TAIWANTZ – TANZANIA, UNITED REPUBLIC OFUA – UKRAINEUG – UGANDAUM – UNITED STATES MINOR OUTLYING ISLANDSUS – UNITED STATESUY – URUGUAYUZ – UZBEKISTANVA – HOLY SEE (VATICAN CITY STATE)VC – SAINT VINCENT AND THE GRENADINESVE – VENEZUELA, BOLIVARIAN REPUBLIC OFVG – VIRGIN ISLANDS, BRITISHVI – VIRGIN ISLANDS, U.S.VN – VIET NAMVU – VANUATUWF – WALLIS AND FUTUNAWS – SAMOAXK – KOSOVOYE – YEMENYT – MAYOTTEZA – SOUTH AFRICAZM – ZAMBIAZW – ZIMBABWE
|
| | | | manufacturedBy | String | The manufacturer of the product as it appears on the product label. Valid values: CMO – Contract Manufacturing OrganizationMAH – Market Authorization Holder
|
| | | | manufacturedIdentifier | Object | The identifier of the manufacturer. |
| | | | | regulatoryCompanyIdentifierType | String | Required. The manufactured identifier type.  Valid values AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).IN_COMPANY_ID – India Company ID (e.g. 5423695784236).IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.IN_LOCATION_ID – India Location ID (e.g. 65874532).IN_MFR – India Manufacturing Code (e.g. 00552101).IN_MRCH – India Merchant Exporter Code (e.g. 601227644).IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.SGLN – 15-character SGLN format representation of Global Location Number:- Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
- Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
|
| | | | | 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 (.). There is no restriction on the number of places after the decimal point to support countries that may use three positions. Thousands separator must be omitted. If a unit price is entered and the country manufacturer is IN (India), the value must be a number from 0.50 – 9999999.99. |
| | | | currencyCode | String | Conditionally required if unitPrice is present. The currency code for the product's unit price in ISO 4217:2015 format. |
| | | | 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: IN_CONSIGNMENT – Consignments that contain products for export to countries that are eligible for exemption from India's bar-coding law.IN_MANUFACTURER – Products that need bar-coding for the import countries' bar-coding requirements, rather than the requirements in India.
|
| | | | 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 AR – ArabicBG – BulgarianCS – CzechDA – DanishDE – GermanEL – GreekEN – EnglishES – SpanishET – EstonianFI – FinnishFR – FrenchGA – Irish/GaelicHE – HebrewHR – CroatianHU – HungarianIS – IcelandicIT – ItalianJA – JapaneseKO – KoreanLB – LuxembourgishLV – LatvianLT – LithuanianMT – MalteseNL – DutchNO – NorwegianPL – PolishPT – PortugueseRO – RomanianRU – RussianSK – SlovakSL – SloveneSR – SerbianSV – SwedishTR – TurkishZH – Simplified Chinese
|
| | | | 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 AR_CUIT – 11-character Argentina Tax ID. Format is 00-00000000-0 (e.g. 33-56899856-8). Cannot be set as the Primary Identifier.AM_TIN – 8-character Armenia Taxpayer Identification Number (e.g. 53663456). Cannot be set as the Primary Identifier.BR_CNES – Brazil National Registry of Health Facilities Number (e.g. 3868249).BR_CNPJ – 14-character Brazil Tax/Legal Entity ID. Format is 00.000.000/0001-00 (e.g. 71.116.165/0001-71).BR_CPF – 11-character Brazil Individual Taxpayer Registration Number. Format is 000.000.000-00 (e.g. 605.085.153-00). The first 8 digits identify the company, the next 4 digits identify the branch or subsidiary ("0001" designates the headquarters), and the last 2 are check digits.BR_PROF_REG – Brazil Professional Registration Number (e.g. CRODFCD9952).BY_TIN – 9-character Belarus Taxpayer Identification Number (e.g. 004893223). Cannot be set as the Primary Identifier.CN_CHINA_ID – Alphanumeric China identifier (e.g. 352J685B548N).CN_FOREIGN_MAH – China Foreign MAH ID (e.g. 0678645).CN_FOREIGN_MFR – China Foreign Manufacturer ID (e.g. 665S55D).CN_USCID – China Unified Social Credit Identifier (e.g. 9771221453).COMPANYID – Alphanumeric internal company identifier (e.g. KENDALL).COMPANYSITEID – Alphanumeric internal location, plant, or site identifier (e.g. 465MEMPHIS).DE_IFA_REG_NUM – 6-character Informationsstelle für Arzneispezialitäten (IFA) Registration Number (e.g. 548726). Cannot be set as the Primary Identifier.DEA – 9-character US Drug Enforcement Agency Number (e.g. F92547851).DUNS – 9-character Dunn and Bradstreet Number (e.g. 82-759-6961).DUNS4 – 13-character Dunn and Bradstreet Number, which includes a 4 digit extension (e.g. 82-759-6961-KP89).GCP – 6- to 12-character GS1 Global Company Prefix (e.g. 8856277).GLN – 13-character Global Location Number (e.g. 8856277233311). To send and receive EPCIS messages, companies and locations need a GLN.HIN – Maximum 9-alphanumeric character Health Industry Number assigned by HIBCC (e.g. 214Z65H00).ID_BPOM_FACILITYID – Indonesia Facility ID (e.g. 45764574).IN_COMPANY_ID – India Company ID (e.g. 5423695784236).IN_GSTN – India Goods and Services Tax ID (e.g. 55876215).IN_IEC – 10-character India Importer Exporter Code (e.g. 0255411222). Cannot be set as the Primary Identifier.IN_LOCATION_ID – India Location ID (e.g. 65874532).IN_MFR – India Manufacturing Code (e.g. 00552101).IN_MRCH – India Merchant Exporter Code (e.g. 601227644).IN_PAN – 10-character India Permanent Account Number. The first five characters are letters, next four numbers, last character is a letter (e.g. AFZPK7190K). Cannot be set as the Primary Identifier.IN_TIN – 11-character India Taxpayer Identification Number (e.g. 95684444523). Cannot be set as the Primary Identifier.KG_TIN – 14-character Kyrgyzstan Taxpayer Identification Number (e.g. 56200044505998). Cannot be set as the Primary Identifier.KR_BUS_REG_NUMBER – 10-character South Korea Corporate Registration Number. Format is xxx-xx-xxxxx (e.g. 324-84-22451).KR_PROVIDER_CODE – 8-character South Korea Provider Code (e.g. 45632196).KZ_BIN – 12-character Kazakhstan Business Identification Number (e.g. 220110668755). Cannot be set as the Primary Identifier.RU_ACCOUNT_NUMBER – 14- to 36-character Russia Account Number (e.g. 19527400000001 or 19406412-0001-000a-0000-000000000022). Cannot be set as the Primary Identifier.RU_INN_FOREIGN_ENTITY – 10-character Russia Foreign Business Taxpayer Identification Number (e.g. 7744000912). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_INDIV – 12-character Russia Individual Taxpayer Identification Number (e.g. 123456789001). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.RU_INN_KPP_TAX_CODE – 9-character Russia KPP Registration Code (e.g. 771301001). Cannot be set as the Primary Identifier.RU_INN_LOCAL_ENTITY – 10-character Russia Local Business Taxpayer Identification Number (e.g. 7728640746). Cannot be set as the Primary Identifier. Only one of the following identifier types can be assigned to an entity: RU - INN Local, RU - IN Foreign, and RU - INN Individual.SGLN – 15-character SGLN format representation of Global Location Number:- Format for company entities is [CompanyPrefix].[LocationRef].0 or [CompanyPrefix]..0. The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment should always be the digit 0. For example, 539885451928..0 or urn:epc:id:sgln:0614141.12345.0.
- Format for location entities is [CompanyPrefix].[LocationRef].[sub-location identifier] or [CompanyPrefix]..[sub-location identifier].The LocationRef segment is optional. If the LocationRef is included, the first two segments contain only digits separated by the dot, and must be 13 characters in total. If the LocationRef is not included, then the first segment must be 12 digits, followed by two dot seperators. The third segment is always alphanumeric and can be any length, with at least one character in it preceded by the dot separator. For example, 8856277.23331.6 or 539885451928..11.
TRACELINK_ID – TraceLink Identification Number (e.g. KENDALLPHARM).UZ_TIN – 9-character Uzbekistan Taxpayer Identification Number (e.g. 000181244). Cannot be set as the Primary Identifier.
|
| | | | | 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 DEVICE, OTC, NUTRITION, or DERIVATIVE, the productLanguageCode entry must contain a value in the packSize field. |
| | | | 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 DEVICE, OTC, NUTRITION, or DERIVATIVE, the productLanguageCode entry must contain a value in the packSize field. |
| | | | 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 ADMINISTRATIONSYSTEM – Administration System.AMPOULE – AmpouleAPPLICATOR – ApplicatorAUTOMATICINJECTIONDEVICE – Automatic Injection Device.BAG – BagBALLINGGUN – Balling Gun.BARREL – BarrelBLISTER – BlisterBOTTLE – BottleBOX – BoxBRUSH – BrushBRUSHAPPLICATOR – Brush Applicator.CANNULA – CannulaCAP – CapCARTRIDGE – CartidgeCHILDRESISTANTCLOSURE – Child Resistant Closure.CONTAINER – ContainerCUP – CupDABBINGAPPLICATOR – Dabbing Applicator.DART – DartDREDGINGAPPLICATOR – Dredging Applicator.DREDGINGCONTAINER – Dredging Container.DRENCHGUN – Drench Gun.DROPPERAPPLICATOR – Dropper Applicator.DROPPERCONTAINER – Dropper Container.FIXEDCRYOGENICVESSEL – Fixed Cryogenic Vessel.GASCYLINDER – Gas Cylinder.IMPLANTER – ImplanterINHALER – InhalerINOVOINJECTIONDEVICE – Injection Needle Device.INJECTIONNEEDLE – Injection Needle.INJECTIONSYRINGE – Injection Syringe.INTERNALGRADUATEDCALIBRATIONCHAMBER – Internal Graduated Calibration Chamber.INTRAMAMMARYSYRINGE – Intramammary Syringe.JAR – JarMEASURINGDEVICE – Measuring Device.MEASURINGSPOON – Measuring Spoon.METERINGPUMP – Metering Pump.METERINGVALVE – Metering Valve.MOBILECRYOGENICVESSEL – Mobile Cryogenic Vessel.MOUTHPIECE – MouthpieceMULTIDOSECONTAINER – Multidose Container.MULTIDOSECONTAINERWITHAIRLESSPUMP – Multidose Container with Hairless Pump.MULTIDOSECONTAINERWITHMETERINGPUMP – Multidose Container with Metering Pump.MULTIDOSECONTAINERWITHPUMP – Multidose Container with Pump.MULTIPUNCTURER – MultipuncturerNASALAPPLICATOR – Nasal Applicator.NEBULISER – NebuliserNEEDLEAPPLICATOR – Needle Applicator.NEEDLEFREEINJECTOR – Needle Free Injector.NOZZLE – NozzleORALSYRINGE – Oral Syringe.PIPETTE – PipettePIPETTEAPPLICATOR – Pipette Applicator.POURONCONTAINER – Pour On Container.PREFILLEDGASTROENTERALTUBE – Prefilled Gastroenteral Tube.PREFILLEDPEN – Prefilled Pen.PREFILLEDSYRINGE – Prefilled Syringe.PRESSURISEDCONTAINER – Pressurised Container.PRICKTESTAPPLICATOR – Prick Test Applicator.ROLLONCONTAINER – Roll On Container.SACHET – SachetSCARIFIER – ScarifierSCREWCAP – Screw Cap.SINGLEDOSECONTAINER – Single Dose Container.SPATULA – SpatulaSPOTONAPPLICATOR – Spot On Applicator.SPRAYCONTAINER – Spray Container.SPRAYPUMP – Spray Pump.SPRAYVALVE – Spray Valve.STABVACCINATOR – Stab Vaccinator.STOPPER – StopperSTRAW – StrawSTRIP – StripTABLETCONTAINER – Tablet Container.TUBE – TubeVAGINALSPONGEAPPLICATOR – Vaginal Sponge Applicator.VIAL – Vial
|
| | | | 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 ADMINISTRATIONSYSTEM – Administration System.AMPOULE – AmpouleAPPLICATOR – ApplicatorAUTOMATICINJECTIONDEVICE – Automatic Injection Device.BAG – BagBALLINGGUN – Balling Gun.BARREL – BarrelBLISTER – BlisterBOTTLE – BottleBOX – BoxBRUSH – BrushBRUSHAPPLICATOR – Brush Applicator.CANNULA – CannulaCAP – CapCARTRIDGE – CartidgeCHILDRESISTANTCLOSURE – Child Resistant Closure.CONTAINER – ContainerCUP – CupDABBINGAPPLICATOR – Dabbing Applicator.DART – DartDREDGINGAPPLICATOR – Dredging Applicator.DREDGINGCONTAINER – Dredging Container.DRENCHGUN – Drench Gun.DROPPERAPPLICATOR – Dropper Applicator.DROPPERCONTAINER – Dropper Container.FIXEDCRYOGENICVESSEL – Fixed Cryogenic Vessel.GASCYLINDER – Gas Cylinder.IMPLANTER – ImplanterINHALER – InhalerINOVOINJECTIONDEVICE – Injection Needle Device.INJECTIONNEEDLE – Injection Needle.INJECTIONSYRINGE – Injection Syringe.INTERNALGRADUATEDCALIBRATIONCHAMBER – Internal Graduated Calibration Chamber.INTRAMAMMARYSYRINGE – Intramammary Syringe.JAR – JarMEASURINGDEVICE – Measuring Device.MEASURINGSPOON – Measuring Spoon.METERINGPUMP – Metering Pump.METERINGVALVE – Metering Valve.MOBILECRYOGENICVESSEL – Mobile Cryogenic Vessel.MOUTHPIECE – MouthpieceMULTIDOSECONTAINER – Multidose Container.MULTIDOSECONTAINERWITHAIRLESSPUMP – Multidose Container with Hairless Pump.MULTIDOSECONTAINERWITHMETERINGPUMP – Multidose Container with Metering Pump.MULTIDOSECONTAINERWITHPUMP – Multidose Container with Pump.MULTIPUNCTURER – MultipuncturerNASALAPPLICATOR – Nasal Applicator.NEBULISER – NebuliserNEEDLEAPPLICATOR – Needle Applicator.NEEDLEFREEINJECTOR – Needle Free Injector.NOZZLE – NozzleORALSYRINGE – Oral Syringe.PIPETTE – PipettePIPETTEAPPLICATOR – Pipette Applicator.POURONCONTAINER – Pour On Container.PREFILLEDGASTROENTERALTUBE – Prefilled Gastroenteral Tube.PREFILLEDPEN – Prefilled Pen.PREFILLEDSYRINGE – Prefilled Syringe.PRESSURISEDCONTAINER – Pressurised Container.PRICKTESTAPPLICATOR – Prick Test Applicator.ROLLONCONTAINER – Roll On Container.SACHET – SachetSCARIFIER – ScarifierSCREWCAP – Screw Cap.SINGLEDOSECONTAINER – Single Dose Container.SPATULA – SpatulaSPOTONAPPLICATOR – Spot On Applicator.SPRAYCONTAINER – Spray Container.SPRAYPUMP – Spray Pump.SPRAYVALVE – Spray Valve.STABVACCINATOR – Stab Vaccinator.STOPPER – StopperSTRAW – StrawSTRIP – StripTABLETCONTAINER – Tablet Container.TUBE – TubeVAGINALSPONGEAPPLICATOR – Vaginal Sponge Applicator.VIAL – Vial
|
| | | | dosageForm | String | The dosage form of the product (e.g. tablet, capsule). If the targetMarketCountry is the US and the productType is not DEVICE, OTC, NUTRITION, or DERIVATIVE, the productLanguageCode entry must contain a value in the dosageForm field. |
| | | | 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). |
| | | | 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: Yes – Exposure to light can compromise the product's quality and safety.No – Exposure to light does not compromise the product's quality and safety.
|
| | | | 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: Days – The shelf-life value is provided in days.Months – The shelf-life value is provided in months.Years – The shelf-life value is provided in years.
|
| | | | 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: true – The identifier is the primary item code.false – (default) The identifier is not the primary item code.
|
| | | | 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 Internal_Material_Code. |
| | | | | 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 AT_PZN – Austria PZN code. Format is Country ID (2) + Sector (4) + PZN (6) + Check Digit (1) (e.g. 9088884762098).BE_ABP_CODE – 16-character Belgium ABP code. Format is APB (7) + Sequential Number (8) + Check Digit (1) (e.g. 5502892699183494).BG_NATIONAL_NUMBER – 1- to 20-alphanumeric character Bulgaria National Drug Code (e.g. 9900211).BR_ANVISA_REGISTRATION – 13-character Brazil ANVISA Drug Registration code (e.g. 1.1111.1111.1123).CA_DIN – 8-character Canada DIN code (e.g. 50051934).CH_SWISSMEDIC – Switzerland Swissmedic code. Format is 7680 + Code assigned by Swissmedic (consists of 5 digits Product License number + 3 digits Pack Size indicator) + check digit (e.g. 7680718523780).CN_NDC – 1- to 20-alphanumeric character China National Drug Code (e.g. 02351000201).CN_STANDARD – 1- to 20-alphanumeric character China Drug Standard Code (e.g. 3003310000999).CN_SUBTYPE – 10-character China Subtype code. Format is Product Code (7) + 3 Digits (e.g. 1008721001).DE_PPN – 12-character Germany PPN code (e.g. 111234567842).DE_PZN – 8-character Germany PZN code. Format is PZN (7) + Check Digit (1) (e.g. 12345678).EAN13 – 13-character International Article Number. Format is Country ID (2) + Sector (2) + Product ID (5) + Packaging Code (3) + Check Digit (1) (e.g. 2348856277129).ES_CODIGO_NATIONAL – Spain Codigo National code. Format is 84 7000 + CN (6) + Check Digit (1) (e.g. 8470001874925).FDA_NDC_11 – 11-or 13-character US normalized National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (2) (e.g. 60573-4112-01). May have hyphen separators at positions 5-4-2. This value is used in all EPCIS header elements instead of US_NDC542.FR_CIP13 – France CIP13 code. Format is Prefix 3400 + CIP/ACL (8) + Check Digit (1) (e.g. 3400750000210).GR_EOFCODE – Greece EOF code (e.g. 829709833).HR_NATIONAL_CODE – Croatia National code. Format is ATC (Generic) Code (7) + Product (SKU) ID (3) (e.g. 3297443232).IN_PRODUCT_CODE – 8- to 12-character India product code. Format is Manufacturer Code + Product Code (e.g. 694832700711).INTERNAL_MATERIAL_CODE – Internal Material Number (e.g. 3257458).IT_BOLLINO – Italy Bollino code (e.g. 829709833).KR_KFDA_CODE – 13-character Korea KFDA code (e.g. 1825060903760).LU_NATIONAL_NUMBER – Luxembourg National Number (e.g. 25668974).NL_KNMP_CODE – Netherlands KNMP code. Format is KNMP (7) + Check Digit (1) (e.g. 91757154).NRD_VNR_CODE – Nordic countries VNR code (e.g. 025553).PT_AIM – Portugal AIM number (e.g. 9279188).SA_SAUDI_DRUG_CODE – 10-character Saudi Arabia alphanumeric Drug Code (e.g. SFDA17D224).SUKL – Czech Republic State Institute for Drug Control Code (e.g. 24148725).UK_AMPP – United Kingdom National Drug Code (e.g. 235145692).US_NDC442 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (4) + Product Code (4) + Packaging Code (2) (e.g. 0003-7597-01). May have hyphen separators at positions 4-4-2.US_NDC532 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (5) + Product Code (3) + Packaging Code (2) (e.g. 50232-040-62). May have hyphen separators at positions 5-3-2.US_NDC541 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (1) (e.g. 60573-4112-1). May have hyphen separators at positions 5-4-1.US_NDC542 – 11-or 13-character US normalized National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (2) (e.g. 60573-4112-01). May have hyphen separators at positions 5-4-2. This value is used in all TraceLink extension elements instead of FDA_NDC_11.
|
| | | | lscRegulatoryItemCodeIdentifier | Array | Required. The item code identifier of the product in TTS. |
| | | | isActive | Boolean | Specifies if the identifier is active. Valid values: ACTIVE – The identifier can be used in messages and UI functions, and TraceLink pulls the data when necessary.INACTIVE – The identifier cannot be pulled for other functions within TraceLink.
|
| | | | 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: true – The identifier is the primary item code.false – (default) The identifier is not the primary item code.
|
| | | | 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 AT_PZN – Austria PZN code. Format is Country ID (2) + Sector (4) + PZN (6) + Check Digit (1) (e.g. 9088884762098).BE_ABP_CODE – 16-character Belgium ABP code. Format is APB (7) + Sequential Number (8) + Check Digit (1) (e.g. 5502892699183494).BG_NATIONAL_NUMBER – 1- to 20-alphanumeric character Bulgaria National Drug Code (e.g. 9900211).BR_ANVISA_REGISTRATION – 13-character Brazil ANVISA Drug Registration code (e.g. 1.1111.1111.1123).CA_DIN – 8-character Canada DIN code (e.g. 50051934).CH_SWISSMEDIC – Switzerland Swissmedic code. Format is 7680 + Code assigned by Swissmedic (consists of 5 digits Product License number + 3 digits Pack Size indicator) + check digit (e.g. 7680718523780).CN_NDC – 1- to 20-alphanumeric character China National Drug Code (e.g. 02351000201).CN_STANDARD – 1- to 20-alphanumeric character China Drug Standard Code (e.g. 3003310000999).CN_SUBTYPE – 10-character China Subtype code. Format is Product Code (7) + 3 Digits (e.g. 1008721001).DE_PPN – 12-character Germany PPN code (e.g. 111234567842).DE_PZN – 8-character Germany PZN code. Format is PZN (7) + Check Digit (1) (e.g. 12345678).EAN13 – 13-character International Article Number. Format is Country ID (2) + Sector (2) + Product ID (5) + Packaging Code (3) + Check Digit (1) (e.g. 2348856277129).ES_CODIGO_NATIONAL – Spain Codigo National code. Format is 84 7000 + CN (6) + Check Digit (1) (e.g. 8470001874925).FDA_NDC_11 – 11-or 13-character US normalized National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (2) (e.g. 60573-4112-01). May have hyphen separators at positions 5-4-2. This value is used in all EPCIS header elements instead of US_NDC542.FR_CIP13 – France CIP13 code. Format is Prefix 3400 + CIP/ACL (8) + Check Digit (1) (e.g. 3400750000210).GR_EOFCODE – Greece EOF code (e.g. 829709833).HR_NATIONAL_CODE – Croatia National code. Format is ATC (Generic) Code (7) + Product (SKU) ID (3) (e.g. 3297443232).IN_PRODUCT_CODE – 8- to 12-character India product code. Format is Manufacturer Code + Product Code (e.g. 694832700711).INTERNAL_MATERIAL_CODE – Internal Material Number (e.g. 3257458).IT_BOLLINO – Italy Bollino code (e.g. 829709833).KR_KFDA_CODE – 13-character Korea KFDA code (e.g. 1825060903760).LU_NATIONAL_NUMBER – Luxembourg National Number (e.g. 25668974).NL_KNMP_CODE – Netherlands KNMP code. Format is KNMP (7) + Check Digit (1) (e.g. 91757154).NRD_VNR_CODE – Nordic countries VNR code (e.g. 025553).PT_AIM – Portugal AIM number (e.g. 9279188).SA_SAUDI_DRUG_CODE – 10-character Saudi Arabia alphanumeric Drug Code (e.g. SFDA17D224).SUKL – Czech Republic State Institute for Drug Control Code (e.g. 24148725).UK_AMPP – United Kingdom National Drug Code (e.g. 235145692).US_NDC442 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (4) + Product Code (4) + Packaging Code (2) (e.g. 0003-7597-01). May have hyphen separators at positions 4-4-2.US_NDC532 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (5) + Product Code (3) + Packaging Code (2) (e.g. 50232-040-62). May have hyphen separators at positions 5-3-2.US_NDC541 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (1) (e.g. 60573-4112-1). May have hyphen separators at positions 5-4-1.US_NDC542 – 11-or 13-character US normalized National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (2) (e.g. 60573-4112-01). May have hyphen separators at positions 5-4-2. This value is used in all TraceLink extension elements instead of FDA_NDC_11.
|
| | | | 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 AT_PZN – Austria PZN code. Format is Country ID (2) + Sector (4) + PZN (6) + Check Digit (1) (e.g. 9088884762098).BE_ABP_CODE – 16-character Belgium ABP code. Format is APB (7) + Sequential Number (8) + Check Digit (1) (e.g. 5502892699183494).BG_NATIONAL_NUMBER – 1- to 20-alphanumeric character Bulgaria National Drug Code (e.g. 9900211).BR_ANVISA_REGISTRATION – 13-character Brazil ANVISA Drug Registration code (e.g. 1.1111.1111.1123).CA_DIN – 8-character Canada DIN code (e.g. 50051934).CH_SWISSMEDIC – Switzerland Swissmedic code. Format is 7680 + Code assigned by Swissmedic (consists of 5 digits Product License number + 3 digits Pack Size indicator) + check digit (e.g. 7680718523780).CN_NDC – 1- to 20-alphanumeric character China National Drug Code (e.g. 02351000201).CN_STANDARD – 1- to 20-alphanumeric character China Drug Standard Code (e.g. 3003310000999).CN_SUBTYPE – 10-character China Subtype code. Format is Product Code (7) + 3 Digits (e.g. 1008721001).DE_PPN – 12-character Germany PPN code (e.g. 111234567842).DE_PZN – 8-character Germany PZN code. Format is PZN (7) + Check Digit (1) (e.g. 12345678).EAN13 – 13-character International Article Number. Format is Country ID (2) + Sector (2) + Product ID (5) + Packaging Code (3) + Check Digit (1) (e.g. 2348856277129).ES_CODIGO_NATIONAL – Spain Codigo National code. Format is 84 7000 + CN (6) + Check Digit (1) (e.g. 8470001874925).FDA_NDC_11 – 11-or 13-character US normalized National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (2) (e.g. 60573-4112-01). May have hyphen separators at positions 5-4-2. This value is used in all EPCIS header elements instead of US_NDC542.FR_CIP13 – France CIP13 code. Format is Prefix 3400 + CIP/ACL (8) + Check Digit (1) (e.g. 3400750000210).GR_EOFCODE – Greece EOF code (e.g. 829709833).HR_NATIONAL_CODE – Croatia National code. Format is ATC (Generic) Code (7) + Product (SKU) ID (3) (e.g. 3297443232).IN_PRODUCT_CODE – 8- to 12-character India product code. Format is Manufacturer Code + Product Code (e.g. 694832700711).INTERNAL_MATERIAL_CODE – Internal Material Number (e.g. 3257458).IT_BOLLINO – Italy Bollino code (e.g. 829709833).KR_KFDA_CODE – 13-character Korea KFDA code (e.g. 1825060903760).LU_NATIONAL_NUMBER – Luxembourg National Number (e.g. 25668974).NL_KNMP_CODE – Netherlands KNMP code. Format is KNMP (7) + Check Digit (1) (e.g. 91757154).NRD_VNR_CODE – Nordic countries VNR code (e.g. 025553).PT_AIM – Portugal AIM number (e.g. 9279188).SA_SAUDI_DRUG_CODE – 10-character Saudi Arabia alphanumeric Drug Code (e.g. SFDA17D224).SUKL – Czech Republic State Institute for Drug Control Code (e.g. 24148725).UK_AMPP – United Kingdom National Drug Code (e.g. 235145692).US_NDC442 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (4) + Product Code (4) + Packaging Code (2) (e.g. 0003-7597-01). May have hyphen separators at positions 4-4-2.US_NDC532 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (5) + Product Code (3) + Packaging Code (2) (e.g. 50232-040-62). May have hyphen separators at positions 5-3-2.US_NDC541 – 10- or 12-character US National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (1) (e.g. 60573-4112-1). May have hyphen separators at positions 5-4-1.US_NDC542 – 11-or 13-character US normalized National Drug Code. Format is FDA Labeler Code (5) + Product Code (4) + Packaging Code (2) (e.g. 60573-4112-01). May have hyphen separators at positions 5-4-2. This value is used in all TraceLink extension elements instead of FDA_NDC_11.
|
| | | | lscRegulatoryItemCodeIdentifier | Array | Required. The item code identifier of the product in TTS. |
| | | | isActive | Boolean | Specifies if the identifier is active. Valid values: ACTIVE – The identifier can be used in messages and UI functions, and TraceLink pulls the data when necessary.INACTIVE – The identifier cannot be pulled for other functions within TraceLink.
|
| | | packagingInformationDerivedField | String | The result of the query when ftsInfo | value equals index-packagingInformationDerivedField:[searchString] in the request. For example, GTIN-14 packagingCodeValue3. This includes the following fields: - packagingCodeType
- packagingCodeValue
|
| | | packagingInformationAndRegulatoryItemCodesDerivedField | String | The result of the query when ftsInfo | value equals index-regulatoryItemCodesDerivedField:[searchString] in the request. For example, US_NDC542 regulatoryItemCodeValue. This includes the following fields: - regulatoryItemCodeType
- regulatoryItemCodeValue
|
| | | regulatoryItemCodesDerivedField | String | The result of the query when ftsInfo | value equals index-packagingInformationAndRegulatoryItemCodesDerivedField:[searchString] in the request. For example, GTIN_14 packagingCodeValue3. This includes the following fields: - regulatoryItemCodeType
- regulatoryItemCodeValue
- packagingCodeType
- packagingCodeValue
|
| | 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. |