Type = Technical Guides, Technical Tools, What's New,; Topic = Multienterprise Information Network Tower (MINT), Technical Documentation,;Persona = Solution Designer, TraceLink Administrator, User, Orchestration Architect, Solution Partner, Technology Partner,; Orchestration = Manufacturing, Logistics, Commerce, Transportation, Clinical Supply,; Function = IT, Quality, Procurement,

Order status report canonical guidelines

Order Status Report, is a key communication tool used to improve visibility and coordination across the supply chain. It allows suppliers or CMOs to provide timely and structured updates to their customers or MAHs regarding the current status of open purchase orders. These updates may include confirmations that the order has been received, processed, shipped, delayed, or partially fulfilled.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping    
canonicalOrderStatusReport – Object type/root element. – – –    
  canonicalControlFileHeader – Canonical control file header to store data for control segments of IDocs and TL XML transactions, and EDI envelopes for X12 and EDIFACT. – – –    
  canonicalOrderStatusReportHeader – Payload for purchase order acknowledgment canonical. segment E1EDK01 – –    
    processingFunctionTypeCode string

Purpose of purchase order. Tells receiving system function of purchase.

Valid values include:

  • CHANGE - Changes to order header

  • CHANGESTOHEADERANDITEMS - Changes to header and items

  • CHANGESTOITEMS - Changes to one or more items

  • NONE - No particular action is required

  • REVERSE - Reverse entire document

ACTION =

  • 000 (NONE) or

  • 001 (REVERSE) or

  • 002 (CHANGE) or

  • 003 (CHANGESTOITEMS) or

  • 004 (CHANGESTOHEADERANDITEMS)

BSR11 =

  • 00 (ORIGINAL) or

  • 01 (CANCEL) or

  • 02 (CREATE) or

  • 03 (DELETE) or

  • 04 (CHANGE) or

  • 05 (REPLACE) or

  • 06 (CONFIRM) or

  • CO (CORRECTION)

BGM030 = -

  • 1 (CANCEL) or

  • 2 (CREATE) or

  • 3 (DELETE) or

  • 4 (CHANGE) or

  • 5 (REPLACE) or

  • 6 (CONFIRM) or

  • 9 (ORIGINAL)

    
    orderStatusReportType string

Code identifying the reason for the order status report message.

Valid values include:

  • INQUIRYRESPONSE

  • SCHEDULED

  • UNSOLICITED

  • REQUISITIONRESPONSE

  • DIRECTVENDORDELIVERY

  • REQUIREMENTFORECAST

 –

BSR01 =

  • 1 (INQUIRYRESPONSE) or

  • 2 (SCHEDULED) or

  • 3 (UNSOLICITED) or

  • 4 (REQUISITIONRESPONSE) or

  • 5 (DIRECTVENDORDELIVERY) or

  • 6 (SUPPLYASSISTANCE) or

  • 7 (MATERIALRETURNS) or

  • 8 (AVAILABILITY) or

  • 9 (REQUIRMENTFORECAST) or

  • 10 (REVISEDFORECASTSTOCK) or

  • 11 (REVISEDFORECASTTRANSACTION) or

  • 12 (REVISEDDELIVERYFORECAST)

BGM010-010 = 231 (PURCHASEORDERRESPONSE) ??????    
    orderItemReportType string

Order item report code type identifies a group of purchase orders and items.

Valid values includes:

  • ALLORDERSCHANGEDITEMS

  • ALLORDERSALLITEMS

  • SELECTEDORDERSALLITEMS

  • SHIPPEDORDERS

  • UNSHIPPEDORDERS

-

BSR02 =

  • AO (ALLORDERSCHANGEDITEMS) or

  • CA (ALLORDERSALLITEMS) or

  • CI (SHIPPEDITEMS) or

  • CO (UNSHIPPEDITEMS) or

  • PA (SELECTEDORDERSALLITEMS) or

  • PI (SHIPPEDORDERS) or

  • PO (UNSHIPPEDORDERS) or

  • PP (SELECTEDORDERSSELECTEDITEMS)

-    
    transactionReferenceIdentifierList [1] - Instance 1 of transaction reference for order status message transaction identifier type for display on GUI and in search screens. segment E1EDK01 segment BSR segment BGM    
      b2bTransactionIdentifierType string

Referenced document type.

The valid values include:- ORDERSTATUSREPORT (required).

 – – BGM010-010 = 348 where b2bTransactionIdentifierType = ORDERSTATUSREPORT    
      b2bTransactionIdentifierValue string Reference order identifier value. BELNR where b2bTransactionIdentifierType = ORDERSTATUSREPORT BSR03 where b2bTransactionIdentifierType = ORDERSTATUSREPORT BGM020-010 where b2bTransactionIdentifierType = ORDERSTATUSREPORT    
      b2bTransactionIdentifierTypeName string Line item number in customer purchase order. Line item level only. – – –    
      transactionDate date Date transaction created in date format YYYY-MM-DD. – BSR04 –    
      lineItemNumber string Time order created. – – –    
      epochTransactionDate integer Date order created in epoch date format. – – –    
      timeZone string Time zone for referenced time, if present. – HL04 –    
    transactionReferenceIdentifierList [2] array Instance 2 transaction reference list for other relevant document types that may be present in message at header level. segment E1EDK02 segment REF segment RFF    
      b2bTransactionIdentifierType string

Referenced document type.

Valid values include:

  • PURCHASEORDER

  • DELIVERY

  • SUPPLIERORDER

  • DOCUMENT

  • CUSTOMERCONTRACT

QUALF

REF01 =

  • BC (CUSTOMERCONTRACT) or

  • CT (CONTRACT) or

  • DM (DOCUMENT) or

  • PO (PURCHASEORDER) or

  • VC (SUPPLIERCONTRACT) or

  • VN (SUPPLIERORDER)

RFF010-010 =

  • BC (CUSTOMERCONTRACT) or

  • C(CONTRACT) or

  • DM (DOCUMENT) or

  • OP (PURCHASEORDER) or

  • VC (SUPPLIERCONTRACT) or

  • VN (SUPPLIERORDER)

    
      b2bTransactionIdentifierValue string Reference order identifier value. BELNR REF02 RFF010-020    
      b2bTransactionIdentifierTypeName string Line item number in customer purchase order. Line item level only. – – –    
      transactionDate date Date transaction created in date format YYYY-MM-DD. DATUM UZEIT (if present) – –    
      lineItemNumber string Time order created. – – –    
      epochTransactionDate integer Date order created. – – –    
      timeZone string Time zone for referenced time, if present. – HL04 –    
    mpcDates array Reference dates at header level. segment E1EDK03 segment DTM segment DTM    
      dateType string

referenced date type.

Valid values include:

  • PROMISEDFORSHIPMENT

  • DELIVERY

  • PURCHASEORDER

E1EDK03/IDDAT DTM01 = 079 (PROMISEDFORSHIPMENT)

DTM010-10

   
      dateValue date Date and or date time as defined by referenced date type.in string date format YYYYY-MM-DD or string date time format YYYY-MM-DDTHH:MM:SS.nnnZ. DATUM UZEIT (if present) DTM02 DTM03 (if present) DTM010-20    
      timeZone string Time zone for referenced dates. – – DTM010-30    
      epochDateValue integer Date time defined by referenced date type. – – –    
    mpcCurrency array Currency codes for purchase order. segment E1EDK01 – segment CUX    
      currencyCode string Currency code for pricing in price catalog. E1EDK01/CURCY – CUX010-20    
      exchangeRateCurrencyCode string Exchange rate for conversion from currencyCode to currencyCodeExchange. – – –    
      exchangeRate string Exchange rate for conversion from currencyCode to currencyCodeExchange. E1EDK01/WKURS – CUX030    
      epochValidityDate number Epoch Validity date. – – –    
      currencyEntityCode string Currency Entity code. – – –    
      validityDate string Validity date for exchange rate. – – –    
    customerBusinessInformation – Customer business party types, identifiers and address information. Segment E1EDKA1 PARVW = AG Segment loop N1 N101 = BY Segment loop NAD NAD01= BY    
      companyLocationPartnerName string Customer business partner name. – – –    
      businessName string Business name for partner or location. NAME1 N102 NAD030-010    
      mpcCompanyLocationIdentifierList array Identifier list for business party. Segment E1EDKA1 Segment N1 –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 2 (SCAC) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN) or

  • PI (US_340B_ID) or

  • PP (PHARMACY_PROCESSOR_NUMBER)

NAD020-030 =

  • 9 (GLN) or

  • 16 (DUNS) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID)

  • 164 (DEA) or

  • 237 (HIN)

   
        companyIdentifierValue string Company identifier value for business partner. PARTN N104 NAD020-010    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –    
      address – Customer business party address information. Segment E1EDKA1 – –    
        address1 string Main street address. STRAS N301 NAD050-010    
        address2 string Supplemental street address. STRS2 N302 NAD050-020    
        city string City ORT01 N401 NAD060    
        district string District – – –    
        state string State or region code REGIO N402 NAD070-010    
        postalCode string Postal code PSTLZ N403 NAD080    
        country string Country code LAND1 N404 NAD090    
        telephone string Telephone number TELF1 – –    
        fax string Fax number TELFX – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building. – – –    
        lscAddressIdentifier string LSC address identifier. – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Customer business party contact information. – – –    
        contactName string Contact name – – –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – – –    
        contactEmail string Contact email address – – –    
    shipToLocationInformation – Ship to location party types, identifiers and address information. Segment E1EDKA1 PARVW = WE N101 = ST Segment loop NAD NAD01= ST    
      companyLocationPartnerName string Ship To business partner name. – – –    
      businessName string Business name for partner or location. NAME1 N102 NAD030-010    
      mpcCompanyLocationIdentifierList array Identifier list for business party. Segment E1EDKA1 – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 2 (SCAC) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN) or

  • PI (US_340B_ID) or

  • PP (PHARMACY_PROCESSOR_NUMBER)

NAD020-030 =

  • 9 (GLN) or

  • 6 (DUNS) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID)

  • 64 (DEA) or

  • 237 (HIN)

   
        companyIdentifierValue string Company identifier value for business partner. PARTN N104 NAD020-010    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –    
      address – Ship To business party address information. Segment E1EDKA1 – –    
        address1 string Main street address. STRAS N301 NAD050-010    
        address2 string Supplemental street address. STRS2 N302 NAD050-020    
        city string City ORT01 N401 NAD060    
        district string District – – –    
        state string State or region code REGIO N402 NAD070-010    
        postalCode string Postal code PSTLZ N403 NAD080    
        country string Country code LAND1 N404 NAD090    
        telephone string Telephone number TELF1 – –    
        fax string Fax number TELFX – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building – – –    
        lscAddressIdentifier string LSC address identifier – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Ship To business party contact information. – – –    
        contactName string Contact name – – –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – – –    
        contactEmail string Contact email address – – –    
    supplierBusinessInformation – Supplier business party types, identifiers and address information. Segment E1EDKA1 PARVW = LF N101 = SU Segment loop NAD NAD01= SU    
      companyLocationPartnerName string Supplier business partner name. – – –    
      businessName string Business name for partner or location. NAME1 N102 NAD030-010    
      mpcCompanyLocationIdentifierList array Identifier list for business party. Segment E1EDKA1 – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 2 (SCAC) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN) or

  • PI (US_340B_ID) or

  • PP (PHARMACY_PROCESSOR_NUMBER)

NAD020-030 =

  • 9 (GLN) or

  • 16 (DUNS) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID)

  • 164 (DEA) or

  • 237 (HIN)

   
        companyIdentifierValue string Company identifier value for business partner. PARTN N104 NAD020-010    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –    
      address – Supplier business party address information. Segment E1EDKA1 – –    
        address1 string Main street address. STRAS N301 NAD050-010    
        address2 string Supplemental street address. STRS2 N302 NAD050-020    
        city string City ORT01 N401 NAD060    
        district string District – – –    
        state string State or region code REGIO N402 NAD070-010    
        postalCode string Postal code PSTLZ N403 NAD080    
        country string Country code LAND1 N404 NAD090    
        telephone string Telephone number TELF1 – –    
        fax string Fax number TELFX – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building – – –    
        lscAddressIdentifier string LSC address identifier – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Supplier business party contact information. – – –    
        contactName string Contact name – – –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – – –    
        contactEmail string Contact email address – – –    
    manufacturerBusinessInformation – Manufacturing business party types, identifiers and address information. – N101 = MF –    
      companyLocationPartnerName string Manufacturing business partner name. – – –    
      businessName string Business name for partner or location. – N102 –    
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 2 (SCAC) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN) or

  • PI (US_340B_ID) or

  • PP (PHARMACY_PROCESSOR_NUMBER)

–    
        companyIdentifierValue string Company identifier value for business partner. – N104 –    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –    
      address – Manufacturing business party address information. – – –    
        address1 string Main street address. – N301 –    
        address2 string Supplemental street address. – N302 –    
        city string City – N401 –    
        district string District – N/A –    
        state string State or region code – N402 –    
        postalCode string Postal code – N403 –    
        country string Country code – N404 –    
        telephone string Telephone number – – –    
        fax string Fax number – – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building. – – –    
        lscAddressIdentifier string LSC address identifier. – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Manufacturing business party contact information. – – –    
        contactName string Contact name – – –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – – –    
        contactEmail string Contact email address – – –    
    shipFromLocationInformation – Ship from location party types, identifiers and address information. – N101 = SF Segment loop NAD NAD01= SF    
      companyLocationPartnerName string Ship from business partner name – – –    
      businessName string Business name for partner or location – N102 NAD030-010    
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner –

N103 =

  • 1 (DUNS) or

  • 2 (SCAC) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN) or

  • PI (US_340B_ID) or

  • PP (PHARMACY_PROCESSOR_NUMBER)

NAD020-030 =

  • 9 (GLN) or

  • 16 (DUNS) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID)

  • 164 (DEA) or

  • 237 (HIN)

    
        companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –    
      address   Ship from business party address information. – – –    
        address1 string Main street address – N301 NAD050-010    
        address2 string Supplemental street address. – N302 NAD050-020    
        city string City – N401 NAD060    
        district string District – – –    
        state string State or region code – N402 NAD070-010    
        postalCode string Postal code – N403 NAD080    
        country string Country code – N404 NAD090    
        telephone string Telephone number – – –    
        fax string Fax number – – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building – – –    
        lscAddressIdentifier string LSC address identifier – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Ship from business party contact information. – – –    
        contactName string Contact name – – –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – – –    
        contactEmail string Contact email address – – –    
    distributorBusinessInformation – Distributor business party types, identifiers and address information. – N101 = DS –    
      companyLocationPartnerName string Distributor business partner name. – – –    
      businessName string Business name for partner or location. – N102 –    
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 2 (SCAC) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN) or

  • PI (US_340B_ID) or

  • PP (PHARMACY_PROCESSOR_NUMBER)

–    
        companyIdentifierValue string Company identifier value for business partner. – N104 –    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –    
      address – Distributor business party address information. – – –    
        address1 string Main street address. – N301 –    
        address2 string Supplemental street address. – N302 –    
        city string City – N401 –    
        district string District – – –    
        state string State or region code. – N402 –    
        postalCode string Postal code – N403 –    
        country string Country code – N404 –    
        telephone string Telephone number – – –    
        fax string Fax number – – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building – – –    
        lscAddressIdentifier string LSC address identifier – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Distributor business party contact information. – – –    
        contactName string Contact name – – –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – – –    
        contactEmail string Contact email address – – –    
    billToBusinessInformation – Bill to business party types, identifiers and address information. Segment E1EDKA1 PARVW = RG N101 = BT Segment loop NAD NAD01= BT    
      companyLocationPartnerName string Bill To business partner name. – – –    
      businessName string Business name for partner or location. NAME1 N102 NAD030-010    
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 2 (SCAC) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN) or

  • PI (US_340B_ID) or

  • PP (PHARMACY_PROCESSOR_NUMBER)

NAD020-030 =

  • 9 (GLN) or

  • 16 (DUNS) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID)

  • 164 (DEA) or

  • 237 (HIN)

   
        companyIdentifierValue string Company identifier value for business partner. PARTN N104 NAD020-010    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –    
      address – Bill To business party address information. Segment E1EDKA1 – –    
        address1 string Main street address. STRAS N301 NAD050-010    
        address2 string Supplemental street address. STRS2 N302 NAD050-020    
        city string City ORT01 N401 NAD060    
        district string District – – –    
        state string State or region code REGIO N402 NAD070-010    
        postalCode string Postal code PSTLZ N403 NAD080    
        country string Country code LAND1 N404 NAD090    
        telephone string Telephone number TELF1 – –    
        fax string Fax number TELFX – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building. – – –    
        lscAddressIdentifier string LSC address identifier. – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Bill To business party contact information. – – –    
        contactName string Contact name – – –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – – –    
        contactEmail string Contact email address – – –    
    remitToBusinessInformation – Remit to business party types, identifiers and address information. – N101 = RI –    
      companyLocationPartnerName string Remit To business partner name. – – –    
      businessName string Business name for partner or location. – N102 –    
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 2 (SCAC) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN) or

  • PI (US_340B_ID) or

  • PP (PHARMACY_PROCESSOR_NUMBER)

–    
        companyIdentifierValue string Company identifier value for business partner. – N104 –    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –    
      address – Remit To business party address information. – – –    
        address1 string Main street address. – N301 –    
        address2 string Supplemental street address. – N302 –    
        city string City – N401 –    
        district string District – – –    
        state string State or region code – N402 –    
        postalCode string Postal code – N403 –    
        country string Country code – N404 –    
        telephone string Telephone number – – –    
        fax string Fax number – – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building – – –    
        lscAddressIdentifier string LSC address identifier – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Remit To business party contact information. – – –    
        contactName string Contact name – – –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – – –    
        contactEmail string Contact email address – – –    
    carrierInformation array Carrier business party types, identifiers and address information. Segment E1EDKA1 PARVW = SP N101 = CA Segment loop NAD NAD01= CA    
      companyLocationPartnerName string Carrier business partner name. – – –    
      businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD040-010    
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 2 (SCAC) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN) or

  • PI (US_340B_ID) or

  • PP (PHARMACY_PROCESSOR_NUMBER)

NAD020-030 =

  • 9 (GLN) or

  • 16 (DUNS) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID)

  • 164 (DEA) or

  • 237 (HIN)

   
        companyIdentifierValue string Company identifier value for business partner. E1EDKA1/PARTN N104 NAD020-010    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. E1EDKA1/LIFNR – –    
      address – Carrier business party address information. – – –    
        address1 string Main street address. E1EDKA1/STRAS N301 NAD050-010    
        address2 string Supplemental street address. E1EDKA1/STRS2 N302 NAD050-020    
        city string City E1EDKA1/ORT01 N401 NAD060    
        district string District – – –    
        state string State or region code. E1EDKA1/REGIO N402 NAD070-010    
        postalCode string Postal code E1EDKA1/PSTLZ N403 NAD080    
        country string Country code E1EDKA1/LAND1 N404 NAD090    
        telephone string Telephone number E1EDKA1/TELF1 – –    
        fax string Fax number E1EDKA1/TELFX – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building. – – –    
        lscAddressIdentifier string LSC address identifier – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Carrier business party contact information. – – –    
        contactName string Contact name – – –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number. – – –    
        contactEmail string Contact email address. – – –    
    mpcOrganizationList array Organization identifiers sent from trading partner's ERP system. segment E1EDK14 – –    
      organizationType string

Organization type.

Valid values include:

  • SALESORG

  • DISTRIBUTIONCHANNEL

  • DIVISION

  • COMPANYCODE

  • SALESGROUP

  • SALESOFFICE

  • PROFITCENTER

  • PURCHASINGGROUP

  • PURCHASINGORGANIZATION

QUALF =

  • 003 (DELIVERINGCOMPANYCODE) or

  • 004 (PLANT) or

  • 006 (DIVISION) or

  • 007 (DISTRIBUTIONCHANNEL) or

  • 008 (SALESORG) or

  • 009 (PURCHASINGGROUP) or

  • 010 (SALESGROUP) or

  • 011 (COMPANYCODE) or

  • 014 (PURCHASINGORGANIZATION) or

  • 015 (BILLINGTYPE) or

  • 015 (SALESOFFICE)

 – –    
      organizationValue string Description of organization unit. ORGID – –    
    termsOfPayment array Terms of payment looping group. segment E1EDK18 – –    
      discountDueDate string Due date for discount. – – –    
      termsOfPaymentKey string

Terms of payment.

Valid values include:

PAYTERM1 - 001

PAYTERM2 - 002

PAYTERM3 - 003

STOCKTRANSFER - 004

DESCRIPTION - 005

INSTALLMENT - PMI

QUALF =

  • 001 (PAYTERM1)

  • 002 (PAYTERM2)

  • 003 (PAYTERM3)

  • 004 (STOCKTRANSFER)

  • 005 (DESCRIPTION)

  • PMI (INSTALLMENT)

 – –    
      termsOfPaymentTypeCode string Code identifying type of payment terms. – – –    
      termsOfPaymentDateBasis string Code identifying the dates. – – –    
      numberOfDays string Terms of payment: number of days. TAGE – –    
      termsOfPaymentPercent string Terms of payment: percentage. PRZNT – –    
    transportationInformation array Transportation information for order. – – –    
      companyIdentifierType string Company identifier type for business partner Note: Need to create lookup fille for java exits for companyIdentifierType. – – –    
      routingSequenceCode string Sequence code for routing. – – –    
      transportMethod string Transportation method. – – –    
      shipmentOrderStatusCode string Shipment Order Status Code. – – –    
      companyIdentifierValue string Company identifier value for business partner. – – –    
    transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. – segment REF Segment RFF    
      transactionReferenceType string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping.

The valid values include: - VENDORNUMBER - DEPARTMENT.

 –

REF01 =

  • IA (VENDORNUMBER) or

  • DP (DEPARTMENT)

RFF010-010 = IA (VENDORNUMBER) or AMV (DEPARTMENT) Use java call-out to lookup table CL_TransactionReferenceType.txt    
      transactionReferenceIdentifier string Transaction reference identifier value. –

REF02 where REF010 =

  • IA (VENDORNUMBER) or

  • DP (DEPARTMENT)

 REF010-020 where RFF010-010 = IA (VENDORNUMBER) or AMV (DEPARTMENT)    
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – – –    
      transactionReferenceDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –    
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –    
    creditsAndCharges array Credits and charges on PO including invoice total, discounts, allowances, promotions, services, and others. Segment E1EDK05 – –    
      creditChargeKeyType string

Key identifies credit or charges as discounts or additional charges.

The valid values include:

  • INCREASE

  • DECREASE

ALCKZ = + (INCREASE) OR - (DECREASE) – –    
      creditChargeConditionType string Credit charge condition type. SAP pass thru mapping. KSCHL – –    
      creditChargeType string Code representing type of credit or charge. – – –    
      creditChargeAmount string Total amount for the message. BETRG – –    
      qualifyingAmount string Amount qualifying for cash discount, allowance, promotion, service or charge. – – –    
      creditChargePercentRate string Percentage rate for cash discount, allowance, promotion, service or charge. – – –    
      percentRateBasisTypeCode string Code indicating basis that allowance or charge percent is calculated. – – –    
      creditChargeCurrencyCode string Currency code for credit or charge. – – –    
      creditChargeHandlingCode string Method of handling for discount or charge. – – –    
      description string Description of credit or charge. – – –    
      unitPriceAmount string Unit price amount. – – –    
      unitPriceBasisQuantity string Quantity basis for the unit price. – – –    
      itemQuantity string Item quantity. – – –    
      unitOfMeasure string Unit of measure for conditions data. – – –    
      baseValue string Base value. – – –    
    taxes array Terms of delivery, transport or inco terms looping group. – – –    
      vatIndicator string Key that identifies the VAT indicator code. – – –    
      taxAmount string Total amount of tax for the message. – – –    
      taxRate string Tax rate – – –    
      taxType string Tax type code. – – –    
      country string Country code for tax. – – –    
      taxRegistration string Tax registration code – – –    
      taxJurisdictionCode string Tax jurisdiction code – – –    
      taxExemptCode string Tax exempt code – – –    
      taxCurrencyCode string Currency for tax amount. – – –    
      taxPercent string Tax percent – – –    
    deliveryTerms array Terms of delivery, transport or inco terms looping group. segment E1EDK17 – –    
      deliveryTermCode string

Inco term code.

Valid values:

  • INCO1

  • INCO2

  • INCO3

  • INCOVERSION

  • COMPLETEDELIVERY

QUALF =

  • 001 (INCO1) or

  • 002 (INCO2) or

  • 003 (INCO3) or

  • VER (INCOVERSION) or

  • CDI (COMPLETEDELIVERY)

 – –    
      deliveryTermsConditionCode string Delivery Terms condition code. LKOND – –    
      description string Description for inco term. LKTEXT – –    
      deliveryChargePaymentMethodType string Method of payment for delivery. – – –    
    freeTextNote array Free text, instructions, notes, descriptions and other free text elements. segments E1EDKT1 & E1EDKT2 – –    
      textReferenceCode string Text reference or subject code. TDID – –    
      textFunctionCode string Text function code. TDOBJECT – –    
      language string Language of free text. TSSPRAS_ISO – –    
      textFormatCode string Format code for free text. E1EDKT2/TDFORMAT – –    
      freeFormText string, array Free text array. E1EDKT2/TDLINE – –    
    customFields – Name value pairs to allow trading partners to send custom data not accommodate in canonical schema. – – –    
      name string Name of custom field from trading partner. – – –    
      value string Value of custom field. – – –    
  canonicalOrderStatusReportItemDetails array Purchase order product details array. Parent looping segment E1EDP01 Parent looping segment group HL0100 Parent looping segment LIN group Group 27    
    orderHierarchicalLevel – Instance 1 optional hierarchical level for the Purchase Order for X12. – Segment HL instance -- HL segment is optional. –    
      hierarchicalIdentifier string Hierarchical level counter. First instance = 1. Every subsequent instance increments by 1. – HL01 –    
      hierarchicalParentIdentifier string Hierarchical identifier for the parent level of the current level. If there is no parent level this value would be the same as the current hierarchical Identifier. – HL02 –    
      hierarchicalLevelCode string Code identifying the hierarchical level of the hierarchical group in the current loop of canonicalOrderStatusReportItemDetails. The valid value is ORDER. – HL03 = O –    
      hierarchicalChildCode string

Code indicating if there are child data segments subordinate to the current HL level.

Valid values:

  • 1 - a child line item segment follows

  • 0 - no child line item segment follows

 – HL04 –    
    transactionReferenceIdentifierList[1] – Instance 1 transaction reference identifier mapping of the purchase order number for order status report. segment E1EDP02 in looping segment E1EDP01 Segment PRF in loop HL ORDER segment DOC in segment loop 27    
      b2bTransactionIdentifierType string

Purchase order identifier.

The valid value is PURCHASEORDER.

 QUALF = 001 (PURCHASEORDER) – DOC010-010 = 105 (PURCHASEORDER)    
      b2bTransactionIdentifierValue string Reference order identifier value. BELNR PRF01 where b2bTransactionIdentifierType = PURCHASEORDER DOC020-010    
      lineItemNumber string Line item number in customer purchase order. Line item level only. Note: X12 records the purchase order line item number in PO101. ZEILE – –    
      transactionDate date Date purchase order created in date format YYYY-MM-DD or if time present in external format YYYY-MM-DDTHH:MM:SS.nnnZ. DATUM UZEIT PRF04 –    
      timeZone string Time zone for referenced time, if present – – –    
    transactionReferenceIdentifierList[2] – Instance 2 transaction reference identifier mapping of the supplier order number for order status report. segment E1EDP02 in looping segment E1EDP01 Segment REF in loop HL ORDER segment RFF segment group loop 32 in looping segment group 27 (LIN) + DTM    
      b2bTransactionIdentifierType –

Purchase order identifier.

The valid value is SUPPLIERORDER - RELEASE.

 QUALF = 002 (SUPPLIERORDER)

REF01 =

  • VN (SUPPLIERORDER) or

  • RE (RELEASE)

RFF010-010 =

  • VN (SUPPLIERORDER) or

  • RE (RELEASE)

   
      b2bTransactionIdentifierValue string Reference order identifier value BELNR REF02 RFF020    
      lineItemNumber string Line item number in customer purchase order. Line item level only. Note: X12 records the purchase order line item number in PO101. ZEILE – RFF030    
      transactionDate date Date purchase order created in date format YYYY-MM-DD or if time present in external format YYYY-MM-DDTHH:MM:SS.nnnZ. DATUM UZEIT Segment REF/DTM in loop HL ORDER DTM02 set DTM01 to 938 (SUPPLIERORDER) or 168 (RELEASE) Segment DTM in segment loop group 32 RFF DTM010-020 set DTM010-010 to 4 (order doc issue date)    
      timeZone string Time zone for referenced time, if present. – HL04 –    
    orderItemStatusReport array Item satus report information specifying detailed information about the purchase order or shipment status on a particular date. – Segment ISR –    
      orderStatusCode string

Code specifying the status of an order or shipment or the disposition of any difference between the quantity ordered and the quantity shipped for a transaction or line item.

Valid values include:

  • DATESHIPPED

  • DELETED

  • EXPECTEDSHIPDATE

  • INPROCESS

  • NOTINPROCESS

  • ONHOLD

 – ISR01 –    
      orderStatusReasonCode string

Code that indicates the reason for the order status.

Valid values inclkude:

  • CARRIERDELAY

  • CREDITHOLD

  • DECLINED

  • MANUFACTURERHOLD

  • MISSINGDOCUMENTS

  • MUTUAL

  • NOSTOCK

  • ONHOLD

 – ISR03 –    
      orderStatusDate string Date that the order status was reached in date format YYYY-MM-DD. – ISR02 –    
      epochOrderStatusDate number Date that the order status was reached in the epoch date format. – – –    
    transactionReferenceInformation array – – Segment REF in loop HL ORDER Segment RFF looping group 32 in looping group 27 LIN    
      transactionReferenceType string

Reference identification information for the order status report at the HL order level.

Valid values include:

  • VENDORNUMBER

  • CHANGEREASON

  • DIVISION

  • MERCHANDISETYPE

  • DEPARTMENT

 –

REF01 =

  • IA (VENDORNUMBER) or

  • TD (CHANGEREASON) or

  • 19 (DIVISION) or

  • MR (MERCHANDISETPE) or

  • DP (DEPARTMENT)

RFF010-010 =

  • VR ( (VENDORNUMBER) or

  • AMV (DEPARTMENT)

   
      transactionReferenceIdentifier string

Transaction reference identifier value.

Pass thru X12 mapping. HDA usage description: Class of Trade List: When REF01 = ACD, primary class of trade codes and descriptions will be mapped in REF02 and REF03. Also, note that since a REF segment is being used, trading partners are not restricted to using only the codes and descriptions listed below. Trading partners may elect to add/replace primary class of trade codes and descriptions agreed to by both partners to further meet requirements.

 – REF02 RFF010-020    
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – REF03 –    
      transactionReferenceDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –    
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –    
    mpcDates array Reference dates at the HL Order level. – Loop HL ORDER / REF segment DTM Segment DTM in looping group 32 RFF    
      dateType string

Referenced date type.

The valid values include:

  • RELEASE

  • SCHEDULEDSHIPMENT

 – DTM01

DTM010-010

    
      dateValue date Date and or date time as defined by referenced date type.in string date format YYYYY-MM-DD or string datetime format YYYY-MM-DDTHH:MM:SS.nnnZ. – DTM02 DTM03 (if present) DTM010-020    
      timeZone string Time zone for referenced dates. – – –    
      epochDateValue integer Datetime defined by referenced date type. – – –    
    shipToLocationInformation – Ship to location party types, identifiers and address information. – Segment N1 in looping group HL ORDER N101 = ST –    
      companyLocationPartnerName string Ship To business partner name. – – –    
      businessName string Business name for partner or location. – N102 –    
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
        companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN)

–    
        companyIdentifierValue string Company identifier value for business partner. – N104 –    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –    
      address       – Ship To business party address information. – – –    
        address1 string Main street address. – N301 –    
        address2 string Supplemental street address. – N302 –    
        city string City – N401 –    
        district string District – – –    
        state string State or region code – N402 –    
        postalCode string Postal code – N403 –    
        country string Country code – N404 –    
        telephone string Telephone number – – –    
        fax string Fax number – – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building – – –    
        lscAddressIdentifier string LSC address identifier – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Ship To business party contact information. – – –    
        contactName string Contact name – PER02 –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – PER04 where PER03 = "TE" –    
        contactEmail string Contact email address – PER06 where PER05 = "EM" –    
    endCustomerBusinessInformation – End customer party types, identifiers and address information. – Segment N1 in looping group HL ORDER N101 =MA –    
      companyLocationPartnerName string Ship To business partner name. – – –    
      businessName string Business name for partner or location. – N102 –    
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
        isIdentifierPresentInEvent boolean Is identifier present in event boolean – – –    
        companyIdentifierType string Company identifier type for business partner . –

N103 =

  • 1 (DUNS) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN)

–    
        companyIdentifierValue string Company identifier value for business partner. – N104 –    
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –    
      address       – Ship To business party address information. – – –    
        address1 string Main street address. – N301 –    
        address2 string Supplemental street address. – N302 –    
        city string City – N401 –    
        district string District – – –    
        state string State or region code – N402 –    
        postalCode string Postal code – N403 –    
        country string Country code – N404 –    
        telephone string Telephone number – – –    
        fax string Fax number – – –    
        url string Website URL – – –    
        buildingNumber string Building number – – –    
        plantNumber string Plant number – – –    
        floorNumber string Floor number in building – – –    
        lscAddressIdentifier string LSC address identifier – – –    
        village string Village name – – –    
        houseNumber string House number – – –    
        township string Township – – –    
        premisesCode string Premises code – – –    
      companyLocationContactInformation – Ship To business party contact information. – – –    
        contactName string Contact name – PER02 –    
        contactTitle string Title of contact – – –    
        contactPhone string Contact phone number – PER04 where PER03 = "TE" –    
        contactEmail string Contact email address – PER06 where PER05 = "EM" –    
    itemHierarchicalLevel   Instance 2 optional hierarchical level for product details for X12.. – Segment HL instance –    
      hierarchicalIdentifier string Hierarchical level counter. Increment each instance by 1 from the last. – HL01 –    
      hierarchicalParentIdentifier string Hierarchical identifier for the parent level of the current level. If there is no parent level this value would be the same as the current hierarchical Identifier. – HL02 –    
      hierarchicalLevelCode string Code identifying the hierarchical level of the hierarchical group in the current loop of canonicalOrderStatusReportItemDetails. The valid value is ITEM. – HL03 = I –    
      hierarchicalChildCode string

Code indicating if there are child data segments subordinate to the current HL level.

Valid values:

1 - A child line item segment follows

0 - No child line item segment follows

 – HL04 –    
    productLineItemDetails array Product item baseline data. segment E1EDP01 Segment loop PO1 segment LIN to handle product identifiers. Product identifier details can be present in LIN and PIA segments    
      lineItemNumber string Purchase order line item number for ordered product. POSEX PO101 LIN010    
      processingFunctionTypeCode string

Purpose of purchase order, item level. Element may appear at header or item level or both. Tells receiving system function of purchase.

Valid values:

  • ITEMADDED

  • ITEMCHANGED

  • CANCEL

  • ITEMNOTCHANGED

  • ITEMLOCKED

E1EDP01 / ACTION =

  • 001 (ITEMADDED)

  • 002 (ITEMCHANGED)

  • 003 (CANCEL)

  • 004 (ITEMNOTCHANGED)

  • 005 (ITEMLOCKED)

  • 091 (RECEIPT)

  • 093 (RETURN)

  • 094 (CONSIGNMENT)

  • 095 (DAMAGEDINTRANSIT)

  • 096 (CORRECTION)

 – LIN020 = 1 (ITEMADDED) or 3 (ITEMCHANGED) or 4 (ITEMNOTCHANGED) or 37 (CANCEL)    
      itemQuantity string Item quantity MENGE PO102 Segment QTY in LIN loop QTY010-020 Set ATY010-010 to 21 (ordered quantity)    
      unitOfMeasure string

Unit of measure for litem quantity.

Quantity UOMs include:

  • CA - Case

  • CP - Crate

  • CT - Carton

  • DS- Display

  • DZ - Dozen

  • EA - Each

  • PH - Pack

  • PC - Piece

  • PF - Pallet

  • PK- Package

  • T3 - Thousand Pieces

  • TH - Thousand

  • TY - Tray

  • UN - Unit

MENEE PO103 Segment QTY in LIN loop QTY010-030 Use java call-out to lookup table UOM_TableLookup2.txt    
      itemUnitPrice numer Unit price for product. VPREI PO104 Segment MOA in LIN loop MOA010-020 Set MOA010-010 to 146 (unit price)    
      unitPriceBasisQuantity string Quantity basis for the unit price. PEINH – N/A Note: segments RTE [Rate Details] and PRI [PriceDetails] both include element    
      netPrice number Net price for product at item level. NETWR – –    
      grossPrice number Gross price for product at item level. PREIS – –    
      currencyCode string Item level currency code. CURCY – –    
      materialClass string Material class. MATKL – –    
      itemCategory string Item category. Populated in standard Idoc.. PSTYP – –    
      plantIdentifier string Plant identifier. WERKS – –    
      productCodesIdentifiers [1] array Instance 1 productCodesIdentifiers for mapping across IDoc, X12 and EDIFACT formats. segment E1EDP19 in looping segment E1EDP01 Segment PO1 segment LIN to handle product identifiers. Product identifier details can be present in LIN and PIA segments    
        productCodeType string

Product identifier type code.

The valid values include::

  • CUSTOMER

  • BUYER

  • MANUFACTURER

  • VENDOR

  • GTIN14

E1EDP19 / QUALF =

  • 001 (CUSTOMER) or

  • 002 (VENDOR) or

  • 003 (GTIN14) or

  • 004 (MANUFACTURER)

PO106 =

  • VN (VENDOR) or

  • VC (VENDORCATALOG) or

  • UK (GTIN14) or

  • PI (CUSTOMER) or

  • N4 (US_NDC542) or

  • FV (CA_DIN) or

  • UP (UPC) or

  • MF (MANUFACTURER) or

  • N1 (US_NDC442) or

  • N2 (US_NDC532) or

  • N3 (US_NDC541) or

  • SK (SKU) or BP (BUYER)

LIN030-20 = VN (VENDOR) or IN (CUSTOMER) or BP (BUYER) or UP (UPC) or MF (MANUFACTURER) Use Java lookup table CL_ProductCodeType.txt if segment present    
        productCodeValue string Product code identifier value. E1EDP19 / IDTNR PO107 If PO1 present and any of PO109, PO111, PO113, PO15, PO117, PO119, PO121present, loop thru productCodesIdentifiers and map. LIN030-10    
      productItemInformation array Product item code information. Only using a subset of all available attributes. E1EDP19 Segment PID in HL ITEM loop / looping segment PO1 Segment IMD in looping group 27 LIN    
        productLanguageCode string Language for product description.   PID09 Set PID01 to F (free form) if PID present IMD030-060 Set IMD010 to F (free form) if PID present    
        productName string Name of product. KTEXT PID05 IMD030-040    
        genericName string Generic name for product. – – –    
        productDescription string Description of the product defined by the current product identifier – – –    
      productCodesIdentifiers [2] array Instance 1 productCodesIdentifiers for mapping across top EDIFACT segment PIA with additional product codes. – – segment PIA to handle product details.    
        productCodeType string

Product identifier type code.

Valid values include::

  • CUSTOMER

  • BUYER

  • MANUFACTURER

  • VENDOR

  • GTIN14

– – PIA020-20 = VN (SUPPLIER or VENDOR) or IN (CUSTOMER) or BP (BUYER) or UP (UPC) or MF (MANUFACTURER) Use Java lookup table CL_ProductCodeType.txt if segment present Don't include product type mapped in LIN030-10    
        productCodeValue string Product code identifier value. – – PIA020-10 Set PIA010 to 1: additional identification    
      itemWeight array Order weight at line item level. Segment E1EDP01 Segment MEA –    
        weightType string

Type of weight recorded.

The valid value is NETWEIGHT - GROSSWEIGHT.

 – MEA02 –    
        weightValue string Weight of product at PO line item.

NTGEW, when weightType = NETWEIGHT BRGEW, when weightType = GROSSWEIGHT

 MEA03 –    
        unitOfMeasure string Unit of measure for weight value. GEWEI MEA04 –    
      deliverySchedule array Delivery schedule by dates and quantities. segment E1EDP20 in looping segment E1EDP01 – –    
        scheduledQuantity number Quantity of product to be delivered on delivery date. WMENG – –    
        previouslyScheduledQuantity number Quantity of product that was previously scheduled to be delivered on the delivery date. Relevant for PO acknowledgment. AMENG – –    
        scheduledDateTime date Scheduled date for delivery of scheduled quantity. EDATU EZEIT (if present) – –    
      mpcDates array Order status report dates at line item level. segment E1EDP03 in looping segment E1EDP01 – –    
        dateType string Referenced date type. IDDAT – –    
        dateValue date Date and or date time as defined by referenced date type.in string date format YYYYY-MM-DD or string datetime format YYYY-MM-DDTHH:MM:SS.nnnZ. DATUM UZEIT (if present) – –    
        timeZone string Time zone for referenced dates. – – –    
        epochDateValue integer Datetime defined by referenced date type – – –    
      creditsAndCharges     array Credits and charges on PO including invoice total, discounts, allowances, promotions, services, and others. Segment E1EDP05 in looping segment E1EDP01 – –    
        creditChargeKeyType string

Key identifies credit or charges as discounts or additional charges.

The valid values include:

  • INCREASE

  • DECREASE

ALCKZ = + (INCREASE) OR - (DECREASE) – –    
        creditChargeConditionType string Credit charge condition type. SAP pass thru mapping. KSCHL – –    
        creditChargeType string

Code representing type of credit or charge. Valid values:

  • HANDLING

  • PERITEM

 – – –    
        creditChargeAmount string Total amount for the message BETRG – –    
      itemStatusReport     array Item status report information specifying detailed information about the purchase order or shipment status on a particular date. – Segment ISR in HL ITEM loop / looping segment PO1 –    
        orderItemStatusReport   Order quantity at line item level – Segment QTY in ISR looping group 2100 –    
          orderStatusCode string

Code specifying the status of an order or shipment or the disposition of any difference between the quantity ordered and the quantity shipped for a transaction or line item.

Valid values include:

  • DATESHIPPED

  • DELETED

  • EXPECTEDSHIPDATE

  • INPROCESS

  • NOTINPROCESS

  • ONHOLD

 – ISR01 –    
          orderStatusReasonCode string

Code that indicates the reason for the order status.

Valid values inclkude:

  • CARRIERDELAY

  • CREDITHOLD

  • DECLINED

  • MANUFACTURERHOLD

  • MISSINGDOCUMENTS

  • MUTUAL

  • NOSTOCK

  • ONHOLD

 – ISR03 –    
          orderStatusDate string Date that the order status was reached in date format YYYY-MM-DD. – ISR02 –    
          epochOrderStatusDate number Date that the order status was reached in the epoch date format. – – –    
        itemQuantity   array Order quantity at line item level. – Segment QTY in ISR looping group 2100 –    
          quantityType string

Type of quantity recorded.

Valid values include:

  • DISCRETE

  • CANCELLED

  • SHIPPED

– QTY01 –    
          quantityValue Number Quantity of product in current order status with decimal points – QTY02, when quantityType = ITEM or PRICINGUNIT –    
          unitOfMeasure string Unit of measure for quantity value – QTY03 when quantityType = ITEM or PRICINGUNIT –    
        mpcDates array Reference dates at header level – Segment DTM in ISR looping group 2100 –    
          dateType string

referenced date type.

Valid values include:

  • CURRENTSCHEDULESHIP

  • SHIPPED

  • ESTIMATEDDELIVERY

  • ORDER

 – DTM01 –    
          dateValue date Datetime defined by referenced date type. – DTM02 DTM03 (if present) –    
          timeZone string Time zone for referenced dates. – – –    
          epochDateValue integer Datetime defined by referenced date type. – – –    
        shipToLocationInformation – Ship to location party types, identifiers and address information. Segment E1EDPA1 in looping segment E1EDP01 PARVW = WE Segment N1 in ISR looping group 2100 N101 = ST      
          companyLocationPartnerName string Ship To business partner name. – – –    
          businessName string Business name for partner or location. NAME1 N102 –    
          mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
            isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
            companyIdentifierType string Company identifier type for business partner. –

N103 =

  • 1 (DUNS) or

  • 9 (DUNS4) or

  • 11 (DEA) or

  • 21 (HIN) or

  • 91 (COMPANYID) or

  • 92 (COMPANYSITEID) or

  • UL (GLN)

–    
            companyIdentifierValue string Company identifier value for business partner. PARTN N104 –    
            alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –    
          address   – Ship To business party address information. – – –    
            address1 string Main street address. STRAS N301 –    
            address2 string Supplemental street address. STRS2 N302 –    
            city string City ORT01 N401 –    
            district string District – – –    
            state string State or region code REGIO N402 N/A    
            postalCode string Postal code PSTLZ N403 N/A    
            country string Country code LAND1 N404 N/A    
            telephone string Telephone number TELF1 – –    
            fax string Fax number TELFX – –    
            url string Website URL – – –    
            buildingNumber string Building number – – –    
            plantNumber string Plant number – – –    
            floorNumber string Floor number in building – – –    
            lscAddressIdentifier string LSC address identifier – – –    
            village string Village name – – –    
            houseNumber string House number – – –    
            township string Township – – –    
            premisesCode string Premises code – – –    
          companyLocationContactInformation – Ship To business party contact information. – – –    
            contactName string Contact name – – –    
            contactTitle string Title of contact – – –    
            contactPhone string Contact phone number – – –    
            contactEmail string Contact email address – – –    
        endCustomerBusinessInformation – End customer party types, identifiers and address information. Segment E1EDPA1 in looping segment E1EDP01 PARVW = RE – –    
          companyLocationPartnerName string Ship To business partner name. – – –    
          businessName string Business name for partner or location. NAME1 – –    
          mpcCompanyLocationIdentifierList array Identifier list for business party. – – –    
            isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –    
            companyIdentifierType string Company identifier type for business partner. – – –    
            companyIdentifierValue string Company identifier value for business partner. – – –    
            alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –    
          address – Ship To business party address information. – – –    
            address1 string Main street address STRAS – –    
            address2 string Supplemental street address. STRS2 – –    
            city string City ORT01 – –    
            district string District – – –    
            state string State or region code REGIO – –    
            postalCode string Postal code PSTLZ – –    
            country string Country code LAND1 – –    
            telephone string Telephone number TELF1 – –    
            fax string Fax number TELFX – –    
            url string Website URL – – –    
            buildingNumber string Building number – – –    
            plantNumber string Plant number – – –    
            floorNumber string Floor number in building – – –    
            lscAddressIdentifier string LSC address identifier – – –    
            village string Village name – – –    
            houseNumber string House number – – –    
            township string Township – – –    
            premisesCode string Premises code – – –    
          companyLocationContactInformation – Ship To business party contact information. – – –    
            contactName string Contact name – – –    
            contactTitle string Title of contact – – –    
            contactPhone string Contact phone number – – –    
            contactEmail string Contact email address – – – – –
    freeTextNote array Free text, instructions, notes, descriptions and other free text elements. segment E1EDPT1 and E1EDPT2 in looping segment E1EDP01 – – – –
      textReferenceCode string Text reference or subject code. E1EDP01 / E1EDPT1 / TDID – – – –
      textFunctionCode string Text function code. – – – – –
      language string Language of free text. E1EDP01 / E1EDPT1 / TSSPRAS_ISO – – – –
      textFormatCode string Format code for free text. E1EDP01 / E1EDPT2 / TDFORMAT – – – –
      freeFormText string, array Free text array. E1EDP01 / E1EDPT2 / TDLINE – – – –
    customFields – Name value pairs to allow trading partners to send custom data not accommodate in canonical schema. – – – – –
      name string Name of custom field from trading partner. – – – – –
      value string Value of custom field. – – – – –
  canonicalOrderStatusReportSummary array PO transaction summaries. segment E1EDS01 segment CTT – – –
    summaryType string

Type of summary.

The valid values include NUMBEROFITEMS.

 SUMID = 001 – – – –
    summaryValue string Value in summary SUMME CTT01 – – –
    summaryValueUnit string Summary value unit of measure SUNIT – –    

Tag end