Receive bookings from Shippit
Shippit automatically generates a CSV file for each new order as it’s booked by the merchant. The CSV file contains the booking and manifest details for the order. Configure your system to check for these files, download them, and process the orders.
It’s important that you perform regular maintenance of this folder, and remove older booking files. You might prefer to do this on a regular cadence.
File location and naming
When a merchant creates a new order, the system generates a booking file, and transfers it to the SFTP server.
The booking file is in CSV format, and uses the manifest reference number as the filename. The booking files are put in the /shippit/inbound/ directory of 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.
The booking CSV file
This table describes the columns in the booking file:
| Column Heading | Description | Example |
|---|---|---|
order_id | Shippit’s unique identifier for the order | PPP1234567890 |
tracking_number | Unique tracking number for this consignment | CARR00098765 |
service_code | Carrier-specific code for the service | EXP |
sender_name | Name of the sender | Jane Smith |
sender_company | Sending company’s name | ACME Corp |
sender_address_1 | Street address of the sender | 100 George Street |
sender_suburb | Suburb of the sender | Sydney |
sender_postcode | Postcode of the sender | 2000 |
sender_state | State of the sender | NSW |
sender_contact_number | Sender’s phone number | 0400123456 |
receiver_name | Name of the recipient | John Doe |
receiver_address_1 | Street address of the recipient | 250 Collins Street |
receiver_suburb | Suburb of the recipient | Melbourne |
receiver_postcode | Postcode of the recipient | 3000 |
receiver_state | State of the recipient | VIC |
receiver_contact_number | Recipient’s phone number | 0400654321 |
delivery_instructions | Special instructions for delivery | Leave at front door |
item_quantity | Total number of items in the consignment | 2 |
total_weight_kg | Total weight in kilograms | 5.5 |
description | Description of the consignment contents | Clothing |