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,

Product activities canonical guidelines

The product activities report is routinely distributed to trading partners, suppliers, or upstream supply chain partners. The product activities report is issued either at set intervals or in response to significant deviations in inventory levels outside the normal schedule. The report's data enables trading partners to assess inventory levels and plan for replenishment needs accurately. By analyzing product activities data, trading partners can forecast necessary shipping quantities or propose optimal replenishment quantities for distribution centers, warehouses, or retail locations.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping
Canonical Element - JSon object type/root element. - - -
  controlFileHeader - Canonical control file header to store data for control segments and envelopes of IDocs, and X12 and EDIFACT EDI messages. - - -
  canonicalProductActivityHeader - Header data for product activity report - Segment XQ -
    productActivityPurposeCode string

Code identifying purpose of product activity transaction set.

Valid values:

  • PLANORDERS - Plan orders and ship product -

  • NOTIFICATION - Notification only

  • PURCHASEORDERS - Plan and submit suggested Purchase Orders

 -

XQ01 =

  • F (PURCHASEORDERS) or

  • G (PLANORDERS) or

  • H (NOTIFICATION) - Required

 -
    fromDate string If the product activity transaction includes only one date at the header level, this represents the report date. If there is a date range the fromDate represents the start date of the date range. E1EDK34/DATUM UZEIT for time, if present XQ02 - Required DTM020 set DMT010 to 90 - Report start date
    toDate string If present, this is the end date of a date range. - XQ03 DTM020 set DMT010 to 91 - Report end date
    epochFromDate integer Date of product activity message in epoch date format - - -
    epochToDate integer To date for product activity message for a date range in epoch date format. - - -
    suggestedPurchaseOrderNumbers array Suggested purchase orders numbers sent for VMI processing. - segment XPO -
      suggestedPurchaseOrderNumber string Suggested purchase order number. If a range of suggested PO numbers is sent, this attribute would store the first number in the range. - XPO01 - Required if segment populated -
      suggestedPurchaseOrderNumberTo string The last PO number when a range of suggested purchase order numbers is sent. - XP02 - Only used for PO number range -
      companyIdentifierType string

Company identifier code qualifier.

Valid values include:

  • 1 - DUNS

  • 9 - DUNS+4

  • 11 - Drug Enforcement Agency registration number

  • 21 - Health Industry Number

  • 91 - Company identifier

  • 92 - Company location identifier

  • UL - Global Location Number

 -

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

-
      companyIdentifierValue string Company identifier value for business partner. - XPO04 - If either XPO03 or XPO04 present, the other is required -
    transactionReferenceIdentifierList array Transaction reference document identifiers. E1EDK02 not processed by standard OB or IB functions. HDA and 10 other guidelines do not include a transaction identifier at header level. BGM … data samples
      b2bTransactionIdentifierType string

Referenced document type.

The valid value is PRODUCTACTIVITY.

 - - BGM010-010 = TBD
      b2bTransactionIdentifierValue string Identifier for transaction referenced by b2bTransactionIdentifierType. - XQ04 when b2bTransactionIdentifierType = PRODUCTACTIVITY BGM020-010
      transactionDate string Date transaction created in string date format YYYY-MM-DD. - - -
      epochTransactionDate integer Date transaction created in epoch integer date format. - - -
      lineItemNumber string Line item number in customer purchase order. Line item level only. - - -
    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 N9 segment group 1 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.

Valid values include:

  • VENDORNUMBER

  • INTERNALVENDORNUMBER

-

N901 =

  • VR (VENDORNUMBER) or

  • IA(INTERNALVENDORNUMBER)

RFF010-010 =

  • VR (VENDORNUMBER) or

  • IA (INTERNALVENDORNUMBER)

      transactionReferenceIdentifier string Transaction reference identifier value. - N902 RFF010-020
      description string Description for transaction reference. - - -
      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. - - -
    reportingLocationBusinessInformation - Reporting location company identifiers and address information. - N101 = "RL" NAD010 = "GY" inventory reporting party
      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.

Valid values include:

  • DUNS

  • DUNS4

  • DEA

  • HIN

  • COMPANYID

  • COMPANYSITEID

- N103 NAD020-030
        companyIdentifierValue string Company identifier value for business partner - N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - -
      address     - Party address information - - -
        address1 string Main street address - - -
        address2 string Supplemental street address - - -
        city string City - - -
        state string State or region code - - -
        postalCode string Postal code - - -
        country string Country code - - -
        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 - - - - -
        contactName string Contact name - - -
        contactTitle string Title of contact - - -
        contactPhone string Contact phone number - - -
        contactEmail string Contact email address - - -
    supplierBusinessInformation - Supplier party company identifiers and address information. Segment E1ADRM1 where PARTNER_Q = "LF" Segment XQ/N1 looping group 1200 N101 = "SU" or VN Segment BGM/NAD looping group 3 NAD01 = "SU"
      businessName string Business name for partner or location. 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 PARTNER_Q

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER- PP

  • GLN - UL

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner. PARTNER_ID companyIdentifierType = "GLN" map companyIdentifierValue to E1ADRE1/EXTEND_D Required value N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
      address - Party address information. - - -
        address1 string Main street address. STREET1 - -
        address2 string Supplemental street address. STREET2 - -
        city string City CITY1 - -
        district string District - - -
        state string State or region code REGION - -
        postalCode string Postal code POSTL_COD1 - -
        country string Country code COUNTRY1 - -
        telephone string Telephone number TELEPHONE1 - -
        fax string Fax number TELEFAX - -
        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 - - - - -
        contactName string Contact name - - -
        contactTitle string Title of contact - - -
        contactPhone string Contact phone number - - -
        contactEmail string Contact email address - - -
    shipFromLocationInformation - Ship from party company identifiers and address information. Segment E1ADRM1 where PARTNER_Q = "OSP" Segment XQ/N1 N101 = "SF" Segment BGM/NAD NAD01 = "SF"
      businessName string Business name for partner or location 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.

Valid values include:

  • DUNS

  • DUNS4

  • DEA

  • HIN

  • COMPANYID

  • COMPANYSITEID

PARTNER_Q

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER- PP

  • GLN - UL

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner. PARTNER_ID companyIdentifierType = "GLN" map companyIdentifierValue to E1ADRE1/EXTEND_D Required value N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
      address - Party address information. - - -
        address1 string Main street address STREET1 - -
        address2 string Supplemental street address. STREET2 - -
        city string City CITY1 - -
        district string District - - -
        state string State or region code REGION - -
        postalCode string Postal code POSTL_COD1 - -
        country string Country code COUNTRY1 - -
        telephone string Telephone number TELEPHONE1 - -
        fax string Fax number TELEFAX - -
        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 - - - - -
        contactName string Contact name - - -
        contactTitle string Title of contact - - -
        contactPhone string Contact phone number. - - -
        contactEmail string Contact email address. - - -
    customerBusinessInformation - Customer or sold to party company identifiers and address information. Segment E1ADRM1 where PARTNER_Q = "AG" N101 = "BY" NAD010 = "BY"
      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.

Valid values include:

  • DUNS

  • DUNS4

  • DEA

  • HIN

  • COMPANYID

  • COMPANYSITEID

PARTNER_Q N103 NAD020-030
        companyIdentifierValue string Company identifier value for business partner. PARTNER_ID N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
      address - Party address information. - - -
        address1 string Main street address STREET1 - -
        address2 string Supplemental street address STREET2 - -
        city string City CITY1 - -
        state string State or region code - - -
        postalCode string Postal code REGION - -
        country string Country code POSTL_COD1 - -
        telephone string Telephone number COUNTRY1 - -
        fax string Fax number TELEPHONE1 - -
        url string Website URL TELEFAX - -
        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 - - - - -
        contactName string Contact name - - -
        contactTitle string Title of contact - - -
        contactPhone string Contact phone number. - - -
        contactEmail string Contact email address. - - -
    shipToLocationInformation - Ship to location identifiers and address information. Segment E1ADRM1 where PARTNER_Q = "WE" Segment XQ/N1 looping group 1200 N101 = "ST" Segment BGM/NAD looping group 3 NAD01 = "ST"
      businessName   string Business name for partner or location. 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.

Valid values include:

  • DUNS

  • DUNS4

  • DEA

  • HIN

  • COMPANYID

  • COMPANYSITEID

PARTNER_Q

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER- PP

  • GLN - UL

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner PARTNER_ID N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - -
      address - Party address information - - -
        address1 string Main street address STREET1 - -
        address2 string Supplemental street address STREET2 - -
        city string City CITY1 - -
        district string District - - -
        state string State or region code REGION - -
        postalCode string Postal code POSTL_COD1 - -
        country string Country code COUNTRY1 - -
        telephone string Telephone number TELEPHONE1 - -
        fax string Fax number TELEFAX - -
        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 - - - - -
        contactName string Contact name - - -
        contactTitle string Title of contact - - -
        contactPhone string Contact phone number - - -
        contactEmail string Contact email address - - -
    distributorBranchformation - Supplier party company identifiers and address information. - Segment XQ/N1 looping group 1200 N101 = "DB" Segment BGM/NAD looping group 3 NAD01 = "DB"
      businessName string Business name for partner or location. - 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.

Valid values include:

  • DUNS

  • DUNS4

  • DEA

  • HIN

  • COMPANYID

  • COMPANYSITEID

-

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER- PP

  • GLN - UL

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner - N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - -
      address - Party address information - - -
        address1 string Main street address - - -
        address2 string Supplemental street address - - -
        city string City - - -
        district string District - - -
        state string State or region code - - -
        postalCode string Postal code - - -
        country string Country code - - -
        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 - - - - -
        contactName string Contact name - - -
        contactTitle string Title of contact - - -
        contactPhone string Contact phone number - - -
        contactEmail string Contact email address - - -
    distributorBusinessInformation - Supplier party company identifiers and address information. - Segment XQ/N1 looping group 1200 N101 = "DS" Segment BGM/NAD looping group 3 NAD01 = "DS"
      businessName string Business name for partner or location - 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.

Valid values include:

  • DUNS

  • DUNS4

  • DEA

  • HIN

  • COMPANYID

  • COMPANYSITEID

-

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • US_340B_ID - PI

  • PHARMACY_PROCESSOR_NUMBER- PP

  • GLN - UL

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner. - N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
      address - Party address information. - - -
        address1 string Main street address. - - -
        address2 string Supplemental street address. - - -
        city string City - - -
        district string District - - -
        state string State or region code - - -
        postalCode string Postal code - - -
        country string Country code - - -
        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 - - - - -
        contactName string Contact name. - - -
        contactTitle string Title of contact. - - -
        contactPhone string Contact phone number. - - -
        contactEmail string Contact email address. - - -
    freeTextNote array Ship to party company identifiers and address information. - - -
      textReferenceCode string Text reference or subject code. Will map whatever is found. - - -
      textFunctionCode string Text function code. - - -
      language string Language of free text. - - -
      textFormatCode string Format code for free text. - - -
      freeText string Free test string. - - -
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Header level. - - -
      name string Name of mapped field. - - -
      value string Value in named field. - - -
  canonicalProductActivityItemDetails array Line item details for product activity report. segment E1EDP31 loop group LIN loop group LIN
    lineItemNumber string Product activity report line item number (HDA). E1EDP31/POSEX LIN01 LIN010
    productCodesIdentifiers array Product code identifiers. E1EDP19 - -
      productCodeType string

Code to qualify product identifier type.

Valid values include:

  • CASEUPC

  • CUSTOMER

  • GTIN14

  • MANUFACTURER

  • PACKAGEUPC155

  • PACKAGEUPC1551

  • PURCHASER

  • SUPPLIER

  • UPN

  • US_NDC442

  • US_NDC532

  • US_NDC541

  • US_NDC542

  • US_NHRIC

  • US_NHRIC55

  • US_NHRIC64

E1EDP19/QUALF =

  • 001 (CUSTOMER) or

  • 002 (SUPPLIER) or

  • 003 (GTIN14)

LIN02 or LIN04 or LIN06 or LIN08 =

  • BP (CUSTOMER) or

  • MF (MANUFACTURER) or

  • N1 (US_NDC442) or

  • N2 (US_NDC532) or

  • N3 (US_NDC541) or

  • N4 (US_NDC542) or

  • N5 (US_NHRIC55) or

  • N6 (US_NHRIC64) or

  • NH (US_NHRIC) or

  • PI (PURCHASER) or

  • UA (CASEUPC) or

  • UI (PACKAGEUPC155) or

  • UK (GTIN14) or

  • UP (UPC) or

  • UX (UPN) or

  • VN (SUPPLIER)

LIN030-020 =

  • BP (CUSTOMER) or

  • MF (MANUFACTURER) or

  • BC (US_NDC442) or

  • BD (US_NDC532) or

  • BE (US_NDC541) or

  • BF (US_NDC542) or

  • AH (PACKAGEUPC155) or

  • SRV (GTIN14) or

  • AI (PACKAGEUPC1551) or

  • UP (UPC) or

  • VN (SUPPLIER)

      productCodeValue string Product code identifier value. E1EDP19/IDTNR LIN03 or LIN05 or LIN07 or LIN09 LIN030-010
    productItemInformation array Product item code information. Only using a subset of all available attributes. segment E1EDP19 - segmemt IMD
      productLanguageCode string Language for product description. - - -
      productCode string Product identifier code. - - -
      productName string Name of product. KTEXT - IMD030-040 hard code F to if IMD010
      genericName string Generic name for product. - - -
      productDescription string Description of the product defined by the current product identifier. - - -
    itemQuantity - Item quantity type definition recording the number of inner containers or eaches (if there are no inner containers) in an outer container. - segment PO4 -
      quantityType string

Quantity type for quantity value for product.

The valid value is INNERCONTAINERS.

 - - -
      quantityValue string Total number of inner containers, or number of eaches if there are no inner containers, per outer container. Count of number of units. - PO401 where quantityType = INNERCONTAINERS -
    pricingInformation array Pricing conditions information for product. - LIN- CTP LOC-LIN-PRI
      pricingType string

Pricing type for price sales catalog.

Valid values include:

  • CONTRACT - Contract price

  • UNIT - Unit price

  • SPECIAL - Special price

  • PROMOTION - Promotional price

 -

CTP02 =

  • CON (CONTRACT) or

  • UCP (UNIT) or

  • SPC (SPECIAL) or

  • PRP (PROMOTION)

 PRI010-030 = CT (CONTRACT) Or PE(UNIT) PRI010-010 = "AAF" (catalog price) Use Java call-out to lookup table CL_PricingType.txt
      pricingAmount number Unit price for pricing type defined by pricing type enum - CTP03 PRI010-020
      currencyCode string Currency code for the pricing amount. -    
      pricingTypeQuantity number Quantity for pricing type - CTP04 PRI010-050
      unitPriceBasisQuantity string Quantity basis of unit price, ie, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12. - - -
      unitOfMeasure string Unit of measure used for pricing at the price conditions line item details level. - CTP05-01 PRI010-060
    productActivityItemAmount array Item total amounts - segment loop LIN-AMT segment loop LIN-MOA
      amountType string

Amount type of item.

The valid values include:

  • LINEITEMTOTAL - Line item total.

  • NET - Net Adjustment

 -

AMT01 =

  • 1 (LINEITEMTOTAL) Or

  • NA (NET)

 MOA010-010 use CL_AmountType.txt java call out table
      pricingAmount string Total amount - AMT02 MOA010-020
      isCreditOrDebit boolean

Credit or debit boolean. Only populated if identified. HDA optional value.

Valid values:

  • True - Credit

  • False - Debit Not populated (default)

 -

AMT03 =

  • C (true)

  • D (false)

 -
    transactionReferenceIdentifierList array Transaction reference document identifiers. - - segment loop LOC/RFF
      b2bTransactionIdentifierType string Referenced document type. - - -
      b2bTransactionIdentifierValue string Identifier for transaction referenced by b2bTransactionIdentifierType. - - -
      transactionDate string Date transaction created in string date format YYYY-MM-DD. - - -
      epochTransactionDate integer Date transaction created in epoch integer date format. - - -
      lineItemNumber string Line item number in customer purchase order. Line item level only. - - -
    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 loop LIN/N9 segment loop LOC/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.

The valid values include LOTNUMBER.

 - N901 = LT (LOTNUMBER)

RFF010-010 = BT (LOTNUMBER)

      transactionReferenceIdentifier string Transaction reference identifier valu. - N902 RFF010-020
      description string Description for transaction reference. - N903 -
      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. - N904 (date) & N905 (time) DTM010-020 when DTM010-010 = 36 (Expiry Date)
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. - - -
    productActivityDetails array Provides activity details such as point of sales and inventory levels for the product reported on in the current item detail loop. segment E1EDP32 segment loop LIN/ZA segment loop LIN/LOC/QTY Note: Need to map from LOC, whatever comes in. EDIFACT pass thru.
      quantityActivityCode string

Code identifying activity details for the product being reported. HDA note:

These activity code qualifiers are identified as “Recommended Codes” that are considered to be primary data most commonly tracked in trading partner distribution management agreements. These codes may be used as mutually agreed-upon between trading partners, and are presented here with the intent to facilitate adherence to industry recommended guidelines.

If these qualifiers are used, then these definitions represent the agreed upon underlying meaning and intended use for each code.

E1EDP32/QUAL =

  • 001 (ONHAND) or

  • 002 (ONORDER) or

  • 003 (TOTALSALES) or

  • 004 (FORECASTSALESDEMAND) or

  • 006 (PLANNEDINVENTORY) or

  • 030 (TRANSFERRED) or

  • 032 (ONHOLD) or

  • 050 (TOTALREQUESTED) or

  • 051 (PLANNEDORDER)

 ZA01

QTY010-010 =

  • 17 (ONHAND) or

  • 21 (ORDERED) or

  • 25 (RETAILSALES) or

  • 27 (ONHOLD) or

  • 48 (RECEIVED) or

  • 51 (TRANSFERRED) or

  • 55 (TOTALSOLD) or

  • 57 (INTRANSIT) or

  • 58 (TOTALWITHDRAWN) or

  • 61 (TOTALRETURNED) or

  • 125 (STOLEN) or

  • 142 (PLANNEDORDER) or

  • 154 (FORECASTSALESDEMAND) or

  • 191 (ADJUSTMENT) or

  • 197 (REORDERPOINT) or

  • 210 (RETURNEDBYCONSUMER) or

  • 211 (REPLENISHMENTOVERRIDE) or

  • 212 (NETSOLD)
      activityQuantity number Quantity associated with the product activity type. E1EDP32/QUANTITY ZA02 QTY010-020
      unitOfMeasure string

Unit or Basis for Measurement Code.

Quantity UOMs include:

  • AM - Ampoule

  • BO - Bottle

  • BX - Box

  • CA - Case

  • CH - Container

  • CT- Carton

  • DZ - Dozen

  • EA - Each

  • GS - Gross

  • KT - Kit

  • PC - Piece

  • PF - Pallet

  • PK - Package

  • SZ - Syringe

  • T3 - Thousand Pieces

  • TH - Thousand

  • TY - Tray

  • UN - Unit

  • VI - Vial

 E1EDP32/UNIT ZA03 QTY010-030
      fromDate string Reporting date for stock and sales activity data in date format YYYY-MM-DD or in date time format YYYYMMDDTHH:MM:SS.nnZ (if time present in external format). E1EDP32/DATE (TIME)

ZA05 where ZA04 =

  • 002 (DELIVERYREQUESTED) or

  • 006 (SOLD) or

  • 007 (EFFECTIVE)

 segment loop LIN/LOC/QTY/DTM DTM010-010 where DTM010-010= 2 (DELIVERYREQUESTED) or 7 (EFFECTIVE)
      toDate string To date if reporting date for stock and sales activity is for a date range in date format YYYY-MM-DD or in date time format YYYYMMDDTHH:MM:SS.nnZ (if time present in external format). E1EDP32/DATE_TO (TIME_TO) - -
      epochFromDate integer Reporting date for stock and sales activity data in epoch date format. - - -
      epochToDate integer To date if reporting date for stock and sales activity is for a date range in epoch date format. - - -
      transactionReferenceIdentifierList - Transaction reference document identifiers. - - segment loop LIN/LOC/QTY/RFF Note: Need to map from LOC, whatever comes in. EDIFACT pass thru.
        b2bTransactionIdentifierType string

Referenced document type.

The valid value is PURCHASEORDER.

 - ZA06 = PO (PURCHASEORDER) RFF010-010 = OR (PURCHASEORDER)
        b2bTransactionIdentifierValue string Identifier for transaction referenced by b2bTransactionIdentifierType - ZA07 RFF010-020
        transactionDate string Date transaction created in string date format YYYY-MM-DD - - -
        epochTransactionDate integer Date transaction created in epoch integer date format. - - -
        lineItemNumber string Line item number in customer purchase order. Line item level only. - - -
      pricingInformation array Pricing information for product. - LIN/ZA/CTP LOC/LIN//QTY/PRI
        pricingType string

Pricing type for price sales catalog.

Valid values include:

  • CONTRACT - Contract price

  • UNIT - Unit price

  • SPECIAL - Special price

  • PROMOTION - Promotional price

 -

CTP02 =

  • CON (CONTRACT) or

  • UCP (UNIT) or

  • SPC (SPECIAL) or

  • PRP (PROMOTION)

PRI010-030 =

  • CT (CONTRACT) Or

  • PE(UNIT)

PRI010-010 =

"AAF" (catalog price)

        pricingAmount number Unit price for pricing type. - CTP03 PRI010-020
        currencyCode string Currency code for the pricing amount. - - -
        pricingTypeQuantity number Quantity for pricing type. - CTP04 PRI010-050
        unitPriceBasisQuantity string Quantity basis of unit price, ie, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12. - - -
        unitOfMeasure string Unit of measure used for pricing at the price conditions line item details level. - CTP05-01 PRI010-060
      destinationLocationQuantity array Destination location quantity. Maps quantities and UOM to be shipped to one or more locations, such as stores, etc. - segment SDQ -
        unitOfMeasure string

Unit or Basis for Measurement Code.

Quantity UOMs include:

  • AM - Ampoule

  • BO - Bottle

  • BX - Box

  • CA - Case

  • CH - Container

  • CT- Carton

  • DZ - Dozen

  • EA - Each

  • GS - Gross

  • KT - Kit

  • PC - Piece

  • PF - Pallet

  • PK - Package

  • SZ - Syringe

  • T3 - Thousand Pieces

  • TH - Thousand

  • TY - Tray

  • UN - Unit

 - SDQ01 -
        companyIdentifierType string

Company identifier type for business partner.

Valid values include:

  • DUNS

  • DUNS4

  • DEA

  • HIN

  • COMPANYID

  • COMPANYSITEID

-

SDQ02 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

 -
        locationQuantitySequence01 - Location quantity group 1 with attributes to match SDQ location/quantity pairs. - - -
          locationIdentifier string Location identifier. - SDQ03 -
          destinationQuantity integer Quantity of product reported for location. - SDQ04 -
        locationQuantitySequence02 - Location quantity group 1 with attributes to match SDQ location/quantity pairs. - - -
          locationIdentifier string Location identifier. - SDQ05 -
          destinationQuantity integer Quantity of product reported for location - SDQ06 -
        locationQuantitySequence03 - Location quantity group 1 with attributes to match SDQ location/quantity pairs - - -
          locationIdentifier string Location identifier - SDQ07 -
          destinationQuantity integer Quantity of product reported for location. - SDQ08 -
        locationQuantitySequence04 - Location quantity group 1 with attributes to match SDQ location/quantity pairs. - - -
          locationIdentifier string Location identifier. - SDQ09 -
          destinationQuantity integer Quantity of product reported for location. - SDQ10 -
        locationQuantitySequence05 - Location quantity group 1 with attributes to match SDQ location/quantity pairs. - - -
          locationIdentifier string Location identifier. - SDQ11 -
          destinationQuantity integer Quantity of product reported for location. - SDQ12 -
        locationQuantitySequence06 - Location quantity group 1 with attributes to match SDQ location/quantity pairs. -   -
          locationIdentifier string Location identifier. - SDQ13 -
          destinationQuantity integer Quantity of product reported for location. - - -
        locationQuantitySequence07 - Location quantity group 1 with attributes to match SDQ location/quantity pairs. - - -
          locationIdentifier string Location identifier. - SDQ15 -
          destinationQuantity integer Quantity of product reported for location. - SDQ16 -
        locationQuantitySequence08 - Location quantity group 1 with attributes to match SDQ location/quantity pairs. - - -
          locationIdentifier string Location identifier. - SDQ17 -
          destinationQuantity integer Quantity of product reported for location. - SDQ18 -
        locationQuantitySequence09 - Location quantity group 1 with attributes to match SDQ location/quantity pairs. - - -
          locationIdentifier string Location identifier. - SDQ19 -
          destinationQuantity integer Quantity of product reported for location. - SDQ20 -
        locationQuantitySequence10 - Location quantity group 1 with attributes to match SDQ location/quantity pair. - - -
          locationIdentifier string Location identifier. - SDQ21 -
          destinationQuantity integer Quantity of product reported for location. - SDQ22 -
    freeTextNote array Ship to party company identifiers and address information. - - -
      textReferenceCode string Text reference or subject code. - - -
      textFunctionCode string Text function code. - - -
      language string Language of free text. - - -
      textFormatCode string Format code for free text. - - -
      freeText string Free test string. - - -
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. - - -
      name string Name of mapped field. - - -
      value string Value in named field. - - -
  canonicalProductActivitySummary aray Product activity report summary segment. segment E1EDS02 segment CTT -
      summaryType string

Summary type for the product activity message.

The valid value is NUMBEROFITEMS.

 E1EDS02/SUMID = 001 (NUMBEROFITEMS) jsummaryType = NUMBEROFITEMS -
      summaryValue string Summary value. SUMME CT01 -
      summaryValueUnit string Summary value unit of measure. - - -

Tag end