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,

Advanced ship notice canonical guidelines

The Advance Ship Notice (ASN) X12 message sends data about a purchase order the supplier is fulfilling and notifies the buyer of the pending goods delivery.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping
canonicalAdvanceShipNotice - Object type/root element. - - -
  controlFileHeader - Canonical control file header to store data for control segments of IDocs and TL XML transactions, and EDI envelopes for X12 and EDIFACT. - - -
  messageBody - Payload for purchase order canonical. - - -
    canonicalAdvanceShipNoticeHeader - Advance Ship Notification Shipment header information. - - -
      processingFunctionTypeCode string

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

Valid values:

  • CREATE - Create new customer PO in supplier's system

  • CHANGE - Change existing customer PO in supplier's system

  • CONFIRM - Purchase Order confirmation/acknowledgment from supplier's system

  • CANCEL - Cancel purchase order

 - - -
      deliveryType string Delivery type defined in sender's ERP system. - - -
      deliveryTypeDescription string Description of delivery type. - - -
      isPartialDelivery boolean

Is delivery a partial or complete delivery.

Valid values:

  • True - partial delivery

  • False - complete delivery (default)

 - - -
      transactionReferenceIdentifierList array Transaction references for deliveries and ASN at header level. - - -
        b2bTransactionIdentifierType string

Referenced document type.

Valid values include:

  • DELIVERY

  • BOL

  • SHIPMENT

  • CARRIERREFERENCE

  • SEALNUMBER

  • SUPPLIERORDER

  • TRACKINGNUMBER

Either DELIVERY or SHIPMENT is required.

 - - -
        b2bTransactionIdentifierValue string Reference order identifier value for Dispatch advice transaction type identified by transactionReferenceIdentifierType. - - -
        transactionDate string Date transaction created. - - -
        lineItemNumber string

Line item number in customer purchase order.

Line item level only.

 - - -
      deliveryPriority string Delivery priority. - - -
      shippingConditions string Shipping conditions. - - -
      shippingConditionsDescription string Shipping conditions Descriptions. - - -
      shippingReceivingPoint string Shipping/receiving point. - - -
      shippingReceivingPointDescription string Shiping/receiving point description. - - -
      salesOrganization string Sales organization. - - -
      salesOrganizationDescription string Sales organization description. - - -
      warehouseIdentifier string Warehouse identifier. - - -
      warehouseDescription string Warehouse identifier description. - - -
      deliveryRoute string Delivery route. - - -
      proofOfDeliveryDate string Date of proof of delivery. - - -
      proofOfDeliveryTime string Time for proof of delivery. E1EDL20 / POTIM - -
      inco1Code string Inco code 1. - - -
      inco2Code string Inco code 2. - - -
      inco1TermDescription string Inco code 1 description. - - -
      inco2TermDescription string Inco code 2 description. - - -
      deliveryRouteDescription string Delivery route description. - - -
      transportationGroup string Transportation group. - - -
      deliveryPriorityDescription string Delivery priority description. - - -
      transportationGroupDescription string Transportation group description. - - -
      totalNumberOfPackages string Total number of packages in shipment. - - -
      exportIndicator boolean

Export indicator.

Valid values:

  • True

  • False

  • (default or none)

- - -
      dropShipIndicator boolean

Drop ship delivery indicator.

Valid values:

  • True

  • False

  • (default or none)

- - -
      deliveryStatus string

Status of delivery.

Valid values:

  • COMPLETE

  • PARTIALDELIVERY

  • CANCELLED

- - -
     

packagingUOM

 string

Top level container type used in the physical packing aggregation for delivery.

Valid values:

  • CTN - Carton

  • SOLID - Solid

  • WOOD - Wood

TD101 =

  • CTN - (CARTON) or

  • 25 - (SOLID) or

  • 94 - (WOOD)

 - -
     

hierarchicalStructuralCode

 string

Hierarchical Structure Code, Code indicating the hierarchical application structure of a transaction set that utilizes the HL segment to define the structure of the transaction set:

  • SOPI - Shipment, Order, Packaging, Item

  • SOIP - Shipment, Order, Item, Packaging

  • SPOI - Shipment, Packaging, Order, Item

  • SOI - Shipment, Order, Item

  • SOTP - Shipment, Order, Tare, Pack

  • SOTPBI - Shipment, Order, Tare, Pack, Batch, Item

BSN05 =

  • 0001 - (SOPI) or

  • 0002 - (SOIP) or

  • 0003 - (SPOI) or

  • 0004 - (SOI) or

  • 0008 - (SOTP) or

  • 0009 - (SOTPBI)

 - -
      mpcASNDateRanges array Delivery ASN dates at header level. - - -
        mpcAsnDateRangeType string

Qualifier identifying purpose of date range.

Valid values:

  • SHIPPED

  • ESTIMATEDDELIVERY

  • SCHEDULEDDELIVERY

- - -
        plannedStartDate string Planned start date and time in datetime format YYYY-MM-DDTHH:MM:SS.nnn, if time is present in source file. Otherwise date will be recorded in date format YYYY-MM-DD. - - -
        plannedEndDate string Planned end date and time in datetime format YYYY-MM-DDTHH:MM:SS.nnn, if time is present in source file. Otherwise date will be recorded in date format YYYY-MM-DD. - - -
        actualStartDate string Actual start date and time in datetime format YYYY-MM-DDTHH:MM:SS.nnn, if time is present in source file. Otherwise date will be recorded in date format YYYY-MM-DD. - - -
        actualEndDate string Actual end date and time in datetime format YYYY-MM-DDTHH:MM:SS.nnn, if time is present in source file. Otherwise date will be recorded in date format YYYY-MM-DD. - - -
        timeZone string Time zone for referenced dates. - - -
      customerBusinessInformation - Sold to customer company identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. E1ADRM1 / LANGUAGE - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      supplierBusinessInformation - Supplier party company identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      shipFromLocationInformation - Ship from location identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. E1ADRM1 / NAME2 - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. E1ADRM1 / HOUSE_SUPL - -
          township string Township. - - -
          premisesCode string Premises code. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. E1ADRM1 / LANGUAGE - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      shipToLocationInformation - Ship to location identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. E1ADRM1 / LANGUAGE - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      salesOrganizationInformation - Supplier's sales organization identifier and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. E1ADRM1 / HOUSE_SUPL - -
          township string Township. - - -
          premisesCode string Premises code. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. E1ADRM1 / LANGUAGE - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      distributorBusinessInformation - Distributors business identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      billToBusinessInformation - Bill to party's business identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      remitToBusinessInformation - Remit to party's business identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string Company located time zone. - - -
          country string Country name. - - -
      carrierInformation array Carrier party or parties company identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      manufacturerBusinessInformation - Manufacturing party's company identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      returnToBusinessInformation - Return to party's company identifiers and address information. - - -
        businessName string Business name for partner or location. - - -
        additionalBusinessName string Additional business name or overflow of business name. - - -
        companyLocationContactInformation - - - - -
          contactName string Contact name. - - -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - - -
          contactEmail string Contact email address. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          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. - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          address3 string Additional street 3 address. - - -
          timeZone string company located time zone. - - -
          country string Country name. - - -
      companyLocationContactInformation - - - - -
        contactName string Contact name. - - -
        contactTitle string Title of contact. - - -
        contactPhone string Contact phone number. - - -
        contactEmail string Contact email address. - - -
      termsOfPayment array Terms of payment looping group. - - -
        termsOfPaymentKey string Terms of payment. - - -
        termsOfPaymentTypeCode string

Code identifying type of payment terms.

Valid values:

  • BASIC

  • DEFERRED

  • DISCOUNTNOTAPPLICABLE

  • ENDOFMONTH

  • EXTENDED

  • FIXEDDATE

  • MIXED

  • PREVIOUSLYAGREED

  • PROXIMO

  • SELLER

- - -
        termsOfPaymentDateBasis string

Code identifying the beginning of the terms period.

Valid values:

  • DELIVERYDATE - Delivery date

  • EFFECTIVEDATE - Effective date

  • INVOICEDATE - Invoice date

  • INVOICERECEIPTDATE - Invoice receipt date

  • PURCHASEORDERDATE - Purchase order date.

  • SHIPDATE - Shipping date

 - - -
        numberOfDays string Terms of payment: number of days - - -
        discountDueNumberOfDays number

Terms Discount Days Due.

Number of days in the terms discount period by which payment is due if terms discount is earned.

 - - -
        termsOfPaymentPercent string Terms of payment: percentage. - - -
        invoicePayablePercent string Percentage of invoice payable. - - -
        discountDueDate string Discount due date in string date format YYYY-MM-DD. - - -
        epochDiscountDueDate integer Discount due date in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - -
        paymentDueDate string Due date for payment. - - -
        paymentDeferredToDate string Date deferred payment or percent of invoice payable is due. - - -
        epochPaymentDueDate integer Due date for payment generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - -
        epochPaymentDeferredToDate integer Date deferred payment or percent of invoice payable is due generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - -
        paymentDeferredDueAmount string Deferred amount due for payment. - - -
        description string Terms of payment description. - - -
        totalTermDiscountAmount integer Terms of payment discount amount. Total amount of terms discount. - - -
        dayOfMonth integer The numeric value of the day of the month between 1 and the maximum day of the month being referenced - - -
      deliveryTerms array Terms of delivery, transport or inco terms looping group. - - -
        deliveryTermCode string Inco term code. - - -
        description string Description for inco term. - - -
        deliveryChargePaymentMethodType string

Method of payment for delivery.

Valid values:

  • ADVANCECOLLECT

  • ADVANCEPREPAID

  • BUYER

  • BUYERSELLERDEFINED

  • COLLECT

  • COLLECTDELIVERY

  • COSTFREIGHT

  • MIXED

  • NOCHARGESERVICEFREIGHT

  • PICKUP

  • PREPAIDCUSTOMER

  • PREPAIDONLY

  • PREPAIDSELLER

  • SELLER

- - -
        fobTransferLocation string

Code specifying the type of location at which the risk of loss for the shipment transfers.

Valid values:

  • CITY

  • PLANT

  • SHIPPINGDESTINATION

  • SHIPPINGORIGIN

- - -
        deliveryTermsConditionCode - - - - -
      deliveryQuantity array Order quantity at delivery header level. - - -
        quantityType string Type of quantity recorded. Valid value is LADING. - - -
        quantityValue Number Quantity of product at delivery header level. - - -
        unitOfMeasure string Quantity unit of measure in master data for product. - - -
      deliveryWeight array Order weight at delivery header level. - - -
        weightType string Type of weight recorded. Valid value is GROSS - NET. - - -
        weightValue Number Weight of product at delivery header level. - - -
        unitOfMeasure string Weight unit of measure in master data for product. - - -
      deliveryVolume array Product volume at delivery header level. - - -
        volumeType string Type of weight recorded. Valid value is TOTAL. - - -
        volumeValue Number Volume for delivery. - - -
        unitOfMeasure string Volume unit of measure. - - -
      deliveryRouting - Packaging details including container, quantity, weight and volume. - - -
        shippingRoute string Shipment routing code. - - -
        shippingType string Shipping type at header of delivery routing. E1EDL28 / VSART - -
        shippingRouteDescription string Description of the shipment routing code. E1EDL28 / E1EDL29 / VSART_BEZ - -
        shippingTypePreliminaryLeg string Shipping type for preliminary leg of routing. - - -
        shippingTypeSubsequentLeg string Shipping type for subsequent leg of routing. - - -
        deliveryDistance number Distance traveled for all routing stages. - - -
        deliveryDistanceUOM string Delivery distance unit of measure. - - -
        routingStages array Details of routing stages. - - -
          routingStageNumber number Line number for routing stage. - - -
          routingSequenceCode string Routing sequence/stage code. - - -
          routingDescription string Description of the routing or requested routing for shipment, or the originating carrier's identity - - -
          carrierIdentifierCodeType string

Carrier identification code type.

Valid values include:

  • SCAC - SCAC identifier

  • SHIPFROM - Ship from location

  • SHIPTO - Ship to location

  • CARRIER - Carrier party info (more than one carrier party may be included)

  • DISTRIBUTOR - Distributor

 - - -
          carrierIdentifierCode string Routing stage carrier party SCAC or other identifier code. - - -
          transportMethod string Transportation method used in routing stages. - - -
          transportMethodDescription string Description of transport method for routing. - - -
          shippingType string Ship type for routing stage. - - -
          routingStageDistance number Travel distance for routing stage. - - -
          routingStageDistanceUOM string Travel distance unit of measure. - - -
          routingStageCategory string Transport category for stage. - - -
          routingStagePoint array Routing stage begin and end points. - - -
            routingStageIdentifierType string

Routing stage identifier type.

Valid values:

  • BEGIN - Begin point

  • END - End point

 - - -
            transportConnectionPoint string Transportation connection point. - - -
            transportConnectionPointDescription string Transportation connection point. - - -
            shippingReceivingPoint string Shipping/receiving point for delivery routing stage point. - - -
            shippingReceivingPointDescription string Description of shipping/receiving point for delivery routing stage point. - - -
            loadingPoint string Routing stage loading point. - - -
            loadingPointDescription string Description of routing stage loading point. - - -
            unloadingPoint string Routing stage unloading point. - - -
            storageLocation string Storage location for routing stage point. - - -
            storageLocationDescription string Description of storage location for routing stage point. - - -
            warehouseIdentifier string Warehouse / warehouse complex identifier. - - -
            warehouseDoorNumber string Door for warehouse identifier. - - -
            routingStagePointLocationInformation - Routing stage point location information. - - -
              businessName string Business name for partner or location. - - -
              companyLocationContactInformation - - - - -
                contactName string Contact name. - - -
                contactTitle string Title of contact. - - -
                contactPhone string Contact phone number. - - -
                contactEmail string Contact email address. - - -
              mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
                isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
                companyIdentifierType string Regulatory company identifier type for business partner. - - -
                companyIdentifierValue string Company identifier value for business partner. - - -
                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. - - -
      transportationEquipment array Equipment used to transport the delivery. - - -
        equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAIL

  • CAR

  • TRAILER

  • SHIP

- - -
        equipmentPrefix string Prefix or alphabetic part of an equipment unit's identifying number. - - -
        equipmentIdentifier string Sequencing or serial part of an equipment unit's identifying number. - - -
      deliveryExportData   Export data relevant for deliver. Segment E1EDL33 - -
        countryOfOrigin string Country of origin for the means of transport at departure. STABE - -
        destinationCountry string Destination country for export. ALAND - -
        foreignTradeTransportType string Mode of Transport for Foreign Trade. EXPVZ - -
        transportTypeForDeparture string Type of transportation used for departure. KZABE - -
        transportTypeToCrossBorder string Type of transportation used to cross border. KZGBE - -
        customsOfficeForExitOrEntry string Customs office for exit or entry of foreign trade. ZOLLA - -
        customsOfficeForDestination string Customs office for the destination of foreign trade. ZOLLB - -
        customsOffice1 string Customs office 1 for foreign trade. ZOLL1 - -
        customsOffice2 string Customs office 2 for foreign trade. ZOLL2 - -
        customsOffice3 string Customs office 3 for foreign trade. ZOLL3 - -
        customsOffice4 string Customs office 4 for foreign trade. ZOLL4 - -
        customsOffice5 string Customs office 5 for foreign trade. ZOLL5 - -
        customsOffice6 string Customs office 6 for foreign trade. ZOLL6 - -
        currencyCode string Currency of statistical values for foreign trade. GRWCU - -
      iotDetailsInformation array Iod devises information. - - -
        iotIdendifier string The ID of a customer IoT device attached to this shipment. - - -
        iotType string The type/brand of the IoT device attached to this shipment. - - -
        iotService string The service/model of the IoT device attached to this shipment. - - -
      customFields array Custom name/value pairs for pass thru values. - - -
        name string Name of pass thru field. - - -
        value string Value in pass thru field. - - -
      freeTextNote array Free text, instructions, notes, descriptions and other free text elements. - - -
        textReferenceCode string Text reference or subject code. Will map whatever is found. - - -
        textFunctionCode string Text function code. Will map whatever is found. E1TXTH8 / TDOBNAME - -
        language string Language key for message. E1TXTH8 / TSSPRAS - -
        languageCode string ISO language code for message. - - -
        textFormatCode string Format code for free text. - - -
        freeFormText string, array Free text array. - - -
     

statusConditionsResponse

 array Pass thru segment to record responses to predetermined questions defined by trading partners. All attributes are for pass-thru mapping without any enumerations or data conversions. Segment YNQ - pass thru only - -
        questionCode string Code identifying conditions for response. Pass thru mapping. - YNQ01 -
        responseCode string Response code to condition identified in questionCode. - YNQ02 -
        dateTimeFormat string Format of date or date time in dateValue attribute. - YNQ03 -
        dateValue string String date or date time in format defined by dateTimeFormat string. - YNQ04 -
        codeListQualifier string Identifies code list used for the value in industryCode. - YNQ08 -
        industryCode string Code for industry relevant to the response recorded for the trading partner's pre-determined questions. - YNQ09 -
        freeFormText string Free form text message. - YNQ05 -
    canonicalAdvanceShipNoticeItemDetails array Advance Ship Notification Aggregated items details. - - -
      lineItemNumber string ASN item detail line item number. - - -
      processingFunctionTypeCode string

Purpose of purchase order.

Tells receiving system function of purchase.

Valid values:

  • CREATE - Create new customer PO in supplier's system.

  • CHANGE - Change existing customer PO in supplier's system.

  • CONFIRM - Purchase Order confirmation/acknowledgement from supplier's system.

  • CANCEL - Cancel purchase order.

 - - -
      lineItemStatus string Line item status. Pass thru mapping. - - -
      productCodesIdentifiers array Internal material identifier in the backend/ERP systems for the product. In the delivery this will be the supplier, although the customer and other identifiers may also be present. - - -
        productCodeType string

Code to qualify product identifier type.

Some valid product types include:

  • BUYERITEM

  • CUSTOMER

  • GTIN14

  • MANUFACTURERPART

  • UPC

  • VENDOR

  • VENDORPART

 - - -
        productCodeValue string Product code identifier value. - - -
      productItemInformation array

Product item code information.

Only using a subset of all available attributes.

 - - -
        productLanguageCode string Language for product description. - - -
        productName string Name of product. - - -
        genericName string Generic name for product. - - -
        productDescription string Description of the product defined by the current product identifier. - - -
      lotNumber string Lot or batch identifier. - - -
      alternateLot string Alternate lot number, ie, third-party supplier, customer, etc. - - -
      expirationDate date Lot expiration date. - - -
      itemQuantity array Order quantity at line item level. - - -
        quantityType string

Type of quantity recorded.

Valid values include:

  • DELIVERY

  • ORDER

  • PACKAGED

  • SHIPPEDTODATE

  • STOCKKEEPING

  • UNITS

  • INNERCONTAINERS

 - - -
        quantityValue number Quantity of product in delivery. - - -
        unitOfMeasure string Unit of measure for delivery quantity. - - -
      itemWeight array Order weight at line item level. - - -
        weightType string

Type of weight recorded.

Valid values include:

  • GROSSWEIGHT

  • NETWEIGHT

- - -
        weightValue Number Weight of product at PO line item. - - -
        unitOfMeasure string Weight unit of measure in master data for product. - - -
      itemVolume array Product volume at line item level. - - -
        volumeType string

Type of weight recorded.

Valid value is TOTAL.

 - - -
        volumeValue Number Volume for item. - - -
        unitOfMeasure string Volume unit of measure. - - -
      itemPricing array price amounts for item. - - -
        pricingType string

Pricing type for item.

Valid pricing types include:

  • UNIT

  • EXTENDED

- - -
        pricingAmount string Pricing amount for pricing type defined by pricing type enumeration. - - -
        currencyCode string Currency for pricing amount. - - -
        priceUOM string Unit of measure used for pricing at the order line item level. - - -
        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. - - -
        altUOMDenominator string

Denominator is used to convert from an alternate unit of measure, ie KG, to a base unit of measure, ie EA.

The denominator is the number of units of the alternative UOM (KG) that corresponds to the number of units of the base UOM (EA).

If 5 KG = 3 EA, 1 KG = 3/5 EA. 5 is the denominator. In most cases, this value will be 1.

 - - -
        altUOMNumerator string

Numerator is used to convert from an alternate unit of measure, ie, KG to a base unit of measure, ie, EA.

The numerator is the number of units of the base UOM (EA) that corresponds to the number of units of the alternative UOM (KG).

If 5 KG = 3 EA, 1 KG = 3/5 EA. 3 is the numerator. In most cases, this value will be 1.

 - - -
        numberOfUnitsInPriceUOM number Number of units of measure on which the price is based, ie, 10 liters of oil cost $12.00. The price unit is 10. - - -
        totalStockValue number Total pricing amount for that line item. - - -
        isCreditorDebit boolean

Credit or debit boolean.

Only populated if identified. HDA optional value.

Valid values:

  • True = Credit

  • False = Debit

  • Not populated (default)

 - - -
      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. - REF segment -
       

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 value is SERIALNUMBER = Serial Number.

REF01 = SE (SERIALNUMBER)

Use Java call-out to enum lookup table CL_

TransactionReferenceType

 - -
        transactionReferenceIdentifier string

Transaction reference identifier value as defined by enumeration in transactionReferenceType.

Pass thru X12 mapping.

 - REF02 -
        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. - N/A -
        epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. - N/A -
      materialGroup string Material group. - - -
      superiorItemInHierarchy string Identifies line item number of parent item in batch hierarchy when multi-batch split is present for the same product. In a batch split one product code has been produced and is being shipped in multiple batches. Each batch has its own line item group. - - -
      hierarchyItem string SAP value. Use of batch when batch split is present. - - -
      externalItemNumber string External line item number. - - -
      salesOrderItemCategory string Supplier sales order item category. - - -
      productHierarchy string Product hierarchy. - - -
      pricingUnitNumerator number Numerator for conversion of order pricing unit into order unit. - - -
      pricingUnitDenominator number Denominator for conversion of order pricing unit into order unit. - - -
      overDeliveryTolerance number Over delivery tolerance limit. - - -
      underDeliveryTolerance number Under delivery tolerance limit. - - -
      lotValuationType string Lot valuation type. - - -
      materialGroupPackaging string Material group for packaging materials. - - -
      containerIdentifier string Material group for packaging materials. - - -
      plantIdentifier string Plant identifier. - - -
      plantDescription string Description of plant. - - -
      storageLocation string Storage location. - - -
      storageLocationDescription string Description of storage location. - - -
      loadingGroup string Loading group. - - -
      loadingGroupDescription string Description of loading group. - - -
      transportationGroup string Transportation group. - - -
      deliveryGroup string Delivery group. - - -
      distributionChannel string Distribution channel. - - -
      distributionChannelDescription string Description of distribution channel. - - -
      division string Sales division. - - -
      divisionDescription string Description of division. - - -
      referenceDocumentIdentifier string Reference document identifier. - - -
      referenceDocumentLineItem string Reference document line item number. - - -
      ean11Identifier string EAN11 identifier … GTIN14. - - -
      externalItemIdentifier string External item identifier. - - -
      externalLineItem string External line item number. - - -
      originalDeliveryQuantity number Original delivery quantity. - - -
      transportationGroupDescription string Description of transportation group. - - -
      packingControl string Packing control. - - -
      customerGroup string Customer group. - - -
      firstMaterialGroup string Material group 1. - - -
      firstMaterialGroupDescription string Description of material group 1. - - -
      secondMaterialGroup string Material group 2. - - -
      secondMaterialGroupDescription string Description of material group 2. - - -
      salesOrderItemCategoryDescription string Sales order item category description. - - -
      materialGroupDescription string Description of material group. - - -
      productHierarchyDescription string Description of product hierarchy. - - -
      customerGroupDescription string Description of customer group. - - -
      isPartialCOA boolean

Specifies whether the batch is under quarantine with a partial Certificate Of Analysis.

Valid values:

  • True - Batch under quarantine with partial Certificate Of Analysis

  • False - Batch is NOT under quarantine with partial COA.

 - - -
      salesOrganization string Sales organization. E1EDL24 / VKBUR - -
      salesOrganizationDescription string Sales organization description. E1EDL24 / E1EDL25 / VKBUR_BEZ - -
      mpcDates array Reference dates at header level. - - -
        dateType string

Referenced date type.

Valid values include:

  • SHIPPED

  • SCHEDULEDDELIVERY

  • ESTIMATEDDELIVERY

- - -
        dateValue date Date defined by referenced date type. - - -
        timeZone string Time zone for referenced dates. - - -
      deliveryTerms array Terms of delivery, transport or inco terms looping group. - - -
        deliveryTermCode string Inco term code. - - -
        description string Description for inco term. - - -
        deliveryChargePaymentMethodType string

Method of payment for delivery.

Valid values:

  • ADVANCECOLLECT

  • ADVANCEPREPAID

  • BUYER

  • BUYERSELLERDEFINED

  • COLLECT

  • COLLECTDELIVERY

  • COSTFREIGHT

  • MIXED

  • NOCHARGESERVICEFREIGHT

  • PICKUP

  • PREPAIDCUSTOMER

  • PREPAIDONLY

  • PREPAIDSELLER

  • SELLER

- - -
        fobTransferLocation string

Code specifying the type of location at which the risk of loss for the shipment transfers.

Valid values:

  • CITY

  • PLANT

  • SHIPPINGDESTINATION

  • SHIPPINGORIGIN

 - - -
        deliveryTermsConditionCode string Inco term condition. - - -
      deliveryItemExportData array Delivery export data at the line item level. Loop E1EDL24 Segment E1EDL35 - -
        importCodeIdentifier string Import/commodity code for item for foreign trade. STAWN - -
        countryOfOrigin string Country of origin for the exported item. HERKL - -
        regionOfOrigin string Region in country of origin for the exported item. HERKR - -
        exportImportProcedureCode string Export/import procedure for foreign trade. EXPRF - -
        foreignTradeTransactionType string Business transaction type for foreign trade. EXART - -
        statisticalValueForTrade number Statistical value for foreign trade. 2 decimal places. GRWRT - -
        preferenceIndicator string

Preference indicator in export/import. Will not add enumerations to attribute.

Valid values:

  • NONE

  • PRICE

  • ALLOWED

  • NOTALLOWED

  • MANUAL

  • MIXEDORIGIN

PREFE =

  • A - (NONE) or

  • B - (PRICE) or

  • C - (ALLOWED) or

  • D - (NOTALLOWED) or

  • E - (MANUAL) or

  • F - (MIXEDORIGIN) or

  • not present, not mapped

 - -
        productCountryOfOriginDescription string Region in country of origin for the exported item. E1EDL24 / E1EDL35 / E1EDL36 / HERKL_BEZ - -
        regionOfOriginDescription string Region in country of origin description for the exported item. E1EDL24 / E1EDL35 / E1EDL36 / HERKR_BEZ - -
      destinationLocationQuantity array

Records quantity invoiced by location details.

Typically used to report invoiced quantity at multiple locations.

For example, Walmart or CVS may report quantity for the invoiced item at multiple store locations. Corresponds to X12 SDQ segment.

 - - -
        mpcCompanyLocationIdentifierList - - - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Regulatory company identifier type for business partner. - - -
          companyIdentifierValue string Company identifier value for business partner. - - -
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
        locationQuantityValue Number This quantity is the sum of all quantity per location and per line. - - -
        unitOfMeasure string Unit of measure for destination location quantity. - - -
      transactionReferenceIdentifierList array Transaction references for deliveries at line item detail level. - - -
        b2bTransactionIdentifierType string

Referenced document type. Purchase order and vendor sales order most expected at line item level.

Valid values:

  • PURCHASEORDER

  • INVOICE

  • SUPPLIERORDER

- - -
        b2bTransactionIdentifierValue string Reference order identifier value for Dispatch advice transaction type identified by transactionReferenceIdentifierType. - - -
        transactionDate date Date transaction created. - - -
        lineItemNumber string Line item number in customer purchase order. Line item level only. - - -
      batchCharacteristics array Batch characteristics, additional data about batches. - - -
        batchIdentifierType string Identifier type for batch characteristic. - - -
        batchName string Name of batch characteristic. - - -
        batchDescription string, array Description of batch characteristic. One or more descriptions may be present. - - -
        characteristicValue string Value of batch characteristic. - - -
        characteristicValueDescription string Description of batch characteristic value. - - -
        characteristicToleranceValue string Batch characteristic tolerance from value. - - -
      componentConsumption array Component or consumed product information. - - -
        lineItemNumber string Line item number for instance of component consumption details group. - - -
        customerProductCode string Customer product code identifier for component or consumed. - - -
        lotNumber string Lot number for component product. - - -
        quantityConsumed number Quantity of the component / consumed product. - - -
        unitOfMeasure string Unit of measure for the quantity of the component product. Use Java call-out to lookup table UOM_TableLookup2.txt. - - -
        supplierProductCode string Supplier product code identifier for component. - - -
      customFields array Custom name/value pairs for pass thru values. - - -
        name string Name of pass thru field. - - -
        value string Value in pass thru field. - - -
      freeTextNote array Free text, instructions, notes, descriptions and other free text elements. Segment E1EDL24 / E1TXTH9 - -
        textReferenceCode string Text reference or subject code. Will map whatever is found. E1EDL24 / E1TXTH9 / TDOBJECT - -
        textFunctionCode string Text function code. Will map whatever is found. E1EDL24 / E1TXTH9 / TDOBNAME - -
        language string Language key for message. E1EDL24 / E1TXTH9 / TSSPRAS - -
        languageCode string ISO language code for message. E1EDL24 / E1TXTH9 / LANGUA_ISO - -
        textFormatCode string Format code for free text. E1EDL24 / E1TXTH9 / E1TXTP9 / TDFORMAT - -
        freeFormText string, array Free text array. E1EDL24 / E1TXTH9 / E1TXTP9 / TDLINE - -
    packagingAggregation array Packaging aggregation looping group, one instance per primary (pallet, case, bundle, etc.) - - -
        purchaseOrderIdentifier string Purchase order identifier number. - - -
        hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
        hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
      packagedProduct array Packaged product level aggregation hierarchy for loose eaches. - - -
        purchaseOrderIdentifier string Purchase order identifier number. - - -
        purchaseOrderLineItem - Purchase order line item number. - - -
        hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
        hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
        packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

  • EA - Each

 - - -
        packagingContentsType string

Relevant for SAP. Type of Handling-unit Item Content. SAP values include:

  • 1 - Saleable item

  • 2 - Auxiliary packing item

  • 3 - Handling unit (packing item: pack, inner pack, etc.)

 - - -
        packagingIdentifier string Packaging identifier if child product a pallet, case or bundle. - - -
        deliveryDocumentIdentifier string Delivery document identifier if child an each. - - -
       

deliveryDocumentLineItem

 string Delivery document line item number for child each.

SN101 from HL (ITEM) / SN1 segment

 - -
        packagedProductIdentifier string Product code identifier for product packed into aggregation. - - -
        itemQuantity - Quantity of product packed into parent container for each. - - -
          quantityType string

Type of quantity recorded.

Valid value is PACKAGED.

 - - -
          quantityValue number Quantity of product in delivery. - - -
          unitOfMeasure string Unit of measure for delivery quantity. - - -
        lotNumber string Lot or batch identifier for aggregated product. - - -
        plantIdentifier string Plant identifier. - - -
        storageLocation string Storage location for aggregated product. - - -
        materialGroup string Material Group: Packaging Materials. E1EDL37 / MAGRV - -
        materialGroupCategory string Packaging Material Category. E1EDL37 / VELTP - -
        materialGroupDescription string Description of Packaging Material. E1EDL37 / VEBEZ - -
        packagingLabelType string

SMG identification for material tag.

Valid values are:

  • S - Single label

  • M - Main label

  • G - Group label

 E1EDL37 / SMGKN - -
        isWeightVolumeFixed string Fixed weight and volume. E1EDL37 / GEWFX - -
        materialPackagingDescription string Material Group: Packaging Materials. E1EDL37 / E1EDL38 / MAGRV_BEZ - -
        receiptDate string Date of Goods Receipt. E1EDL37 / E1EDL44 / WDATU - -
        itemDimensions array Dimensions at parent packaging level. - - -
          dimensionsType string

Type of volume recorded at parent packaging level.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

 - - -
          dimensionsValue Number Volume for item. E1EDL37 / LADLG - -
          unitOfMeasure string Dimension unit of measure. - - -
      parentPackagingLevel array Primary aggregation hierarchy represents the top most level of the packaging hierarchy that will be shipped. - - -
        purchaseOrderIdentifier string Purchase order identifier number. - - -
        hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
        hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
        packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

 - - -
        packagingIdentifier string Packaging identifier used for the parent level physical packing aggregation for delivery. - - -
        packagingIdentifierType string

Packaging identifier format type used for parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
        alternatePackagingIdentifier string External packaging identifier used for the parent level physical packing aggregation for delivery. - - -
        alternatePackagingIdentifierType string

External packaging identifier type used for the parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
        packagingMaterialCode string Descriptive code for packaging materials. - - -
        packagingMaterialType string Packaging materials type. - - -
        packagingMaterialTypeDescription string Description of packaging materials type. - - -
        packagingMaterialCategory string Packaging materials category. - - -
        customerPackagingMaterial string Customer packaging material. - - -
        partnerPackagingMaterial string Partner (customer or supplier or other) packaging material. - - -
        packagingMaterialDescription string Description of packaging material. - - -
        packagingMaterialTagIdentifier string SMG identification for material tag. - - -
        packagingMaterialStatus string Packaging material status. - - -
        palletTiers number Pallet tiers. The number of layers per pallet. - - -
        quantityPacked number Pack. The number of inner containers, or eaches if no inner containers, per outer container. - - -
        palletExchangeCode string Pallet exchange code. Pass thru mapping. - - -
        palletBlockCount number Pallet blocks. The number of pieces -- cases, etc -- per pallet layer. - - -
        itemWeight array Order weight at parent packaging level. - - -
          weightType string

Type of weight recorded at parent packaging level.

Valid values:

  • ALLOWED

  • GROSS

  • LOADING

  • NET

  • TOTALPACKAGING

  • TARE

 - - -
          weightValue Number Weight of product at the parent packaging aggregation level. - - -
          unitOfMeasure string Weight unit of measure in master data for product. - - -
        itemVolume array Product volume at parent packaging level. - - -
          volumeType string

Type of volume recorded at parent packaging level.

Valid values include:

  • ALLOWED

  • LOADING

  • TARE

  • TOTAL

  • TOTALPACKAGING

 - - -
          volumeValue Number Volume for item. - - -
          unitOfMeasure string Volume unit of measure. - - -
        itemDimensions array Dimensions at parent packaging level. - - -
          dimensionsType string

Type of volume recorded at parent packaging level.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

- - -
          dimensionsValue Number Volume for item. - - -
          unitOfMeasure string Dimension unit of measure. - - -
        freeTextNote array Free text, instructions, notes, descriptions and other free text elements. - - -
          textReferenceCode string Text reference or subject code. Will map whatever is found. - - -
          textFunctionCode string Text function code. Will map whatever is found. - - -
          language string Language of free text. - - -
          textFormatCode string Format code for free text. - - -
          freeFormText string, array Free text array. - - -
        packagedProduct array Packaged product level aggregation hierarchy as child of preceding parent. - - -
          purchaseOrderIdentifier string Purchase order identifier number. - - -
          purchaseOrderLineItem   Purchase order line item number. - - -
          hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
          hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
          packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

  • EA - Each

 - - -
          packagingContentsType string

Relevant for SAP. Type of Handling-unit Item Content. SAP values include:

  • 1 - Saleable item

  • 2 - Auxiliary packing item

  • 3 - Handling unit (packing item: pack, inner pack, etc.)

 - - -
          packagingIdentifier string Packaging identifier if child product a pallet, case or bundle. - - -
          deliveryDocumentIdentifier string Delivery document identifier if child an each. - - -
          deliveryDocumentLineItem string Delivery document line item number for child each. - - -
          packagedProductIdentifier string Product code identifier for product packed into aggregation. - - -
          itemQuantity   Quantity of product packed into parent container for each. - - -
            quantityType string

Type of quantity recorded.

Valid value is PACKAGED.

 - - -
            quantityValue number Quantity of product in delivery. - - -
            unitOfMeasure string Unit of measure for delivery quantity. - - -
          lotNumber string Lot or batch identifier for aggregated product. - - -
          plantIdentifier string Plant identifier. - - -
          storageLocation string Storage location for aggregated product. - - -
          externalItemIdentifier string Material belonging to the customer. E1EDL37 / E1EDL44 / KDMAT - -
        parentPackagingLevel2 array Parent packaging aggregation hierarchy iteration 2. This could be any of a pallet, case, bundle, or any other packaging unit type. - - -
          purchaseOrderIdentifier string Purchase order identifier number. - - -
          hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
          hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
          packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

  • EA - Each

 - - -
          packagingIdentifier string Packaging identifier used for the parent level physical packing aggregation for delivery. - - -
          packagingIdentifierType string

Packaging identifier format type used for parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
          alternatePackagingIdentifier string External packaging identifier used for the parent level physical packing aggregation for delivery. - - -
          alternatePackagingIdentifierType string

External packaging identifier type used for the parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
          packagingMaterialCode string Descriptive code for packaging materials. - - -
          packagingMaterialType string Packaging materials type. - - -
          packagingMaterialTypeDescription string Description of packaging materials type. - - -
          packagingMaterialCategory string Packaging materials category. - - -
          customerPackagingMaterial string Customer packaging material. - - -
          partnerPackagingMaterial string Partner (customer or supplier or other) packaging material. - - -
          packagingMaterialDescription string Description of packaging material. - - -
          packagingMaterialTagIdentifier string SMG identification for material tag. - - -
          packagingMaterialStatus string Packaging material status. - - -
          palletTiers number Pallet tiers. The number of layers per pallet. - - -
          quantityPacked number Pack. The number of inner containers, or eaches if no inner containers, per outer container. - - -
          palletExchangeCode string Pallet exchange code. Pass thru mapping. - - -
          palletBlockCount number Pallet blocks. The number of pieces -- cases, etc -- per pallet layer. - - -
          itemWeight array Order weight at parent packaging level. - - -
            weightType string

Type of weight recorded at parent packaging level.

Valid values:

  • ALLOWED

  • GROSS

  • LOADING

  • NET

  • TOTALPACKAGING

  • TARE

- - -
            weightValue Number Weight of product at the parent packaging aggregation level. - - -
            unitOfMeasure string Weight unit of measure in master data for product. - - -
          itemVolume array Product volume at parent packaging level. - - -
            volumeType string

Type of volume recorded at parent packaging level.

Valid values include:

  • ALLOWED

  • LOADING

  • TARE

  • TOTAL

  • TOTALPACKAGING

- - -
            volumeValue Number Volume for item. - - -
            unitOfMeasure string Volume unit of measure. - - -
          itemDimensions array Dimensions at parent packaging level. - - -
            dimensionsType string

Type of volume recorded at parent packaging level.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

- - -
            dimensionsValue Number Volume for item. - - -
            unitOfMeasure string Dimension unit of measure. - - -
          packagedProduct array Packaged product level aggregation hierarchy as child of preceding parent. - - -
            purchaseOrderIdentifier string Purchase order identifier number. - - -
            purchaseOrderLineItem   Purchase order line item number. - - -
            hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
            hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
            packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

  • EA - Each

 - - -
            packagingContentsType string

Relevant for SAP. Type of Handling-unit Item Content. SAP values include:

  • 1 - Saleable item

  • 2 - Auxiliary packing item

  • 3 - Handling unit (packing item: pack, inner pack, etc.)

 - - -
            packagingIdentifier string Packaging identifier if child product a pallet, case or bundle. - - -
            deliveryDocumentIdentifier string Delivery document identifier if child an each. - - -
            deliveryDocumentLineItem string Delivery document line item number for child each. - - -
            packagedProductIdentifier string Product code identifier for product packed into aggregation. - - -
            itemQuantity   Quantity of product packed into parent container for each. - - -
              quantityType string

Type of quantity recorded.

Valid value is PACKAGED.

 - - -
              quantityValue number Quantity of product in delivery. - - -
              unitOfMeasure string Unit of measure for delivery quantity. - - -
            lotNumber string Lot or batch identifier for aggregated product. - - -
            plantIdentifier string Plant identifier. - - -
            storageLocation string Storage location for aggregated product. - - -
          parentPackagingLevel3 array Parent packaging aggregation hierarchy iteration 3. This could be any of a pallet, case, bundle, or any other packaging unit type. - - -
            purchaseOrderIdentifier string Purchase order identifier number. - - -
            hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
            hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
            packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

- - -
            packagingIdentifier string Packaging identifier used for the parent level physical packing aggregation for delivery. - - -
            packagingIdentifierType string

Packaging identifier format type used for parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
            alternatePackagingIdentifier string External packaging identifier used for the parent level physical packing aggregation for delivery. - - -
            alternatePackagingIdentifierType string

External packaging identifier type used for the parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
            packagingMaterialCode string Descriptive code for packaging materials. - - -
            packagingMaterialType string Packaging materials type. - - -
            packagingMaterialTypeDescription string Description of packaging materials type. - - -
            packagingMaterialCategory string Packaging materials category. - - -
            customerPackagingMaterial string Customer packaging material. - - -
            partnerPackagingMaterial string Partner (customer or supplier or other) packaging material. - - -
            packagingMaterialDescription string Description of packaging material. - - -
            packagingMaterialTagIdentifier string SMG identification for material tag. - - -
            packagingMaterialStatus string Packaging material status. - - -
            palletTiers number Pallet tiers. The number of layers per pallet. - - -
            quantityPacked number Pack. The number of inner containers, or eaches if no inner containers, per outer container. - - -
            palletExchangeCode string Pallet exchange code. Pass thru mapping. - - -
            palletBlockCount number Pallet blocks. The number of pieces -- cases, etc -- per pallet layer. - - -
            itemWeight array Order weight at parent packaging level. - - -
              weightType string

Type of weight recorded at parent packaging level.

Valid values:

  • ALLOWED

  • GROSS

  • LOADING

  • NET

  • TOTALPACKAGING

  • TARE

- - -
              weightValue Number Weight of product at the parent packaging aggregation level. - - -
              unitOfMeasure string Weight unit of measure in master data for product. - - -
            itemVolume array Product volume at parent packaging level. - - -
              volumeType string

Type of volume recorded at parent packaging level.

Valid values include:

  • ALLOWED

  • LOADING

  • TARE

  • TOTAL

  • TOTALPACKAGING

- - -
              volumeValue Number Volume for item. - - -
              unitOfMeasure string Volume unit of measure. - - -
            itemDimensions array Dimensions at parent packaging level. - - -
              dimensionsType string

Type of volume recorded at parent packaging level.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

- - -
              dimensionsValue Number Volume for item. - - -
              unitOfMeasure string Dimension unit of measure. - - -
            packagedProduct array Packaged product level aggregation hierarchy as child of preceding parent. - - -
              purchaseOrderIdentifier string Purchase order identifier number. - - -
              purchaseOrderLineItem - Purchase order line item number. - - -
              hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
              hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
              packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

  • EA - Each

 - - -
              packagingContentsType string

Relevant for SAP. Type of Handling-unit Item Content.

SAP values include:

  • 1 - Saleable item

  • 2 - Auxiliary packing item

  • 3 - Handling unit (packing item: pack, inner pack, etc.)

 - - -
              packagingIdentifier string Packaging identifier if child product a pallet, case or bundle. - - -
              deliveryDocumentIdentifier string Delivery document identifier if child an each. - - -
              deliveryDocumentLineItem string Delivery document line item number for child each. - - -
              packagedProductIdentifier string Product code identifier for product packed into aggregation. - - -
              itemQuantity - Quantity of product packed into parent container for each. - - -
                quantityType string

Type of quantity recorded.

Valid value is PACKAGED.

 - - -
                quantityValue number Quantity of product in delivery. - - -
                unitOfMeasure string Unit of measure for delivery quantity. - - -
              lotNumber string Lot or batch identifier for aggregated product. - - -
              plantIdentifier string Plant identifier. - - -
              storageLocation string Storage location for aggregated product. - - -
            parentPackagingLevel4 array

Parent packaging aggregation hierarchy iteration 4.

This could be any of a pallet, case, bundle, or any other packaging unit type.

 - - -
              purchaseOrderIdentifier string Purchase order identifier number. - - -
              hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
              hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
              packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

- - -
              packagingIdentifier string Packaging identifier used for the parent level physical packing aggregation for delivery. - - -
              packagingIdentifierType string

Packaging identifier format type used for parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
              alternatePackagingIdentifier string External packaging identifier used for the parent level physical packing aggregation for delivery. - - -
              alternatePackagingIdentifierType string

External packaging identifier type used for the parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
              packagingMaterialCode string Descriptive code for packaging materials. - - -
              packagingMaterialType string Packaging materials type. - - -
              packagingMaterialTypeDescription string Description of packaging materials type. - - -
              packagingMaterialCategory string Packaging materials category. - - -
              customerPackagingMaterial string Customer packaging material. - - -
              partnerPackagingMaterial string Partner (customer or supplier or other) packaging material. - - -
              packagingMaterialDescription string Description of packaging material. - - -
              packagingMaterialTagIdentifier string SMG identification for material tag. - - -
              packagingMaterialStatus string Packaging material status. - - -
              palletTiers number Pallet tiers. The number of layers per pallet. - - -
              quantityPacked number Pack. The number of inner containers, or eaches if no inner containers, per outer container. - - -
              palletExchangeCode string Pallet exchange code. Pass thru mapping. - - -
              palletBlockCount number Pallet blocks. The number of pieces - cases, etc - per pallet layer. - - -
              itemWeight array Order weight at parent packaging level. - - -
                weightType string

Type of weight recorded at parent packaging level.

Valid values:

  • ALLOWED

  • GROSS

  • LOADING

  • NET

  • TOTALPACKAGING

  • TARE

- - -
                weightValue Number Weight of product at the parent packaging aggregation level. - - -
                unitOfMeasure string Weight unit of measure in master data for product. - - -
              itemVolume array Product volume at parent packaging level. - - -
                volumeType string

Type of volume recorded at parent packaging level.

Valid values include:

  • ALLOWED

  • LOADING

  • TARE

  • TOTAL

  • TOTALPACKAGING

- - -
                volumeValue Number Volume for item. - - -
                unitOfMeasure string Volume unit of measure. - - -
              itemDimensions array Dimensions at parent packaging level. - - -
                dimensionsType string

Type of volume recorded at parent packaging level.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

- - -
                dimensionsValue Number Volume for item. - - -
                unitOfMeasure string Dimension unit of measure. - - -
              packagedProduct array Packaged product level aggregation hierarchy as child of preceding parent. - - -
                purchaseOrderIdentifier string Purchase order identifier number. - - -
                purchaseOrderLineItem   Purchase order line item number. - - -
                hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
                hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
                packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

  • EA - Each

 - - -
                packagingContentsType string

Relevant for SAP. Type of Handling-unit Item Content.

SAP values include:

  • 1 - Saleable item

  • 2 - Auxiliary packing item

  • 3 - Handling unit (packing item: pack, inner pack, etc.)

 - - -
                packagingIdentifier string Packaging identifier if child product a pallet, case or bundle. - - -
                deliveryDocumentIdentifier string Delivery document identifier if child an each. - - -
                deliveryDocumentLineItem string Delivery document line item number for child each. - - -
                packagedProductIdentifier string Product code identifier for product packed into aggregation. - - -
                itemQuantity   Quantity of product packed into parent container for each. - - -
                  quantityType string

Type of quantity recorded.

Valid value is PACKAGED.

 - - -
                  quantityValue number Quantity of product in delivery. - - -
                  unitOfMeasure string Unit of measure for delivery quantity. - - -
                lotNumber string Lot or batch identifier for aggregated product. - - -
                plantIdentifier string Plant identifier. - - -
                storageLocation string Storage location for aggregated product. - - -
              parentPackagingLevel5 array Parent packaging aggregation hierarchy iteration 5. This could be any of a pallet, case, bundle, or any other packaging unit type. - - -
                purchaseOrderIdentifier string Purchase order identifier number. - - -
                hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
                hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
                packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

- - -
                packagingIdentifier string Packaging identifier used for the parent level physical packing aggregation for delivery. - - -
                packagingIdentifierType string

Packaging identifier format type used for parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
                alternatePackagingIdentifier string External packaging identifier used for the parent level physical packing aggregation for delivery. - - -
                alternatePackagingIdentifierType string

External packaging identifier type used for the parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
                packagingMaterialCode string Descriptive code for packaging materials. - - -
                packagingMaterialType string Packaging materials type. - - -
                packagingMaterialTypeDescription string Description of packaging materials type. - - -
                packagingMaterialCategory string Packaging materials category. - - -
                customerPackagingMaterial string Customer packaging material. - - -
                partnerPackagingMaterial string Partner (customer or supplier or other) packaging material. - - -
                packagingMaterialDescription string Description of packaging material. - - -
                packagingMaterialTagIdentifier string SMG identification for material tag. - - -
                packagingMaterialStatus string Packaging material status. - - -
                palletTiers number Pallet tiers. The number of layers per pallet. - - -
                quantityPacked number Pack. The number of inner containers, or eaches if no inner containers, per outer container. - - -
                palletExchangeCode string Pallet exchange code. Pass thru mapping. - - -
                palletBlockCount number Pallet blocks. The number of pieces - cases, etc - per pallet layer. - - -
                itemWeight array Order weight at parent packaging level. - - -
                  weightType string

Type of weight recorded at parent packaging level.

Valid values:

  • ALLOWED

  • GROSS

  • LOADING

  • NET

  • TOTALPACKAGING

  • TARE

- - -
                  weightValue Number Weight of product at the parent packaging aggregation level. - - -
                  unitOfMeasure string Weight unit of measure in master data for product. - - -
                itemVolume array Product volume at parent packaging level. - - -
                  volumeType string

Type of volume recorded at parent packaging level.

Valid values include:

  • ALLOWED

  • LOADING

  • TARE

  • TOTAL

  • TOTALPACKAGING

- - -
                  volumeValue Number Volume for item. - - -
                  unitOfMeasure string Volume unit of measure. - - -
                itemDimensions array Dimensions at parent packaging level. - - -
                  dimensionsType string

Type of volume recorded at parent packaging level.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

- - -
                  dimensionsValue Number Volume for item. - - -
                  unitOfMeasure string Dimension unit of measure. - - -
                packagedProduct array Packaged product level aggregation hierarchy as child of preceding parent. - - -
                  purchaseOrderIdentifier string Purchase order identifier number. - - -
                  purchaseOrderLineItem   Purchase order line item number. - - -
                  hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
                  hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
                  packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

  • EA - Each

 - - -
                  packagingContentsType  

Relevant for SAP. Type of Handling-unit Item Content.

SAP values include:

  • 1 - Saleable item

  • 2 - Auxiliary packing item

  • 3 - Handling unit (packing item: pack, inner pack, etc.)

 - - -
                  packagingIdentifier   Packaging identifier if child product a pallet, case or bundle. - - -
                  deliveryDocumentIdentifier   Delivery document identifier if child an each. - - -
                  deliveryDocumentLineItem   Delivery document line item number for child each. - - -
                  packagedProductIdentifier   Product code identifier for product packed into aggregation. - - -
                  itemQuantity   Quantity of product packed into parent container for each. - - -
                    quantityType string

Type of quantity recorded.

Valid value is PACKAGED.

 - - -
                    quantityValue number Quantity of product in delivery. - - -
                    unitOfMeasure string Unit of measure for delivery quantity. - - -
                  lotNumber string Lot or batch identifier for aggregated product. - - -
                  plantIdentifier string Plant identifier. - - -
                  storageLocation string Storage location for aggregated product. - - -
                parentPackagingLevel6 array

Parent packaging aggregation hierarchy iteration 6.

This could be any of a pallet, case, bundle, or any other packaging unit type.

 - - -
                  purchaseOrderIdentifier string Purchase order identifier number. - - -
                  hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
                  hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
                  packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

- - -
                  packagingIdentifier string Packaging identifier used for the parent level physical packing aggregation for delivery. - - -
                  packagingIdentifierType string

Packaging identifier format type used for parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
                  alternatePackagingIdentifier string External packaging identifier used for the parent level physical packing aggregation for delivery. - - -
                  alternatePackagingIdentifierType string

External packaging identifier type used for the parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
                  packagingMaterialCode string Descriptive code for packaging materials. - - -
                  packagingMaterialType string Packaging materials type. - - -
                  packagingMaterialTypeDescription string Description of packaging materials type. - - -
                  packagingMaterialCategory string Packaging materials category. - - -
                  customerPackagingMaterial string Customer packaging material. - - -
                  partnerPackagingMaterial string Partner (customer or supplier or other) packaging material. - - -
                  packagingMaterialDescription string Description of packaging material. - - -
                  packagingMaterialTagIdentifier string SMG identification for material tag. - - -
                  packagingMaterialStatus string Packaging material status. - - -
                  palletTiers number Pallet tiers. The number of layers per pallet. - - -
                  quantityPacked number Pack. The number of inner containers, or eaches if no inner containers, per outer container. - - -
                  palletExchangeCode string Pallet exchange code. Pass thru mapping. - - -
                  palletBlockCount number Pallet blocks. The number of pieces -- cases, etc -- per pallet layer. - - -
                  itemWeight array Order weight at parent packaging level. - - -
                    weightType string

Type of weight recorded at parent packaging level.

Valid values:

  • ALLOWED

  • GROSS

  • LOADING

  • NET

  • TOTALPACKAGING

  • TARE

- - -
                    weightValue Number Weight of product at the parent packaging aggregation level. - - -
                    unitOfMeasure string Weight unit of measure in master data for product. - - -
                  itemVolume array Product volume at parent packaging level. - - -
                    volumeType string

Type of volume recorded at parent packaging level.

Valid values include:

  • ALLOWED

  • LOADING

  • TARE

  • TOTAL

  • TOTALPACKAGING

- - -
                    volumeValue Number Volume for item. - - -
                    unitOfMeasure string Volume unit of measure. - - -
                  itemDimensions array Dimensions at parent packaging level. - - -
                    dimensionsType string

Type of volume recorded at parent packaging level.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

- - -
                    dimensionsValue Number Volume for item. - - -
                    unitOfMeasure string Dimension unit of measure. - - -
                  packagedProduct array Packaged product level aggregation hierarchy as child of preceding parent. - - -
                    purchaseOrderIdentifier string Purchase order identifier number. - - -
                    purchaseOrderLineItem   Purchase order line item number. - - -
                    hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
                    hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
                    packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

  • EA - Each

 - - -
                    packagingContentsType  

Relevant for SAP. Type of Handling-unit Item Content.

SAP values include:

  • 1 - Saleable item

  • 2 - Auxiliary packing item

  • 3 - Handling unit (packing item: pack, inner pack, etc.)

 - - -
                    packagingIdentifier   Packaging identifier if child product a pallet, case or bundle. - - -
                    deliveryDocumentIdentifier   Delivery document identifier if child an each. - - -
                    deliveryDocumentLineItem   Delivery document line item number for child each. - - -
                    packagedProductIdentifier   Product code identifier for product packed into aggregation. - - -
                    itemQuantity   Quantity of product packed into parent container for each. - - -
                      quantityType string

Type of quantity recorded.

Valid value is PACKAGED.

 - - -
                      quantityValue number Quantity of product in delivery. - - -
                      unitOfMeasure string Unit of measure for delivery quantity. - - -
                    lotNumber   string Lot or batch identifier for aggregated product. - - -
                    plantIdentifier string Plant identifier. - - -
                    storageLocation string Storage location for aggregated product. - - -
                  parentPackagingLevel7 array Parent packaging aggregation hierarchy iteration 7. This could be any of a pallet, case, bundle, or any other packaging unit type. - - -
                    purchaseOrderIdentifier string Purchase order identifier number. - - -
                    hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
                    hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
                    packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

- - -
                    packagingIdentifier string Packaging identifier used for the parent level physical packing aggregation for delivery. - - -
                    packagingIdentifierType string

Packaging identifier format type used for parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
                    alternatePackagingIdentifier string External packaging identifier used for the parent level physical packing aggregation for delivery. - - -
                    alternatePackagingIdentifierType string

External packaging identifier type used for the parent level physical packing aggregation for delivery.

Valid values:

  • SSCC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

- - -
                    packagingMaterialCode string Descriptive code for packaging materials. - - -
                    packagingMaterialType string Packaging materials type. - - -
                    packagingMaterialTypeDescription string Description of packaging materials type. - - -
                    packagingMaterialCategory string Packaging materials category. - - -
                    customerPackagingMaterial string Customer packaging material. - - -
                    partnerPackagingMaterial string Partner (customer or supplier or other) packaging material. - - -
                    packagingMaterialDescription string Description of packaging material. - - -
                    packagingMaterialTagIdentifier string SMG identification for material tag. - - -
                    packagingMaterialStatus string Packaging material status. - - -
                    palletTiers number Pallet tiers. The number of layers per pallet. - - -
                    quantityPacked number Pack. The number of inner containers, or eaches if no inner containers, per outer container. - - -
                    palletExchangeCode string Pallet exchange code. Pass thru mapping. - - -
                    palletBlockCount number Pallet blocks. The number of pieces -- cases, etc -- per pallet layer. - - -
                    itemWeight array Order weight at parent packaging level. - - -
                      weightType string

Type of weight recorded at parent packaging level.

Valid values:

  • ALLOWED

  • GROSS

  • LOADING

  • NET

  • TOTALPACKAGING

  • TARE

 - - -
                      weightValue Number Weight of product at the parent packaging aggregation level. - - -
                      unitOfMeasure string Weight unit of measure in master data for product. - - -
                    itemVolume array Product volume at parent packaging level. - - -
                      volumeType string

Type of volume recorded at parent packaging level.

Valid values include:

  • ALLOWED

  • LOADING

  • TARE

  • TOTAL

  • TOTALPACKAGING

 - - -
                      volumeValue Number Volume for item. - - -
                      unitOfMeasure string Volume unit of measure. - - -
                    itemDimensions array Dimensions at parent packaging level. - - -
                      dimensionsType string

Type of volume recorded at parent packaging level.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

 - - -
                      dimensionsValue Number Volume for item. - - -
                      unitOfMeasure string Dimension unit of measure. - - -
                    packagedProduct array Packaged product level aggregation hierarchy as child of preceding parent. - - -
                      purchaseOrderIdentifier string Purchase order identifier number. - - -
                      purchaseOrderLineItem   Purchase order line item number. - - -
                      hierarchicalIdentifier string Hierarchical identifier: A unique number assigned by the sender to identify a particular data segment within a hierarchical structure, equivalent to HL01 in the X12 ASN and CPS010 in the EDIFACT DESADV message. - - -
                      hierarchicalParentIdentifer string Hierarchical parent identifier points to the parent segment that the current segment is a child of. - - -
                      packagingLevel string

Parent level packaging type used in the physical packing aggregation for delivery.

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

  • EA - Each

 - - -
                      packagingContentsType  

Relevant for SAP. Type of Handling-unit Item Content.

SAP values include:

  • 1 - Saleable item

  • 2 - Auxiliary packing item

  • 3 - Handling unit (packing item: pack, inner pack, etc.)

 - - -
                      packagingIdentifier   Packaging identifier if child product a pallet, case or bundle. - - -
                      deliveryDocumentIdentifier   Delivery document identifier if child an each. - - -
                      deliveryDocumentLineItem   Delivery document line item number for child each. - - -
                      packagedProductIdentifier   Product code identifier for product packed into aggregation. - - -
                      itemQuantity   Quantity of product packed into parent container for each. - - -
                        string

Type of quantity recorded.

Valid value is PACKAGED.

 - - -
                        number Quantity of product in delivery. - - -
                        string Unit of measure for delivery quantity. - - -
                      lotNumber string Lot or batch identifier for aggregated product. - - -
                      plantIdentifier string Plant identifier. - - -
                      storageLocation string Storage location for aggregated product. - - -

Tag end