Skip to main content

FutureLink Barcelona (6-8 October) is now open for registration. Sign up today!

Close

Amadeus

AI
Home
Clear Search
User Log In
  • Tracelink Classic
    TraceLink Classic app.tracelink.com
    Redirect
  • Opus Platform
    Opus Platform opus.tracelink.com
    Redirect
  • Supply Chain Orchestrations
    Left fast
    Supply Chain Orchestrations
    • Life Sciences Company

      Life Sciences Company

      Life sciences companies face distinct challenges in orchestrating supply chains with partners. TraceLink specializes in addressing and overcoming these challenges.
      Learn More
      Left fast
      Life Sciences Company
      • Orchestrating the supply chain
        • Life Sciences Company
        • Direct Material Supplier
        • Contract Manufacturer
        • Third Party Logistics
        • Wholesale Distributor
        • Healthcare Provider
        • Retail Pharmacy

      Related Content

      Learn More
      Life Sciences

      Products

      Explore products for life sciences companies.

      Learn More
      Life Sciences

      Resources

      Discover valuable insights and industry trends.

    • Direct Material Supplier

      Direct Material Supplier

      Direct material suppliers face unique challenges in supply chain coordination. TraceLink provides specialized solutions to address and overcome these issues.
      Learn More
      Left fast
      Direct Material Supplier
      • Orchestrating the supply chain
        • Direct Material Supplier
        • Life Sciences Company
        • Contract Manufacturer
        • Third Party Logistics
        • Wholesale Distributor

      Related Content

      Learn More
      Direct Material Supplier

      Products

      Explore products for direct material suppliers.

      Learn More
      Direct Material Supplier

      Resources

      Dive into a world of expert resources and cutting-edge industry knowledge.

    • Contract Manufacturer

      Contract Manufacturer

      Contract manufacturing organizations grapple with distinct supply chain complexities. TraceLink delivers innovative solutions to tackle and streamline these challenges.
      Learn More
      Left fast
      Contract Manufacturer
      • Orchestrating the supply chain
        • Contract Manufacturers
        • Life Sciences Company
        • Direct Material Supplier
        • Third Party Logistics

      Related Content

      Learn More
      Contract Manufacturer

      Products

      Explore products for contract manufacturers and contract packagers.

      Learn More
      Contract Manufacturer

      Resources

      Get insights and industry trends for contract manufacturers and packagers.

    • Third Party Logistics

      Third Party Logistics

      Third party logistics providers face unique challenges in managing intricate supply chains. TraceLink offers strategic solutions to effectively address these complexities.
      Learn More
      Left fast
      Third Party Logistics
      • Orchestrating the supply chain
        • Third Party Logistics
        • Life Sciences Company
        • Contract Manufacturer
        • Wholesale Distributor

      Related Content

      Learn More
      Third Party Logistics

      Products

      Browse our range of products for third party logistics providers.

      Learn More
      Third Party Logistics

      Resources

      Step into our resource hub for the latest in innovation and industry expertise.

    • Wholesale Distributor

      Wholesale Distributor

      Wholesale distributors navigate complex challenges in supply chain management. TraceLink provides advanced solutions to efficiently tackle these issues.
      Learn More
      Left fast
      Wholesale Distributor
      • Orchestrating the supply chain
        • Wholesale Distributor
        • Life Sciences Company
        • Healthcare Provider
        • Retail Pharmacy

      Related Content

      Learn More
      Wholesale Distributor

      Products

      Browse our range of products for wholesale distributors.

      Learn More
      Wholesale Distributor

      Resources

      Navigate the future of industry trends with our wholesale distributor resource center.

    • Healthcare Provider

      Healthcare Provider

      TraceLink provides specific solutions to help healthcare providers confront distinct challenges, including managing drug shortages and recalls in their supply chains.
      Learn More
      Left fast
      Healthcare Provider
      • Orchestrating the supply chain
        • Healthcare Provider
        • Life Sciences Company
        • Wholesale Distributor

      Related Content

      Learn More
      Healthcare Provider

      Products

      View our product portfolio for healthcare providers.

      Learn More
      Healthcare Provider

      Resources

      Explore our comprehensive collection of resources for healthcare providers.

    • Retail Pharmacy

      Retail Pharmacy

      Retail pharmacies combat supply chain complexities, including regulatory compliance. TraceLink enhances efficiency and adherence.
      Learn More
      Left fast
      Retail Pharmacy
      • Orchestrating the supply chain
        • Retail Pharmacy
        • Life Sciences Company
        • Wholesale Distributor

      Related Content

      Learn More
      Retail Pharmacy

      Products

      Experience our advanced product lineup for retail pharmacies.

      Learn More
      Retail Pharmacy

      Resources

      Delve into our rich library of resources for retail pharmacies.

  • Network
    Left fast
    Network
    The Advantage of Integrate Once
    The TraceLink Network
    Network

    Explore how a single connection to the TraceLink network can transform your operations, streamline your supply chain processes, and bring unparalleled value to your organization.

    Learn More

    Menu Divider

    • Tracelink Icon The Power of the Platform
    • Tracelink Icon OPUS Solution Environment
    • Tracelink Icon Link Actions
    • Tracelink Icon Reports and Dashboards
    • Tracelink Icon Master Data Exchange
    • Tracelink Icon Message Center
  • Products
    Left fast
    Products
    • Partner Orchestration

      Partner Orchestration

      Transform partner collaboration and rapidly connect with all your partners for enhanced control while reducing risks and costs to improve supply chain visibility and customer delivery performance.
      View All Products
      Left fast
      Partner Orchestration
      • Multienterprise Information Network Tower
        • MINT for External Manufacturing
        • MINT for Serialized Shipments and Receipts
        • MINT for Direct Supply
        • MINT for Logistics
        • MINT for Commerce
        • MINT for Transportation

      Related Content

      Learn More
      Blog

      Accelerate Clinical-Phase Commercialization Through Supply Chain Digitalization

      Discover four essential steps to accelerate clinical-phase commercialization through end-to-end supply chain digitalization.

      Watch Now
      Video

      Cold Chain Excellence with AI and Digital Innovation

      Learn how to elevate your cold chain strategy through digitalization, patient-centric innovation, and AI-driven insights. Discover approaches to improve visibility and reduce risk.

    • Product Orchestration

      Product Orchestration Products

      Meet regulatory requirements around the globe and improve operational efficiency with our suite of Product Orchestration solutions, tailored for comprehensive compliance and streamlined supply chain management.
      View All Products
      Left fast
      Product Orchestration
      • Serialization
        • Serial Number Exchange
        • Serial Number Manager
        • Serialized Operations Manager
        • Smart Event Manager
      • Smart Inventory Tracker
      • Targeted Recalls
      • Product Information Manager
        • Targeted Recalls Notification
        • Product Verification
        • Master Data Sharing
      • Country Compliance
        • US Drug Supply Chain Security Act
        • European Union Falsified Medicines Directive
        • Kazakhstan Pharmaceuticals
        • Kyrgyzstan Pharmaceuticals
        • See All Countries
      • Crypto Code
        • Russia Crypto Code

      Related Content

      Learn More
      Deadline Approaching

      DSCSA

      Comply with U.S. DSCSA requirements.

      Watch Now
      Video

      Locate Recalled Product in Minutes

      See how TraceLink helps you pinpoint which locations received recalled product so you can retrieve it in minutes.

    • Process Orchestration

      Process Orchestration Products

      Streamline your supply chain with Process Orchestration, facilitating seamless collaboration on recalls, change requests, document reviews, compliance exception management, and more.
      View All Products
      Left fast
      Process Orchestration
      • Supply Chain Work Management
        • SCWM for Compliance Exceptions
        • SCWM for Incidents
        • SCWM for Change Requests
        • SCWM for Tasks
        • SCWM for Document Reviews

      Related Content

      Learn More
      Resources

      Supply Chain Collaboration

      Browse insights on how to improve end-to-end supply chain collaboration.

      Learn More
      Supply Chain Excellence Award

      2025 BSMA Supply Chain Management Innovation Award

      Gain insights into award-winning supply chain innovation—TraceLink wins the 2025 BSMA Supply Chain Management Innovation Award for its MINT solution.

    • Orchestration Intelligence

      Orchestration Intelligence Products

      Empower your supply chain decisions with Orchestration Intelligence, harnessing AI, machine learning, and the collective power of the TraceLink network for robust data-driven solutions.
      VIEW ALL PRODUCTS
      Left fast
      Orchestration Intelligence
      • Serialized Product Intelligence
      • Reports and Dashboards

      Related Content

      Learn More
      Reports and Dashboards

      Real-Time Insights with OPUS Reports & Dashboards

      TraceLink Releases OPUS Reports & Dashboards, the first end-user solution designed for real-time visibility into supply networks.

      Learn More
      Blog

      Explore the Top 10 Insights from LogiPharma 2025

      Discover how industry leaders at LogiPharma 2025 are transforming collaboration. Gain actionable strategies to drive business value across complex, global networks.

    • Network Platform-Enabling Products

      Network Platform-Enabling Products

      A comprehensive suite of solutions designed to empower users with advanced administration, communication, data management, and customization capabilities, coupled with services to extend the value of the platform.
      View All Products
      Left fast
      Network Platform-Enabling Products
      • OPUS Administer
      • OPUS Solution Environment
      • Link Actions
      • Master Data Exchange
      • Message Center
      • Automated Validation Manager
      • Healthcare Operational Services Team
      • Technical Account Management Services
  • Resources
    Left fast
    Resources
    • Resource Center

      Resource Center

      Explore our Resource Center for a wealth of knowledge, including videos, solution briefs, blogs, eBooks, and more, offering insights on TraceLink solutions, industry trends, and emerging topics.
      View All Resources
      Left fast
      Resource Center
      • By Segment
        • Life Sciences Company Life Sciences Company
        • Direct Material Supplier Direct Material Supplier
        • Contract Manufacturer Contract Manufacturer
        • Third Party Logistics Third Party Logistics
        • Wholesale Distributor Wholesale Distributor
        • Healthcare Provider Healthcare Provider
        • Retail Pharmacy Retail Pharmacy
      • By Type
        • Webinar Webinar
        • Blog Blog
        • Case Study Case Study
        • EBook EBook
        • Infographic Infographic
        • Podcast Podcast
        • Solution Brief Solution Brief
        • Video Video
        • Whitepaper Whitepaper
    • TraceLink University

      TraceLink University

      Enhance your expertise with TraceLink University: dive into a range of online and instructor-led courses, engaging tech talks, and certification programs designed to elevate your knowledge.
      Explore All
      Left fast
      TraceLink University
      • By Persona
        • Solution Designer Solution Designer
        • Tracelink Administrator Tracelink Administrator
        • User User
        • Orchestration Architect Orchestration Architect
        • Solution Partner Solution Partner
        • Technology Partner Technology Partner
      • By Orchestration
        • Manufacturing Manufacturing
        • Logistics Logistics
        • Commerce Commerce
        • Transportation Transportation
        • Clinical Supply Clinical Supply

      Related Content

      Learn More
      Subscriptions

      TraceLink University

      Ongoing education at your own pace.

      Watch Now
      FutureLink

      Experience FutureLink

      Watch FutureLink Barcelona sessions on demand.

    • Partners

      Partners

      We partner with leaders from across the globe, with an intense focus on partner companies that specialize in implementation, solution consulting, and application development.
      Partner Overview
      Left fast
      Partners
      • Tracelink Icon View Our Partners
      • Tracelink Icon Become a Partner
      • Tracelink Icon Access PartnerLink
    • Community

      Community

      Join our global community, uniting members across the supply chain to share insights and engage in discussions through virtual meetings and collaborative workshops.
      Learn More
      Left fast
      Community
      • Global Compliance Special Interest Group
      • Multienterprise Information Network Tower Innovation Forum
      • U.S. DSCSA Innovation Forum for Manufacturers and Distributors
      • U.S. DSCSA Dispenser Innovation Forum
    • Events

      Events

      Stay updated with our Events calendar: from industry conferences we attend to exclusive events we host and informative webinars, join us in shaping the future of supply chain management.
      View All Events
      Left fast
      Events
      • Tracelink Icon Industry Events
      • Tracelink Icon Webinars
      • Tracelink Icon TraceLink Events

      Related Content

      Register Now
      FutureLink

      FutureLink Barcelona 2025

      Join the movement shaping the future of supply chains. FutureLink is the must-attend event for Industry leaders.

      Register Now
      Paris Seminar

      Intelligent Orchestration of Your End-to-End Supply Chain

      Explore how intelligent orchestration enhances resilience, agility, and performance on June 11 in Paris.

    • Customers

      Customers

      Meet a selection of our valued customers: discover how diverse businesses are leveraging TraceLink's solutions to transform their supply chains.
      View Our Customers
      Left fast
      Customers
      • Success Stories
        • Santen Santen
        • Merck Merck
        • Patheon Patheon
        • Sentara Sentara
        • Merz Therapeutics Merz Therapeutics
  • About
    Left fast
    About
    • Tracelink Icon Our Story
    • Tracelink Icon Newsroom
    • Tracelink Icon Culture and Careers
    • Tracelink Icon Leadership
    • Tracelink Icon Our Values
    • Tracelink Icon Corporate Social Responsibility

    Menu Divider

    Related Content

    Awards and Recognitions

    Celebrating our impact

    We are honored and proud of the acknowledgment and industry recognition we have received.

    Innovation Award

    Supply Chain Orchestration Company of the Year 2025

    Discover how TraceLink is transforming supply chain orchestration—named Supply Chain Orchestration Company of the Year 2025 by Logistics Tech Outlook Magazine.

  • CONTACT US
  • User Log In
    • Tracelink Classic
      TraceLink Classic app.tracelink.com
      Redirect
    • Opus Platform
      Opus Platform opus.tracelink.com
      Redirect
Close
CONTACT US
Tracelink University

Breadcrumb

  1. Home
  2. Resources
  3. TraceLink University

Identifier APIs

  • Download PDF
  • Share
    • LinkedIn
    • Facebook
    • Mail
    • Twitter

Table of contents

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

Add Identifiers to Master Data

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

ClosedAdd Identifiers to Master Data request

Guidelines

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

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

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

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

  masterDataObjectType Enumeration

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

Valid values:

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

Required. The information for the identifiers to add.

      identifierType String

Required. The type of the identifier.

ClosedValid 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.
      identifierValue String Required. The identifier value.
      isPrimary Boolean

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

Example

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

Guidelines

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

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

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

Conditionally required if the call is unsuccessful. The message associated with the error code.

  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception returned for the request, if applicable.

Valid values:

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

Example

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

Errors

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

The object does not exist.

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

The identifiers do not pass the validation criteria.

identifierValue and identifierType

Identifier already exists for identifierType. Identifier [] already exists in Company or Partner master data.

The identifier already exists in company or Partner master data.

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

Review TraceLink's API: Terms of Use

Edit Identifiers in Master Data

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

ClosedEdit Identifiers in Master Data request

Guidelines

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

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

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

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

  masterDataObjectType Enumeration

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

Valid values:

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

Required. The type of the identifier.

ClosedValid 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.
    identifierValue String Required. The identifier value.
    isPrimary Boolean

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

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

Valid values:

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

Required. The type of the identifier.

ClosedValid 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.
      identifierValue String Required. The identifier value.
      isPrimary Boolean

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

Example

{
                        "header": {
                        "headerVersion": 1,
                        "eventName": "placeholder",
                        "ownerId": "placeholder",
                        "isErr": placeholder,
                        "errCode": "placeholder",
                        "licensePlate": "placeholder"
                        },
                        "payload": {
                        "userId": "placeholder",
                        "aptUserPreferenceId": "placeholder"
                        }
                    }
ClosedEdit Identifiers in Master Data response

Guidelines

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

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

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

Conditionally required if the call is unsuccessful. The message associated with the error code.

  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception returned for the request, if applicable.

Valid values:

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

Example

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

Errors

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

The object does not exist.

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

The identifiers do not pass the validation criteria.

oldIdentifier

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

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

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

Review TraceLink's API: Terms of Use

Remove Identifiers from Master Data

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

ClosedRemove Identifiers from Master Data request

Guidelines

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

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

Valid values:

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

Required. The type of the identifier.

ClosedValid 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.
    identifierValue String Required. The identifier value.
    isPrimary Boolean

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

Example

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

Guidelines

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

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

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

Conditionally required if the call is unsuccessful. The message associated with the error code.

  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception returned for the request, if applicable.

Valid values:

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

Example

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

Errors

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

The object does not exist.

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

Identifier is primary identifierType. Identifiers[x] identifier [] is the primary identifier.

The identifier is the primary identifier.

identifiers

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

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

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

Review TraceLink's API: Terms of Use

Table of contents

Related Content
Related content
Batch Creation (IDoc)
CMOs use batch creation records to communicate the details of a specific lot of product they produced to the Pharmaceutical Manufacturer that contracted them to manufacture it.
View More
Related content
Forecast Plan (IDoc)
Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream and downstream supply chain Partners without giving these Partners access to their serialization system of record.
View More
Related content
Forecast Plan (X12)
Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream and downstream supply chain Partners without giving these Partners access to their serialization system of record.
View More

Cookie Settings

When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies or similar tracking technologies. Please see below for an overview of the categories of cookies and similar technologies used on this site. You can allow or deny some of all of them, except Strictly Necessary Cookies which are required to provide the site to you. However, blocking some types of cookies may impact your experience of the site and services we are able to offer.

Please see our Cookie Policy for more details, including a list of the cookies we use. You can change your consent options at any time by following the “Cookie Settings” link in the Cookie Policy.
'Strictly Necessary' cookies let you move around the Site and use essential features like secure areas, shopping baskets and online billing. Without these cookies you would not be able to navigate between pages or use certain vital features of our Site, so we do not require your consent for their use. These cookies don't gather any information about you that could be used for marketing or remembering where you've been on the internet. For example, we use these Strictly Necessary cookies to identify you as being logged in to the Site. You can set your browser to block or alert you about these cookies, but if you do so, some parts of the Site will not work.
'Performance' cookies collect information about how you use the Site, such as which pages you visit, the time spent on the Site and if you experience any errors. We use performance cookies to provide aggregated statistics on how the Site is used and help us improve the Site including by measuring any errors that occur.
'Functional' cookies are used to provide services or to remember settings to improve your visit. We use 'Functionality' cookies to remember your settings and choices and show you when you're logged in to the Site.
‘Targeting' cookies are linked to services provided by third parties, such as 'Like' buttons and 'Share' buttons. The third party provides these services in return for recognizing that you have visited the Site. We also use 'Targeting' cookies to gather information that could be used to display content that we think may interest you.
Home

Footer

  • Quick Links
    Get a Demo
    Fast Facts
    The Network
    OPUS Platform
    Technical Support
    Open Jobs
    API: Terms of Use
  • Products
    Multienterprise Information Network Tower
    U.S. DSCSA Compliance
    Targeted Recalls
    Supply Chain Work Management
    Serialization
    Global Compliance
  • Resources
    Resource Center
    Events
    TraceLink University
    Partners
    Customers
    Community
  • About TraceLink
    Our Story
    Newsroom
    Culture & Careers
    Leadership
    Our Values
    Corporate Social Responsibility
  • Hot Topics
    Supply Chain Visibility
    DSCSA Compliance
    Supply Chain Collaboration
    Kazakhstan Compliance for Pharmaceuticals
    Kyrgyzstan Compliance for Pharmaceuticals
Follow Us on Social
Facebook
Linkedin
X
Legal & Trust.
© TraceLink Inc. 2009-2025 All Rights Reserved
Contact Us Today
Contact us today to digitalize your end-to-end supply chain for streamlined orchestration.
Contact Us
Stay Up-to-Date
Subscribe to receive industry insights and stay at the forefront of evolving trends.
Subscribe