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,

Warehouse shipping order canonical guidelines

Warehouse shipping orders allow companies to exchange data with their remote warehouses or third-party warehouse Partners about requests for purchased product to be shipped to a buyer's location without giving these Partners access to their serialization system of record. Warehouse shipping orders can be used to request that products in a given purchase order be shipped to a buyer's location from a supplier's remote or third-party warehouses and confirm that the supplier's remote warehouses or third-party warehouses has shipped the requested product via a warehouse shipping advice.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping;
canonicalWarehouseShipOrder – 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. – – –
    canonicalWarehouseShipOrderHeader – 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 – – –
      warehouseIdentifier string Warehouse number, warehouse complex – – –
      receivingPointCode string Code for warehouse or other location in which the goods will be received – – –
      consigneeCustomerIdentifier string Customer ID used by consignee – – –
      orderType string Identifies different kind of orders, which might be handled by different processes. Pass thru mapping. – – –
      transactionReferenceIdentifierList array Transaction references for deliveries and ASN at header level – – –
        b2bTransactionIdentifierType string

Referenced document type.

Valid values include:

  • DELIVERY

  • BOL

  • SHIPMENT

  • REFERENCE

  • CONSIGNEEORDER

  • CARRIERREFERENCE

  • SUPPLIERORDER

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. – – –
      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

– – –
      isReturn boolean

Attribute to identify if this transaction is a vendor return.

  • True : Vendor return

  • False: Regular warehouse ship order

 – – –
      warehouseIdentifier string Warehouse number. – – –
      packagingUOM string

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

Valid values:

  • PL - Pallet

  • CA - Case

 – – –
      serviceLevelCode string This value can be used for carrier determination. – – –
      serviceType string This value can be used for carrier determination. – – –
      isBonded boolean

Specifies whether stock declared on order line is bonded or not.

Valid values:

  • True – 1 – Product is bonded

  • False – 0 – Product is not bonded (default)

 – – –
      isTransit boolean

Specifies whether stock with a different bonded status than the order can be received.

Valid values:

  • True – 1 – Different bonded status can be received

  • False – 0 – Different bonded status can NOT be received (default)

 – – –
      carrierCode string

Identification code of the carrier associated with this order.

This field indicates that a specific carrier should be used for the delivery of this order.

 – – –
      orderedBy string

Identifies person, branch, department, company, etc. who raised the order.

– – –
      isTaxed boolean

Specifies whether stock declared on order line is taxed or not.

Valid values:

  • True – 1 – Product is taxed

  • False – 0 – Product is not taxed (default)

 – – –
      partialDeliveries string

Partial delivery string flag.

For K+N the following values are valid:

  • 0 – Only full shipments allowed

  • 1 – Partial shipments allowed client order closes

  • 2 – Partial shipments allowed client order remains open

 – – –
      isConsigneePreAdvice boolean

Specifies whether consignee should book an appointment should be booked or not.

Valid values:

  • True - 1 - Appointment will be booke

  • False - 0 - Appointment will NOT be booked

 – – –
      isDeliveryDateFixed boolean

Specifies whether the date sent by customer is the fixed and required delivery date.

Valid values:

  • True – 1 – Delivery date is fixed

  • False – 0 – Delivery date is not fixed

 – – –
      customsContactCode string Booking key for client customs clearance Contact Details. – – –
      routeIdentifier string Route code, for transport planning. – – –
      shipmentCode string Shipment code for transport planning. – – –
      transportMethod string Transportation method. – – –
      totalItemPriceValue – Segment recording total value of goods in message. – – –
        priceValue number Total price value for items ordered in message. – – –
        currencyCode string Currency code for price value. – – –
      totalAmountSubjectToVAT – Segment recording total value in message subject to VAT tax. – – –
        priceValue number Total price value for items subject to VAT. – – –
        currencyCode string Currency code for price value. – – –
      totalVATAmount – Segment recording total amount of VAT. – – –
        priceValue number Total VAT price value. – – –
        currencyCode string Currency code for price value. – – –
      totalInvoiceAmount – Segment recording total amount of invoice. – – –
        priceValue number Total amount of invoice. – – –
        currencyCode string Currency code for price value. – – –
      mpcASNDateRanges array Delivery ASN dates at header level. – – –
        mpcAsnDateRangeType string

Qualifier identifying purpose of date range.

Valid values:

  • PLANNED

  • ACTUAL

– – –
        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 for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code. – – –
          postalArea string Postal area. – – –
          emailAddress string Email address. – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name. – – –
          contactTitle string Title of contact. – – –
          contactPhone string Contact phone number. – – –
          contactEmail string Contact email address. – – –
      consigneeBusinessInformation – Consignee party company identifiers and address information. – N101 = "CN" –
        businessName string Business name for partner or location. – N102 –
        additionalBusinessName string Additional business name for partner or location. – N201 –
        mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
          companyIdentifierType string Regulatory company identifier type for business partner. –

  • N103 = 1 (DUNS) or

  • N103 = 9 (DUNS4) or

  • N103 = 11 (DEA) or

  • N103 = 21 (HIN) or

  • N103 = 91 (COMPANYID) or

  • N103 = 92 (COMPANYSITEID) or

  • N103 = UL (GLN)

 –
          companyIdentifierValue string Company identifier value for business partner. – N104 –
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
        address – Party address information. – – –
          address1 string Main street address. – N301 –
          address2 string Supplemental street address. – N302 –
          city string City – N401 –
          state string State or region code. – N402 –
          postalCode string Postal code – N403 –
          country string Country code – N404 –
          telephone string Telephone number – – –
          fax string Fax number – – –
          url string Website URL – – –
          buildingNumber string Building number – – –
          plantNumber string Plant number – – –
          floorNumber string Floor number in building – – –
          lscAddressIdentifier string LSC address identifier – – –
          village string Village name – – –
          houseNumber string House number – – –
          township string Township – – –
          premisesCode string Premises code – – –
        mpcAdditionalAddressInformation – Additional address information. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code. – – –
          postalArea string Postal area – – –
          emailAddress string Email address – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number. – – –
          contactEmail string Contact email address. – – –
      supplierBusinessInformation – Supplier party company identifiers and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code. – – –
          postalArea string Postal area – – –
          emailAddress string Email address – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number – – –
          contactEmail string Contact email address – – –
      thirdPartyLogisticsInformation – Third party business identifiers and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code – – –
          postalArea string Postal area – – –
          emailAddress string Email address – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number – – –
          contactEmail string Contact email address. – – –
      shipFromLocationInformation – Ship from location identifiers and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code. – – –
          postalArea string Postal area – – –
          emailAddress string Email address – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number. – – –
          contactEmail string Contact email address. – – –
      shipToLocationInformation – Ship to location identifiers and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code – – –
          postalArea string Postal area – – –
          emailAddress string Email address – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number. – – –
          contactEmail string Contact email address. – – –
      salesOrganizationInformation – Supplier's sales organization identifier and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code. – – –
          postalArea string Postal area. – – –
          emailAddress string Email address. – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number – – –
          contactEmail string Contact email address – – –
      distributorBusinessInformation – Distributors business identifiers and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code – – –
          postalArea string Postal area – – –
          emailAddress string Email address – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number. – – –
          contactEmail string Contact email address. – – –
      billToBusinessInformation   Bill to party's business identifiers and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code. – – –
          postalArea string Postal area – – –
          emailAddress string Email address – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number. – – –
          contactEmail string Contact email address. – – –
      remitToBusinessInformation – Remit to party's business identifiers and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number – – –
          taxExemptCode string Tax exempt code – – –
          postalArea string Postal area – – –
          emailAddress string Email address – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number – – –
          contactEmail string Contact email address – – –
      carrierInformation array Carrier party or parties company identifiers and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code – – –
          postalArea string Postal area – – –
          emailAddress string Email address – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number – – –
          contactEmail string Contact email address – – –
      manufacturerBusinessInformation – Manufacturing party's company identifiers and address information. – – –
        businessName string Business name for partner or location. – – –
        additionalBusinessName string Additional business name for partner or location. – – –
        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 – – –
          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. – – –
          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. – – –
          telephone string Additional telephone number. – – –
          vatRegistrationNumber string VAT registration number. – – –
          taxExemptCode string Tax exempt code. – – –
          postalArea string Postal area. – – –
          emailAddress string Email address. – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number. – – –
          contactEmail string Contact email address. – – –
      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.

The 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 values include:

  • 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. The 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. – – –
        shippingRouteDescription string Description of the shipment routing code. – – –
        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

  • RAILCAR

  • 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. – – –
      invoiceInformation – Overview of key invoice information for shipment. – – –
        invoiceNumber string Invoice identifier. – – –
        documentDate string Invoice date. – – –
        countryOfOrigin string Country from which invoiced shipment originated. – – –
        totalInvoiceAmount – Segment recording total amount of invoice. – – –
          priceValue number Total amount of invoice. – – –
          currencyCode string Currency code for price value. – – –
        invoiceCostDetails – Segment recording details of the invoice cost. – – –
          costType string

Cost type for invoice.

Valid values:

  • FREIGHT

  • INSURANCE

  • OTHER

– – –
          priceValue number Price of cost detail. – – –
          currencyCode string Currency code for price value. – – –
      freeTextNote array Free text, instructions, notes, descriptions and other free text elements. – – –
        textReferenceCode string Text reference or subject code. – – –
        textFunctionCode string Text function code. – – –
        language string Language of free text. – – –
        textFormatCode string Format code for free text. – – –
        freeFormText string, array Free text array. – – –
    canonicalWarehouseShipOrderItemDetails array Advance Ship Notification Aggregated items details. – – –
      lineItemNumber string ASN item detail line item number. – – –
      processingFunctionTypeCode string

Purpose of purchase order.

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

 – – –
      lineType string Line type. – – –
      packagingIdentifiers array Packaging identifiers used at the line item level. – – –
        packagingLevel string

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

Valid values:

  • PL - Pallet

  • CA - Case

  • PK - Inner pack bundles

 – – –
        packagingIdentifierType string

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

Valid values:

  • SCAC

  • PALLETNUMBER

  • CARRIERASSIGNED

  • SHIPPERASSIGNED

  • UCC-EAN128

– – –
        packagingIdentifier string Packaging identifier value. – – –
      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:

  • GTIN-14

  • NTIN

  • CN-RESCODE

  • VENDORPARTNUM

  • UPC

  • SKU

  • CUSTOMER

  • SUPPLIER

  • MANUFACTURER

– – –
        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, such as, third-party supplier, customer, etc. – – –
      expirationDate date Lot expiration date. – – –
      additionalProductReferences – Additional product references. – – –
        additionalProductReference string Additional product reference or attribute. Pass thru mapping. – – –
        productDate string Additional product reference or attribute date value in date format YYYY-MM-DD. – – –
        epochProductDate long Additional product reference or attribute date value in epoch date format. – – –
      additionalProductReferences2 – Additional product references. – – –
        additionalProductReference string Additional product reference or attribute. Pass thru mapping. – – –
        productDate string Additional product reference or attribute date value in date format YYYY-MM-DD. – – –
        epochProductDate long Additional product reference or attribute date value in epoch date format. – – –
      additionalProductReferences3 – Additional product references. – – –
        additionalProductReference string Additional product reference or attribute. Pass thru mapping. – – –
        productDate string Additional proeduct reference or attribute date value in date format YYYY-MM-DD. – – –
        epochProductDate long Additional product reference or attribute date value in epoch date format. – – –
      stockStatusCode string Status of the goods to be dispatched. – – –
      consignmentIdentifier string Identifier for consignment the stock declared on this line belongs to. – – –
      isCaptureSerialNumbers boolean

Specifies whether serial numbers have to be captured during the outbound process.

Valid values:

  • True – 1 – Capture serial numbers

  • False – 0 – Do not capture serial numbers (default)

 – – –
      isBonded boolean

Specifies whether stock declared on order line is bonded or not.

Valid values:

  • True – 1 – Product is bonded

  • False – 0 – Product is not bonded (default)

 – – –
      isTaxed boolean

Specifies whether stock declared on order line is taxed or not.

Valid values:

  • True – 1 – Product is taxed

  • False – 0 – Product is not taxed (default)

 – – –
      warehouseIdentifier string Warehouse / warehouse complex identifier. Identification of warehousing client that is used throughout the system. – – –
      productCodeValue string Product code identifier value. – – –
      pricingUnitNumerator string Number of pieces for which the unit price is applied to, for example, 1000 pieces of article A have a price of 5,00 EUR (unit price). – – –
      taxCode string Qualifier identifying VAT code. – – –
      rateOfTax number Rate for VAT or other tax type. – – –
      externalCaseIdentifier string External case number. – – –
      countryOfOrigin string Country of origin for product. – – –
      expiryLeadTimeValue number Number of days before expiry date when goods cannot be shipped anymore. – – –
      itemQuantity array Order quantity at line item level. – – –
        quantityType string

Type of quantity recorded.

Valid values include:

  • DELIVERYQUANTITY

  • ORDERQUANTITY

  • SHIPPEDTODATE

  • ITEM

  • STOCKKEEPING

– – –
        quantityValue number Quantity of product in delivery. – – –
        unitOfMeasure string Unit of measure for delivery quantity. – – –
      unitPriceValue – Segment recording total value of goods in message. – – –
        priceValue number Total price value for items ordered in message. – – –
        currencyCode string Currency code for price value. – – –
      totalItemPriceValue – Segment recording total value of goods in message. – – –
        priceValue number Total price value for items ordered in message. – – –
        currencyCode string Currency code for price value. – – –
      itemWeight array Order weight at line item level. – – –
        weightType string

Type of weight recorded.

The valid value is GROSS - NET.

 – – –
        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.

The valid value is TOTAL.

 – – –
        volumeValue Number Volume for item. – – –
        unitOfMeasure string Volume unit of measure. – – –
      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. – – –
      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. – – –
      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. – – –
      mpcDates array Reference dates at header level. – – –
        dateType string

Referenced date type.

Valid values include:

  • SCHEDULEDDELIVERY

  • MANUFACTURING

 – – –
        dateValue date Date defined by referenced date type. – – –
        timeZone string Time zone for referenced dates. – – –
      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:

  • BOL

  • CARRIERREFERENCE

  • DELIVERY

  • INVOICE

  • MASTERBOL

  • PURCHASEORDER

  • RELEASE

  • SEALNUMBER

  • SHIPMENT

  • SUPPLIERORDER

  • TRACKINGNUMBER

– – –
        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. – – –
      freeTextNote array Free text, instructions, notes, descriptions and other free text elements. – – –
        textReferenceCode string Text reference or subject code. – – –
        textFunctionCode string Text function code. – – –
        language string Language of free text. – – –
        textFormatCode string Format code for free text. – – –
        freeFormText string, array Free text array. – – –
    packagingAggregation array Packaging aggregation looping group, one instance per primary (pallet, case, bundle, etc.). – – –
      parentPackagingLevel array Primary aggregation hierarchy represents the top most level of the packaging hierarchy that will be shipped. This will always be a packaging item: pallet, case, bundle, etc. – – –
        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:

  • SCAC

  • 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:

  • SCAC

  • 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. – – –
        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:

  • ALLOWED

  • GROSS

  • LOADING

  • NET

  • TOTALPACKAGING

  • TARE

– – –
          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:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

 – – –
          dimensionsValue Number Volume for item. – – –
        freeTextNote array Free text, instructions, notes, descriptions and other free text elements. – – –
          textReferenceCode string Text reference or subject code. – – –
          textFunctionCode string Text function code. – – –
          language string Language of free text. – – –
          textFormatCode string Format code for free text. – – –
          freeFormText string, array Free text array. – – –
        secondaryPackagingLevel array

Secondary packaging aggregation hierarchy represents the child of the primary packaging level.

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

 – – –
          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:

  • SCAC

  • 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:

  • SCAC

  • 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. – – –
          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

  • TOTALPACKAGING

– – –
            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:

  • 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:

  • LENGTH

  • WIDTH

  • HEIGHT

  • LOADINGPLATFORMLENGTH

 – – –
            dimensionsValue Number Volume for item – – –
            unitOfMeasure string Volume unit of measure – – –
          tertiaryPackagingLevel array Tertiary aggregation hierarchy represents the child of the secondary packaging level. This could be any of a case, bundle, or any other packaging type. – – –
            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:

  • SCAC

  • 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:

  • SCAC

  • 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. – – –
            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:

  • 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 Volume unit of measure. – – –
            packagedProduct – Packaged product level aggregation hierarchy represents the child of the tertiary, secondary or primary packaging level. This would only record product information. – – –
              packagingContentsType – – – – –
              packagingIdentifier – – – – –
              deliveryDocumentIdentifier – – – – –
              deliveryDocumentLineItem – – – – –
              packagedProductIdentifier – – – – –
              itemQuantity array Order quantity at line item level. – – –
                quantityType string

Type of quantity recorded.

The 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. – – –
              plantIdentifier string Plant identifier. – – –
              storageLocation string Storage location of product. – – –

Tag end