Technical configuration
Data is exchanged between your system and Shippit using SFTP (secure file transfer protocol) connections. Shippit sets up and maintains a secure FTP server on your behalf. During the kick off process, you are provided with a username and password to use to access the server.
CSV schema
The CSV files you receive for orders follow this schema:
| Header | Description | Example |
|---|---|---|
sender_company_name | Merchant name | Acme Pty Ltd |
sender_name | Contact person from the merchant | Jane Smith |
sender_email | Contact email provided by the merchant | jane.smith@acme.com |
sender_contact_number | Contact phone number provided by the merchant | +61 2 1234 5678 |
sender_address | Merchant address | 123 Example St |
sender_suburb | Merchant suburb | Sydney |
sender_postcode | Merchant postcode (4 characters max) | 2000 |
sender_state_code | Merchant state code (3 characters max) | NSW |
sender_country_code | Merchant country code (2 characters max) | AU |
receiver_company_name | Receiver company name | Widgets Inc |
receiver_name | Receiver name | John Doe |
receiver_email | Contact email provided by the receiver | john.doe@widgets.com |
receiver_contact_number | Contact phone number provided by the receiver | +61 3 8765 4321 |
receiver_address_line_1 | The first line of the receiver address | 456 Sample Ave |
receiver_address_line_2 | The second line of the receiver address | Apartment 1 |
receiver_suburb | Receiver suburb | Melbourne |
receiver_postcode | Receiver post code | 3000 |
receiver_state_code | Receiver state code | VIC |
receiver_country_code | Receiver country code | AU |
consignment_number | Consignment identifier in GS1 GINC format | 123456789012345678 |
account_number | Identifier of the merchant’s account with the carrier | ACME12345 |
authority_to_leave | Whether the package has authority to leave (Y/N value) | Y |
product_code | Selection of service surfaced from quoting | EXPRESS |
pickup_instructions | Instructions for the carrier to follow during pickup | Collect from loading dock |
delivery_instructions | Instructions for the carrier to follow during delivery | Leave at front door if unattended |
package_label_number | Package identifier in GS1 SSCC format | 00312345678901234567 |
package_weight_kg | Package dead weight in kg | 2.5 |
package_length_cm | Package length in cm | 30 |
package_depth_cm | Package depth in cm | 10 |
package_width_cm | Package width in cm | 20 |
retailer_invoice | Primary field used by merchants as their own internal identifier for this consignment | INV-10001 |
retailer_reference | Secondary field used by merchants as their own internal identifier for this consignment | REF-20002 |
booked_at | The timestamp for when the order was booked in Shippit (ISO 8601 format) | 2024-08-22T10:15:00+10:00 |
For more information about the CSV format, including example files, see the Carrier operations guide.
Booking SFTP connection
Send new booking and manifest files using the booking SFTP connection. The technical team uses the details you provided in the questionnaire to establish the connection.
New booking files are automatically added to the /shippit/inbound/ directory on the SFTP server.
The directory structure is configured when your account is set up, so the exact directory could be different depending on your configuration.
Tracking SFTP connection
Send tracking files using the tracking SFTP connection. This connection is only required if you are using the CSV method for tracking updates.
Shippit provide you with a unique username and password to access the server using these details:
- Host name:
carrier-sftp.shippit.com - Port:
22
You can also use the staging server for testing purposes, using these details:
- Host name:
carrier-sftp.stg.shippit.com - Port:
22
Add new tracking files to the /inbound/tracking/ directory on the SFTP server.
The directory structure is configured when your account is set up, so the exact directory could be different depending on your configuration.
Configuring your shipping labels
Shippit generates carrier-compliant shipping labels for merchants. The label uses your name and logo, along with the sender and receiver details.
The label looks like this:
