Support for line-item attachments, classified attachments and attachment size for integrations not up-to-date with latest versions

Without updating your integration, you will always be able to receive line-item attachments, however full functionality will be unlocked through updating your integration.

For more information about this release, check our our release article here - https://www.shipserv.com/article/line-item-and-classified-attachments

This article covers what access to functionality you get in the latest release and how to get access to full functionality depending on your setup…

1. Functionality without updating your integration (all integrations)

2. Functionality unlocked by updating MTMLLink-FX

   1. Using WebService directly

3. Functionality unlocked by updating MTML Standard

4. Functionality unlocked by updating Order Management API

What functionality you have access to without changing or updating your integration

Sending and Receiving Line-Item Attachments

Without updating your integration you will be able to receive but will not be able to send line-item attachments.

If you're sent a document containing line-item attachments we'll generate a line-item attachments document containing links to all your line item attachments. This document will be included as a header attachment which you'll receive in the usual manner.

This generated line-items attachments document will only display line-items that have attachments.

To ensure your transactional data remains secure, all line-item attachments are protected behind a layer of authentication. When you click on an attachment link the ShipServ login screen will open a tab on your browser. Enter your username and password to download the attachment. For more information on attachment security and what it means for you, click here.

Note: When you update to the latest version of MTML Standard, you will not receive this generated line-items attachment.

Sending and Receiving Classified Attachments

We support full compatibly for all integrations to be able to send and receive classified attachments.

When you receive line-item attachments, the name of the attachment will be prefixed by the classification abbreviation to allow for easy identification of the type of each document.

To send classified attachments you can do this by prefixing the classification abbreviation to the document file name. For full information on how to classify your documents and supporting document types, click here.

Attachment Size Limitations

APIs are limited to sending attachments up to 10mb each. MTML integrations are limited to a total document size of 3mb including attachments without updating. See the below table explaining attachment limit based on your Integration set-up.

Enhanced Functionality with MTMLLink-FX Version 6.0

If you're using MTMLLink-FX, by updating your MTMLLink-FX to version 6.0 you'll be to send attachments up to 10mb each.

Line-item attachments will also download directly your file directory in the attachments folder, downloaded into subdirectories for each line-item.

/ Attachments / …
headerAttachment1.pdf
headerAttachment2.pdf
/ 1 / …
    - lineAttachment1.pdf
    - lineAttachment2.pdf
/ 2 / …
    - lineAttachment1.pdf
    - lineAttachment2.pdf
/ 3 / …
    - lineAttachment1.pdf
    - lineAttachment2.pdf

Illustrative example of how line attachments are downloaded to your file directory

Click here for full information on MTMLLink-FX and how to update.

Connecting Directly to WebService

If you connect directly to our WebService, rather than using our MTMLLink-FX application, to benefit from the enhanced functionality you will require updating to MTML Standard 1.9 and using our new methods. You can find out more details on the WebService methods here.

Enhanced Functionality with MTML Standard Version 1.9

By updating to MTML Standard version 1.9 you'll be able to send line-item attachments as well as send and receive classified attachments without altering the file name of the document.

Click here for full information on document classification.

"lineItems": [
  {
    "number":1,
    "description": "12 PCE OF PLATES A",
    "quantity": 100,
    "unitOfMeasure": "PCE",
    "isHazMat": "true",
    "attachments" [
        {
          "name":"SampleItemAttachment.pdf",
          "type":"PDF",
          "classification":"MD",
          "isHazMat": "true",
          "url": "https://www.shipserv.com/attachments/12345"
        },
        {
          "name":"SampleItemAttachment.pdf",
          "type":"PDF",
          "classification":"MD",
          "isHazMat": "true",
          "url": "https://www.shipserv.com/attachments/12345"
        }
    ]
  },
  …
]

Illustrative example of classified line-item attachments

Enhanced Functionality with Order Management API Version 2.0

By updating to API OM version 2.0 you will enjoy the full benefits of the functionality of line-item and classified attachments.