About Shipium historical shipment file transfers

Shipium offers a variety of options for you to transfer regular historical shipment data exports for Shipium ML model training. In addition, you can transfer exports for Carrier Selection webhook generation for labels generated outside the Shipium system; this is useful if you are a Carrier Selection customer but you do not generate labels with Shipium.

Before requesting a file transfer, you will first need to identify if you will be manually dropping files or configuring an automated process to handle file transfers on a set cadence.

Manual transfers

• Shipium supports CSV bulk file uploads natively within the Shipium Console.
• Alternatively, files can be submitted in a ticket using the Shipium Customer Help Center.

Automated transfers

• Shipium supports both SFTP and S3 direct file drops.

If you would like to pursue setting up either a manual or automated file transfer, please reach out to your Shipium Implementation Team Member or Customer Success Manager to start the process. If you are a Carrier Selection customer but you don't generate labels with Shipium, the Carrier Selection without Label Generation document provides best practices for providing your shipment data.

The rest of this document provides a full onboarding guide and FAQs.

Set up automated file transfers for your organization

To start using an automated file transfer method, you will need to complete the following steps. Your dedicated Shipium team member will be available to assist you with each one.

1. Gather your configuration details.

   1. For SFTP, you'll provide a username, public key, and IP address.
      1. Username. It is recommended to use a credential username associated with the service/application that will be accessing the Shipium hosted SFTP or S3 location.
      2. Public Key. Asymmetric encryption is used to secure file drops and will require your public key to enable us to decrypt files uploaded to the SFTP or S3. You'll use the ssh-keygen command to create your public keys (it's generally safer to generate key pairs locally on a trusted device). To create a proper public key, you'll need to adhere to these constraints:
         • No line breaks. The public key must be a single line without any line breaks.
         • Proper key type. The key should start with a valid key type, such as ssh-rsa, ssh-ed25519, and ecdsa-sha2-nistp256.
         • No trailing characters. There should be no trailing characters or new lines at the end of the key, and there should be no extra spaces before or after the key.
      3. IP Addresses. The IP(s) or range of IPs that will be used by your application to access a Shipium file share must be provided for Shipium to enable them on our IP allow-list.
   2. For S3, you'll provide an Amazon Web Services (AWS) IAM role name and account ID.
      1. IAM role name. This is the user-defined name that uniquely identifies the IAM role within your AWS account.
      2. Account ID. This is a unique 12-digit identifier assigned to your AWS account.

2. Submit a customer setup request ticket.

Once you have successfully gathered all your internal configuration details, you can either directly support a setup request ticket via the Shipium Customer Help Center or send the configuration details directly to your dedicated Shipium team member for them to submit on your behalf.

3. Allow Shipium setup and processing.

Please allow 2-3 business days for Shipium to complete the processing of your file transfer setup request. Once completed, you will receive a ticket confirmation and/or email confirmation from your Shipium team member that your access has been successfully granted and available for immediate use.

4. Configure your SFTP or S3 connection.

Upon closure of your file transfer access request, you will immediately be able to access your secure drop location. Use the below details to complete your internal setup:

• For SFTP:
  • Server Name - partner-upload.shipium.com
  • Port - 22
  • For S3:
    • S3 Bucket - raw-partner-shipment-data-prod

5. Test the transfer.

Once you have completed the setup of your SFTP or S3 connection and confirm access, it is recommended to test the file handoffs using a test CSV file. This will allow Shipium to verify we are able to successfully decrypt and process the file transfer prior to automating the uploads.

• Folder Directory:
  • Files uploaded to the SFTP or S3 must be placed in the pre-defined drop location that will default be available to you post setup.
  • Drop Location - /[partner_name]/historical-shipment-data/

6. Schedule your uploads.

For customers not using Shipium label creation, we will require your historical shipment data to be uploaded at minimum once per month to ensure our ML models are kept up to date with the latest data regarding your network’s shipping performance to make the most accurate productions for you and your customers.

It is recommended to schedule these uploads to take place the first of each month to hand off the relevant historical shipping data for all shipments delivered within the prior month.

🚧

Important field requirement for Carrier Selection customers

If you are a Carrier Selection customer NOT using Shipium's label creation service, you must include a partner_reference_identifier in your shipment file, as noted in the Carrier Selection file format table below. This value is needed for Shipium to match your historical data with our Carrier Selection data.

Downloadable file templates

You can download a CSV template of the file format outlined below. Once you add your historical shipment data to the template, you can upload it via one of the mechanisms described above. Sample values are included in each template; be sure to replace the sample data with your own.

For Carrier Selection customers

• Minimum required fields template. This CSV template includes only the minimum required fields needed.
• All fields template. This CSV template includes all the required fields as well as the optional fields.

For Delivery Promise customers

• Minimum required fields template. This CSV template includes only the minimum required fields needed.
• All fields template. This CSV template includes all the required fields as well as the optional fields.

File format

The required fields vary depending on which Shipium product you're using. Use the table below that corresponds to your product.

For Carrier Selection customers

For the files that will be uploaded as part of this process, the following table shows the columns, the names that should appear in column headers, and a description of each of the fields. Fields that are required are highlighted in bold type.

For Delivery Promise customers

Webhook generation for external labels (Carrier Selection only)

If your organization generates labels externally but uses Shipium's Carrier Selection service, historical shipment file transfers enable webhook notifications when your external labels are matched to carrier selections.

Requirements for webhook generation

• Matching field. Include partner_reference_identifier that matches your partnerShipmentId from calls to Shipium's Carrier Selection APIs.
• Processing SLA. Files are processed within 24 hours or by the end of the following calendar day.
• Age limit. You determine the timeframe for shipments that will generate webhooks.

How it works

1. You upload your historical shipment file via SFTP or S3.
2. Shipium processes and matches external shipments to carrier selections.
3. Matched shipments generate "label_imported" webhook events and display a status of "imported" in the Shipium Console.
4. Unmatched shipments are processed for ML training but don't generate webhooks.

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

• Terms and Definitions
• Troubleshooting Guide
• Contact Shipium Support