Send trackers only

Overview

You can set up an FTP server and drop on a regular basis CSV exports of your most recently sent packages. Shipup will try to access the FTP every hour and will retrieve all exports generated in the last hour.

Alternatively, we can also provide access to our SFTP server (ftp.shipup.co) so you don't need to set up your own.

Format

format info

description

Filename
"[UNIX timestamp].csv"

The filename must be the Unix Time at which the file has been generated followed by file format .csv

Separator

Comma , and semi-comma ; are allowed but must be consistent throughout one file

Headers

The first line of the CSV must be a comma / semi-comma separated list of attribute names.

Data

Each following row must be a comma / semi-comma separated list of values.

Encoding

UTF-8

Data format

Shipup is expecting CSV files encoded with UTF-8.

You'll find at the bottom of this page an example of a CSV file with all available data fields. For a description of those fields with their format and sample values, please refer to the request payload of our batch create or update a tracker API reference.

📘

Importance of carrier_code

When you import tracker data into Shipup using our tracker FTP integration, it's important to include the carrier_code field. You can find available values for this field in the carrier code reference. If you fail to do so, Shipup will try to guess the carrier based on the tracking number but this process is prone to error.

Datetime format

Datetime fields are expected to be sent using UNIX timestamps (seconds since 1970).

For convenience, ISO 8601 format is also considered valid (e.g. 2019-08-12T09:17:29Z).

Custom variables format

If you wish to pass custom variables in your CSV, you can use the custom_variables field. The expected format is a stringified JSON string containing all your custom variables. Please note that you'll need to comply with the specific escaping format of the CSV file.

Example:

  1. Given a JSON stringified custom_variables dictionary:
    { "store_language": "fr-be" }

  2. Escape all double quotes by doubling them (CSV standard):
    { ""store_language"": ""fr-be"" }

  3. Add double quotes around the final string and add it to your CSV:
    "{ ""store_language"": ""fr-be"" }"

Escaping double quotes

The " (double-quote) character can be present in a CSV but must be escaped with another ". Please verify that your CSV is valid using a CSV validator, for example csvlint.io

Here is a correct example:

carrier_code;carrier_service_code;tracking_number;address_street;email;order_number;order_date;first_name;last_name;address_name;address_city;address_zip;address_country;address_state;language_code;phone;warehouse_merchant_id
ups;ups_standard_delivery;1Z9V988X0450295364;"16 lieu dit ""Lanette""";[email protected];FR289920;1493206208;Jean;Dupont;Jean Dupont;Paris;75002;FR;;fr;0612345678;location_1

Here are incorrect examples (wrong double-quote encoding on each line):

carrier_code;carrier_service_code;tracking_number;address_street;email;order_number;order_date;first_name;last_name;address_name;address_street;address_city;address_zip;address_country;language_code;phone;warehouse_merchant_id
ups;ups_standard_delivery;1Z9V988X0450295364;"16 lieu dit "Lanette"";[email protected];FR289920;1493206208;Jean;Dupont;Jean Dupont;Paris;75002;FR;;fr;0612345678;location_1
ups;ups_standard_delivery;1Z9V988X0450295364;"16 lieu dit \"Lanette\"";[email protected];FR289920;1493206208;Jean;Dupont;Jean Dupont;Paris;75002;FR;;fr;0612345678; location_1

Multiple delivery experiences across multiple Shipup accounts using one FTP integration

If you wish to use a unique CSV file for all your Shipup accounts, you can add a column store_id. This column must be filled up with a unique identifier for your different stores. Shipup can then filter trackers to only import corresponding stores into associated accounts.

For example, if you have two brands (My Dog and My Cat) with two different branding experiences, you will need two Shipup accounts, one for each brand.

Nevertheless, you can have only one FTP integration, and fill up the column store_id with mydog and mycat depending on the brand. Shipup will then be able to import trackers with store_id mydog in My Dog Shipup account, and trackers with store_id mycat in My Cat Shipup account

Example of file

Filename: 1477299100.csv

carrier_code;carrier_service_code;tracking_number;email;order_number;order_date;first_name;last_name;address_name;address_street;address_city;address_zip;address_country;language_code;phone;warehouse_merchant_id
ups;ups_standard_delivery;1Z9V988X0450295364;[email protected];FR289920;1493206208;Jean;Dupont;Jean Dupont;16 rue de l'Opera;Paris;75002;FR;fr;0612345678;location_1

Did this page help you?