Batch creation APIs

Batch creation records allow CMOs to exchange data with their Pharmaceutical Manufacturer Partners about specific lots of product they produce for the Pharmaceutical Manufacturer. Batch creation records contain the details for a lot of product (e.g. lot number, lot status, expiration date, and production date).

Type = API Reference,; Topic = Multienterprise Information Network Tower (MINT), Transforms,;Persona = Solution Partner,; Orchestration = Manufacturing,; Function = IT,

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.

Contact your TraceLink Services representative for more information about integrating with this message.

  • Message Type: MPC_BATCH_MASTER (Batch Creation)
  • IDoc Format: BATMAS03
  • Transform Names:
    • B2B_IDoc_BATMAS_BATMAS03_BatchMaster_IB_V2
    • B2B_IDoc_BATMAS_BATMAS03_BatchMaster_OB_V1
Input Element Occurs Length Description Example
BATMAS03 [1…1]
 – Required. XML IDoc DESADV root element. –
  IDOC [1…1]
 – Required. IDoc root. –
    @BEGIN [1…1]
 0/* Required. Begin of message attribute. 1
    EDI_DC40 [1…1]
 – Required. IDoc control record. –
      @SEGMENT [1…1]
 0/* Required. Begin of segment attribute. 1
      TABNAM [0…1]
 0/* IDoc table name. EDI_DC40
      MANDT [0…1]
 0/3 Client. 300
      DOCNUM [0…1]
 0/16 IDoc number. 0000000000619827
      DOCREL [0…1]
 0/4 IDoc release number. 720
      STATUS [0…1]
 0/* Current IDoc processing status. 03
      DIRECT [0…1]
 0/* Direction. 1
      OUTMOD [0…1]
 0/1 Output mode. 2
      EXPRSS [0…1]
 0/1 Overriding in inbound processing. –
      TEST [0…1]
 0/1 Test flag. –
      IDOCTYP [0…1]
 0/30 IDoc basic type. BATMAS03
      CIMTYP [0…1]
 0/* Name of extension type.  
      MESTYP [0…1]
 0/* Logical message type. BATMAS
      MESCOD [0…1]
 0/3 Logical message code. –
      MESFCT [0…1]
 0/3 Logical message function. –
      STD [0…1]
 0/1 EDI standard. –
      STDVRS [0…1]
 0/6 Version of EDI standard. –
      STDMES [0…1]
 0/6 EDI message type. –
      SNDPOR [1…1]
 0/10 Required. Sender port (SAP System, EDI subsystem). SAPD11
      SNDPRT [1…1]
 0/2 Required. Partner type of sender. LS
      SNDPFC [0…1]
 0/2 Partner function of sender.  
      SNDPRN [0…1]
 0/10 Partner number of sender. ERPCLNT302
      SNDSAD [0…1]
 0/21 Sender address (SADR).  
      SNDLAD [0…1]
 0/70

Logical address of sender mapping to fileSenderNumber. Require a value that concatenates party type with party identifier in party type format.

  • AM_TIN – Armenia Taxpayer Identification Number.
  • AR_CUIT – Argentina Tax ID.
  • BR_CNES – Brazil National Registry of Health Facilities Number.
  • BR_CNPJ – Brazil Tax or Legal Entity ID.
  • BR_CPF – Brazil Individual Taxpayer Registration Number.
  • BR_PROF_REG – Brazil Professional Registration Number.
  • BY_TIN – Belarus Taxpayer Identification Number.
  • CN_CHINA_ID – China identifier (alphanumeric).
  • CN_FOREIGN_MAH – China Foreign MAH ID.
  • CN_FOREIGN_MFR – China Foreign Manufacturer ID.
  • CN_USCID – China Unified Social Credit Identifier.
  • DE_IFA_REG_NUM – Informationsstelle für Arzneispezialitäten (IFA) Registration Number.
  • DEA – US Drug Enforcement Agency Number.
  • DUNS – Dunn and Bradstreet Number.
  • DUNS4 – Dunn and Bradstreet Number with 4 digit extension.
  • GCP – GS1 Global Company Prefix.
  • GLN – Global Location Number.
  • HIN – Health Industry Number assigned by HIBCC.
  • ID_BPOM_FACILITYID – Indonesia BPOM facility Identifier.
  • IN_COMPANY_ID – India Company ID.
  • IN_GSTN – India Goods and Services Tax ID.
  • IN_IEC – India Importer Exporter Code.
  • IN_LOCATION_ID – India Location ID.
  • IN_MFR – India Manufacturing Code.
  • IN_MRCH – India Merchant Exporter Code.
  • IN_PAN – India Permanent Account Number.
  • IN_TIN – India Taxpayer Identification Number.
  • KG_TIN – Kyrgyzstan Taxpayer Identification Number.
  • KR_BUS_REG_NUMBER – South Korea Corporate Registration Number.
  • KR_PROVIDER_CODE – South Korea Provider Code.
  • KZ_BIN – Kazakhstan Business Identification Number.
  • RU_ACCOUNT_NUMBER – Russia Account Number.
  • RU_INN_FOREIGN_ENTITY – Russia Foreign Business Taxpayer Identification Number.
  • RU_INN_INDIV – Russia Individual Taxpayer Identification Number.
  • RU_INN_KPP_TAX_CODE – Russia KPP Registration Code.
  • RU_INN_LOCAL_ENTITY – Russia Local Business Taxpayer Identification Number.
  • SGLN – SGLN format representation of Global Location Number.
  • TRACELINK_ID – TraceLink Identification Number.
  • UZ_TIN – Uzbekistan Taxpayer Identification Number

 0010136941923
      RCVPOR [1…1]
 0/10 Required. SAP receiver port. TRACELINK
      RCVPRT [0…1]
 0/2 Partner type of receiver. LS
      RCVPFC [0…1]
 0/2 Partner function of receiver. LS
      RCVPRN [0…1]
 0/10 Partner number of receiver. TRACELINK
      RCVSAD [0…1]
 0/21 Receiver address (SADR).  
      RCVLAD [0…1]
 0/70

Logical address of receiver. Required for TraceLink. Identifies the receiver of the IDoc for the TraceLink system. 's location ID. Must match the value that the IDoc sender has configured for their receiver partner in TraceLink.

  • AM_TIN – Armenia Taxpayer Identification Number.
  • AR_CUIT – Argentina Tax ID.
  • BR_CNES – Brazil National Registry of Health Facilities Number.
  • BR_CNPJ – Brazil Tax or Legal Entity ID.
  • BR_CPF – Brazil Individual Taxpayer Registration Number.
  • BR_PROF_REG – Brazil Professional Registration Number.
  • BY_TIN – Belarus Taxpayer Identification Number.
  • CN_CHINA_ID – China identifier (alphanumeric).
  • CN_FOREIGN_MAH – China Foreign MAH ID.
  • CN_FOREIGN_MFR – China Foreign Manufacturer ID.
  • CN_USCID – China Unified Social Credit Identifier.
  • DE_IFA_REG_NUM – Informationsstelle für Arzneispezialitäten (IFA) Registration Number.
  • DEA – US Drug Enforcement Agency Number.
  • DUNS – Dunn and Bradstreet Number.
  • DUNS4 – Dunn and Bradstreet Number with 4 digit extension.
  • GCP – GS1 Global Company Prefix.
  • GLN – Global Location Number.
  • HIN – Health Industry Number assigned by HIBCC.
  • ID_BPOM_FACILITYID – Indonesia BPOM facility Identifier.
  • IN_COMPANY_ID – India Company ID.
  • IN_GSTN – India Goods and Services Tax ID.
  • IN_IEC – India Importer Exporter Code.
  • IN_LOCATION_ID – India Location ID.
  • IN_MFR – India Manufacturing Code.
  • IN_MRCH – India Merchant Exporter Code.
  • IN_PAN – India Permanent Account Number.
  • IN_TIN – India Taxpayer Identification Number.
  • KG_TIN – Kyrgyzstan Taxpayer Identification Number.
  • KR_BUS_REG_NUMBER – South Korea Corporate Registration Number.
  • KR_PROVIDER_CODE – South Korea Provider Code.
  • KZ_BIN – Kazakhstan Business Identification Number.
  • RU_ACCOUNT_NUMBER – Russia Account Number.
  • RU_INN_FOREIGN_ENTITY – Russia Foreign Business Taxpayer Identification Number.
  • RU_INN_INDIV – Russia Individual Taxpayer Identification Number.
  • RU_INN_KPP_TAX_CODE – Russia KPP Registration Code.
  • RU_INN_LOCAL_ENTITY – Russia Local Business Taxpayer Identification Number.
  • SGLN – SGLN format representation of Global Location Number.
  • TRACELINK_ID – TraceLink Identification Number.
  • UZ_TIN – Uzbekistan Taxpayer Identification Number
 3333331013655
      CREDAT [0…1]
 8/8 Date IDoc was created in format YYYYMMDD. 20230511
      CRETIM [0…1]
 6/6 Time IDoc was created in format HHMMSS. 161000
      REFINT [0…1]
 0/14 Reference to interchange file. –
      REFGRP [0…1]
 0/14 Reference to message group. –
      REFMES [0…1]
 0/14 Reference to message. –
      ARCKEY [0…1]
 0/70 EDI archive key. –
      SERIAL [0…1]
 0/20 EDI/ALE: Serialization field. –
      DOCNUM [0…1]
 0/16 IDoc number mapping to required JSon header key attribute "id". 0000000000619827
    E1BATMAS [1…1]
 – Required. Batch master header segment. –
      @SEGMENT [1…1]
 0/* Required. Begin of segment attribute. 1
      MATERIAL [0…1]
 0/18 Product code for batch master. PH-4100
      BATCH [0…1]
 0/10 Lot or batch identifier. 0000000632
      PLANT [0…1]
 0/4 Plant identifier. 4123
      BATCHSTORAGELOCATION [0…1]
 0/4 Storage location for batch or lot. 5682
      MATERIAL_LONG [0…1]
 0/40 Alternate identifier for product code - long identifier. 0000000098756410076453
      E1BPBATCHATT [0…1]
 – Batch attributes BAPI transfer structure. –
        @SEGMENT [1…1]
 0/* Required. Begin of segment attribute. 1
        AVAILABLE [0…1]
 0/8 Availability date for lot in date format YYYYMMDD. 20240226
        EXPIRYDATE [0…1]
 0/8 Shelf-life expiration or best before date for lot in date format YYYYMMDD. 20240226
        STATUSKEY [0…1]
 0/1 Batch or lot status key. 1
        VENDOR_NO [0…1]
 0/10 Supplier/vendor identifier. 0000458678
        VENDRBATCH [0…1]
 0/15 Supplier lot or batch number. X3542Z1756r8juf
        VAL_TYPE [0…1]
 0/10 Valuation type. 1
        LASTGRDATE [0…1]
 0/8 Date of last goods receipt in date format YYYYMMDD. 20240226
        FREE_DATE1 [0…1]
 0/8 Free date instance 1 in date format YYYYMMDD. 20240226
        FREE_DATE2 [0…1]
 0/8 Free date instance 2 in date format YYYYMMDD. 20240226
        FREE_DATE3 [0…1]
 0/8 Free date instance 3 in date format YYYYMMDD. 20240226
        FREE_DATE4 [0…1]
 0/8 Free date instance 4 in date format YYYYMMDD. 20240226
        FREE_DATE5 [0…1]
 0/8 Free date instance 5 in date format YYYYMMDD. 20240226
        FREE_DATE6 [0…1]
 0/8 Free date instance 6 in date format YYYYMMDD. 20240226
        COUNTRYORI [0…1]
 0/3 Country of origin. US
        COUNTRYORI_ISO [0…1]
 0/2 Country of origin ISO code. US
        REGIONORIG [0…1]
 0/3 Region of origin. CA
        EXPIMPGRP [0…1]
 0/4 Material group export for foreign trade.  
        NEXTINSPEC [0…1]
 0/8 Next inspection date in date format YYYYMMDD. 20240226
        PROD_DATE [0…1]
 0/8 Production or manufacturing date in date format YYYYMMDD. 20240226
        DEL_FLAG [0…1]
 0/1 Deletion flag. –
        STK_SEGMENT [0…1]
 0/16 Stock segment. –
      E1BPBATCHATTX [0…1]
 – Checkbox structure for batch attributes - not mapped IB. –
        @SEGMENT [1…1]
 0/* Required. Begin of segment attribute. 1
        AVAILABLE [0…1]
 0/1 Updated information in related user data field for availability date. X
        EXPIRYDATE [0…1]
 0/1 Updated information in related user data field for expiration date. X
        STATUSKEY [0…1]
 0/1 Updated information in related user data field for lot status key. X
        VENDOR_NO [0…1]
 0/1 Updated information in related user data field for supplier identifier. X
        VENDRBATCH [0…1]
 0/1 Updated information in related user data field for supplier lot. X
        VAL_TYPE [0…1]
 0/1 Updated information in related user data field for valuation type. X
        LASTGRDATE [0…1]
 0/1 Updated information in related user data field for date of last goods receipt. X
        FREE_DATE1 [0…1]
 0/1 Updated information in related user data field for free date 1. X
        FREE_DATE2 [0…1]
 0/1 Updated information in related user data field for free date 2. X
        FREE_DATE3 [0…1]
 0/1 Updated information in related user data field for free date 3. X
        FREE_DATE4 [0…1]
 0/1 Updated information in related user data field for free date 4. X
        FREE_DATE5 [0…1]
 0/1 Updated information in related user data field for free date 5. X
        FREE_DATE6 [0…1]
 0/1 Updated information in related user data field for free date 6. X
        COUNTRYORI [0…1]
 0/1 Updated information in related user data field for country of origin. X
        COUNTRYORI_ISO [0…1]
 0/1 Updated information in related user data field for country of origin ISO code. X
        REGIONORIG [0…1]
 0/1 Updated information in related user data field for region of origin. X
        EXPIMPGRP [0…1]
 0/1 Updated information in related user data field for for material export group. X
        NEXTINSPEC [0…1]
 0/1 Updated information in related user data field for next inspection date. X
        PROD_DATE [0…1]
 0/1 Updated information in related user data field for production date. X
        DEL_FLAG [0…1]
 0/1 Updated information in related user data field for deletion flag. X
        STK_SEGMENT [0…1]
 0/1 Updated information in related user data field for stock segment. X
      E1BPBATCHSTATUS [0…1]
 – Checkbox structure for batch status. –
        @SEGMENT [1…1]
 0/* Required. Begin of segment attribute. 1
        RESTRICTED [0…1]
 0/1 Batch in restricted use stock. X
      E1BPBATCHSTATUSX [0…1]
 – Checkbox structure for batch status. –
        @SEGMENT [1…1]
 0/* Required. Begin of segment attribute. 1
        RESTRICTED [0…1]
 0/1 Batch in restricted use stock. X
      E1BPBATCHCTRL [0…1]
 – Batch or lot check parameters. –
        @SEGMENT [1…1]
 0/* Required. Begin of segment attribute. 1
        BATCHLEVEL [0…1]
 0/1 Definition of batch or lot management level indicator. 1
        CLASS_NUM [0…1]
 0/18 Class number. –
        DOCLASSIFY [0…1]
 0/1 Classify object. –
        CALLCFC_CL [0…1]
 0/1 Extended classification via CFC. –
        ORG_SYS_OF_BATCH [0…1]
 0/10 Original system for batch or lot distribution. –
        SND_SYS_OF_BATCH [0…1]
 0/10 Sending system for batch or lot distribution. –
        NO_CFC_CALLS [0…1]
 0/1 Suppress calls to user exits. –
        NOCOMMIT [0…1]
 0/1 COMMIT control of BAPI interface. –
      E1BPBNCOM [0…1]
 – Batch or lot check parameters. –
        @SEGMENT [1…1]
 0/* Required. Begin of segment attribute. 1
        VENDOR_NO [0…1]
 0/10 Vendor identifier. 1
        VENDRBATCH [0…1]
 0/15 Vendor batch identifier. –
        PURCH_ORG [0…1]
 0/4 Purchasing organization. –
        SALES_ORD [0…1]
 0/10 Supplier's sales order number. –
        S_ORD_ITEM [0…1]
 0/6 Supplier sales order line item number. –
        PO_NUMBER [0…1]
 0/10 Purchase order number mapping to BATCHMASTER transaction type. 4500020001
        PO_ITEM [0…1]
 0/5 Purchase order line item number mapping to BATCHMASTER transaction type. –
        PO_NUMBER [0…1]
 0/10 Purchase order number mapping to PURCHASEORDER. 4500020001
        PO_ITEM [0…1]
 0/5 Purchase order line item number mapping to PURCHASEORDER. –
        ORDERID [0…1]
 0/10 Production order number. –
        ORDER_ITNO [0…1]
 0/4 Production order line item number. –
Copy 
<BATMAS03>
    <IDOC BEGIN="1">
        <EDI_DC40 SEGMENT="1">
            <TABNAM>EDI_DC40</TABNAM>
            <MANDT>CLT</MANDT>
            <DOCNUM>filecontrol</DOCNUM>
            <DOCREL>DocR</DOCREL>
            <DIRECT>2</DIRECT>
            <TEST>X</TEST>
            <IDOCTYP>BATMAS03</IDOCTYP>
            <MESCOD>777</MESCOD>
            <MESFCT>MFC</MESFCT>
            <STD>s</STD>
            <STDVRS>s8</STDVRS>
            <STDMES>s9</STDMES>
            <SNDPOR>sdSysPort</SNDPOR>
            <SNDPRT>PC</SNDPRT>
            <SNDPFC>PF</SNDPFC>
            <SNDPRN>s55</SNDPRN>
            <SNDLAD>GLN:4929474111400</SNDLAD>
            <RCVPOR>recvPort</RCVPOR>
            <RCVPRN>s56</RCVPRN>
            <RCVLAD>GLN:5236323992387</RCVLAD>
            <CREDAT>20240101</CREDAT>
            <CRETIM>123122</CRETIM>
            <REFINT>intControlID</REFINT>
            <REFGRP>grpCtlID</REFGRP>
            <REFMES>transControlID</REFMES>
            <ARCKEY>archiveReferenceIdentifier</ARCKEY>
            <SERIAL>serializationSeq</SERIAL>
        </EDI_DC40>
        <E1BATMAS SEGMENT="1">
            <MATERIAL>productCode</MATERIAL>
            <BATCH>lotNumber</BATCH>
            <PLANT>PLT1</PLANT>
            <BATCHSTORAGELOCATION>LOC9</BATCHSTORAGELOCATION>
            <MATERIAL_LONG>productCodeAlternate</MATERIAL_LONG>
            <E1BPBATCHATT SEGMENT="1">
                <AVAILABLE>20231210</AVAILABLE>
                <EXPIRYDATE>20301231</EXPIRYDATE>
                <STATUSKEY>1</STATUSKEY>
                <VENDOR_NO>supplierID</VENDOR_NO>
                <VENDRBATCH>supplierLotNum</VENDRBATCH>
                <VAL_TYPE>valType</VAL_TYPE>
                <LASTGRDATE>20240103</LASTGRDATE>
                <FREE_DATE1>20231001</FREE_DATE1>
                <FREE_DATE2>20240301</FREE_DATE2>
                <FREE_DATE3>20231210</FREE_DATE3>
                <FREE_DATE4>20240228</FREE_DATE4>
                <FREE_DATE5>20240131</FREE_DATE5>
                <FREE_DATE6 />
                <COUNTRYORI>US</COUNTRYORI>
                <COUNTRYORI_ISO>JP</COUNTRYORI_ISO>
                <REGIONORIG>MA</REGIONORIG>
                <NEXTINSPEC>00000000</NEXTINSPEC>
                <PROD_DATE>20231104</PROD_DATE>
                <DEL_FLAG />
            </E1BPBATCHATT>
            <E1BPBATCHSTATUS SEGMENT="1">
                <RESTRICTED>R</RESTRICTED>
            </E1BPBATCHSTATUS>
            <E1BPBATCHCTRL SEGMENT="1">
                <BATCHLEVEL>7</BATCHLEVEL>
                <DOCLASSIFY>X</DOCLASSIFY>
            </E1BPBATCHCTRL>
            <E1BPBNCOM>
                <ORDERID>OR-4562</ORDERID>
                <ORDER_ITNO>0051</ORDER_ITNO>
            </E1BPBNCOM>
        </E1BATMAS>
    </IDOC>
</BATMAS03>

Tag end