SFTP
Overview
ShipScience helps businesses gain visibility into shipping performance, carrier costs, and fulfillment efficiency — and auto-file claims on their behalf. Base shipment data is compared from carrier invoices and tracking, but to auto-file claims, ShipScience needs package content and product information.
Integration Goal
Synchronize shipment data from your system to ShipScience daily via SFTP. For each outbound shipment, we aim to retrieve:
- Shipment-level information — tracking number, carrier, service, ship dates, weight, and dimensions.
- Item-level information — SKUs, descriptions, quantities, and declared values of items in each package.
This provides unified, auditable shipment history across all fulfillment channels.
File Formats
Supported formats:
- CSV (UTF-8 encoded)
- JSON
- XML
Data Elements
Below are the data elements expected for each integration. Fields marked Yes under Required must be included.
| Field | Level | Description | Required |
|---|---|---|---|
order_id / order_number | Shipment | Customer order reference | No |
ordered_date | Shipment | When the order was created | No |
shipped_date | Shipment | When the shipment left the facility | No |
voided_date | Shipment | When the shipment was voided or canceled (if applicable) | No |
carrier | Shipment | Carrier name (e.g., UPS, FedEx, USPS) | No |
service | Shipment | Carrier service (e.g., Ground, 2-Day) | No |
package_code | Shipment | Package type or code used | No |
tracking_number | Shipment | Tracking number assigned by the carrier | Yes |
account_number | Shipment | Account used with carrier (if applicable) | No |
warehouse_id / warehouse_name | Shipment | Fulfillment location identifier | No |
batch_number | Shipment | Batch or manifest grouping identifier | No |
dimensions_length, width, height | Shipment | Package dimensions | No |
dimensions_units | Shipment | Units for dimensions (e.g., inches, cm) | No |
weight_value | Shipment | Package weight | No |
weight_units | Shipment | Units for weight (e.g., lbs, kg) | No |
declared_value | Shipment | Total declared value of the shipment | No |
from_name | Shipment | Origin address details (name, company, address lines, city, state, zip, country) | No |
from_address_line_1 | Shipment | Origin address details (name, company, address lines, city, state, zip, country) | No |
from_address_line_2 | Shipment | Origin address details (name, company, address lines, city, state, zip, country) | No |
from_city | Shipment | Origin address details (name, company, address lines, city, state, zip, country) | No |
from_state | Shipment | Origin address details (name, company, address lines, city, state, zip, country) | No |
from_zip | Shipment | Origin address details (name, company, address lines, city, state, zip, country) | No |
from_country | Shipment | Origin address details (name, company, address lines, city, state, zip, country) | No |
to_name | Shipment | Destination address details (name, company, address lines, city, state, zip, country) | No |
to_address_line_1 | Shipment | Destination address details (name, company, address lines, city, state, zip, country) | No |
to_address_line_2 | Shipment | Destination address details (name, company, address lines, city, state, zip, country) | No |
to_city | Shipment | Destination address details (name, company, address lines, city, state, zip, country) | No |
to_state | Shipment | Destination address details (name, company, address lines, city, state, zip, country) | No |
to_zip | Shipment | Destination address details (name, company, address lines, city, state, zip, country) | No |
to_country | Shipment | Destination address details (name, company, address lines, city, state, zip, country) | No |
reference_1, reference_2, reference_3 | Shipment | Optional internal or customer references | No |
brand | Shipment | Merchant brand identifier (if applicable) | No |
order_line | Item | Line number within order | No |
item_sku | Item | Product SKU | Yes |
item_description | Item | Description of the item | Yes |
item_units | Item | Quantity shipped | No |
item_value | Item | Declared value per item | Yes |
item_weight | Item | Per-item weight (if available) | No |
- Note that destination name and address are required fields if you are a USPS Ship shipper filing USPS Claims.
Authentication & Security
- Data transport — all communications use HTTPS or secure SFTP.
- Compliance — ShipScience adheres to data security and confidentiality best practices for customer and shipment data.
Generate your SFTP destination in the ShipScience portal under Data Sources. Setup is self-serve.
Integration Options
- ShipScience hosted (default) — ShipScience hosts the SFTP destination, server details and credentials can be generated by an admin user in Data Sources.
- S3 — ShipScience can provide an S3 bucket with access keys to land data directly in S3 rather than an SFTP server, please work with your customer success team to get this option turned on and configured for your account.
- Customer Hosted SFTP (external) — ShipScience can connect to a customer hosted SFTP server, please work with your customer success team to get this option turned on and configured for your account.
Updated 4 days ago