Introduction

An Application Programming Interface, abbreviated as API, is a set of protocols, routines, and tools that allows software applications to communicate with each other.

Our API will provide access to thousands of data points for your freight as it moves around the globe. This will help collate all of these tracking data points into your systems, such as inventory, purchasing or warehouse systems, without logging in to your SiShips portal.

Implementing the SiShips API to your personal systems is an absolute breeze. All you need to do is request an API key by emailing sales@siships.com.

Our staff will be able to walk you through any questions you have during the installation process. This is also a one-time setup, so once the protocols are added to your network, you will never have to worry about resetting or logging back in to turn on the API again.

Authenticate Using API Keys

To generate a api key from the url endpoint

All REST requests must be authenticated. REST uses Api based authentication.

Create an API key
 To create an API key, use one of the following options:
URL qualifier
  1. In the SIship, Go to the create api tab
    Go to the create api tab
  2. Click Create Api, then create API name.
    The API key created table displays the string for your api and secret key.
Returns
 An encoded string in the response body referred as api key.
Note
 Copy your key string and keep it secure.

Tracking

All REST requests must be authenticated. REST uses token based authentication.

Request

Description
 Tracking Data.
URL qualifier
/api/v1/tracking/reports
Method
POST
Authorization

Note: Choose type API key

Key
Value
key < api_key>
Headers
Header
Value
Content-type application/x-www-form-urlencoded
Body

Customize the information returned in the report by specifying query parameters with the query. Listed below are query parameters available for this report.

Note:
1. All body parameters are optional
2. body values are case-sensitive
3. You can choose only start_date and end_date or days
4. Choose by default form-data

Key
Value
columns (JSON) ["Invoicing Number","Quote Number",......]
status_type (String) active
closed
uninvoiced (boolean) true
false
mode (String) import
export
ptop
start_date (Date) YYYY-MM-DD
end_date (Date) YYYY-MM-DD
days (Integer) 30
60
90
Returns
 It will return JSON data. 
          

          
                   // HTTP POST Request                   $ch = curl_init();                   curl_setopt($ch, CURLOPT_URL,"/api/v1/tracking/reports");                   curl_setopt($ch, CURLOPT_POST, 1);                   curl_setopt($ch, CURLOPT_key, API_KEY);                   curl_setopt($ch, CURLOPT_POSTFIELDS, "type=value1&days=value2&status_type=value3&uninvoiced=value4&mode=value5&start_date=value6&end_date=value6");                   // Receive server response ... curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);                   $server_output = curl_exec($ch);                   curl_close($ch);                   // Further processing ...                   if ($server_output == "OK") { ... } else { ... }

Response


Invoicing Number String
Optional Indicates the invoice number on Sheltered's Invoices
Quote Number String
Optional Indicates the quote number on Sheltered's quotes
Shipper String
Optional The shipper is the person or company who is usually the supplier of the goods being shipped and is also referred to as the consignor.
Consignee String
Optional The consignee is the receiver of the shipment.
Customer String
Optional The Customer is the bill to party
Ref# String
Optional Unique reference number used in Siships. Normally it is the client's PO#, however it can be any reference to help client's search their shipments.
Container Number String
Optional If an ocean shipment, the container number
Master BL String
Optional The master bill of lading number
House BL String
Optional House Bill of Lading is a formal acknowledgment that the carrier has received the consignment for shipment post-inspection.
Mode Type String
Optional It is a type of shipping mode
Mode Detail String
Optional Shows the method of transport such as air, full container, less then container loan, truck
Handover City String
Optional If known, this is the location where Sheltered takes possession of the cargo
Handover String
Optional If known, this is the date when Sheltered takes possession of the cargo
Departure City String
Optional Port where the cargo departs
Departure String
Optional Date when the cargo departs or is estimated to the departure city
First Port City String
Optional First Port or Discharge Port where the cargo arrives at destination. (for example a shipment arriving LA and railing to Chicago. LA would be the First Port)
First Port Date String
Optional Date when the cargo arrived or is estimated to the First Port
Last Port City String
Optional Last Port or Final Port where the cargo arrives at destination for customs clearance. (for example a shipment arriving LA and railing to Chicago. Chicago would be the Last Port)
Last Port Date String
Optional Date when the cargo arrived is estimated to the Last Port
Door City String
Optional If applicable, the date or estimated date when the cargo arrives for the final door delivery
Door Date String
Optional Date when the cargo arrived is estimated to the Last Port
Deadline String
Optional Deadline Date till the shipment reaches to sender/recipient
Availability Date String
Optional Availability Date for pickup at last port
Confirmed Departed String
Optional This is a yes or no, once Sheltered confirms the cargo has left the departure port
Total Transit Time integer
Optional Transit time is the total time it takes for goods to get from first tracked date to the last tracked date
Milestone String
Optional Will provide the most recent milestone status in SiShips such as docs on file, departed, arrived, invoices, delivered, proof of delivery, etc.
Notes String
Optional Will provide the most recent note from the SiShips tracking
Days Delay String
Optional If you provide a deadline, it will provide the number of days delayed past your deadline
Reason Of Delay String
Optional Will provide causes for delays such as congestion, weather, customer, carrier, late shipper, etc.
Freight Cost integer
Optional Total amount paid for the transportation of goods, excluding duty
Duty Cost integer
Optional import/export duties cost
Pieces String
Optional Number of pieces as in the BOL. It will match how the shipper's pieces on BOL if they use pallets, cartons, etc. on the BOL it will show that number here). For Example if you have 30 cartons on 1 pallets, the BOL will show which ever is on the BOL.
Cost per Piece double
Optional freight and duty cost per piece
Units String
Optional Number of units on the shipper's invoice or packing list. For Example, if you have 30 cartons each with 100 t-shirts in each carton, the units would be 300.
Cost per Unit double
Optional freight and duty cost per unit
CBM String
Optional Shippers use CBM to calculate chargeable weight. To calculate the total CBM of your shipment, multiply its length, width, and height (in meters).
Cost per CBM double
Optional freight and duty cost based on the number of cubic meters
KG String
Optional weight of units/container in Kgs
Cost per KG double
Optional freight and duty cost based on the number of per kilogram
Quoted by String
Optional Will show siships user who quoted the shipment
Booked by String
Optional Will show siships user who booked the shipment 
        



   {        "status":  200        "data":  [          {            "Invoicing Number":  ""            "Quote Number":  ""            "Shipper":  ""            "Consignee":  ""            "Customer":  ""            "Ref":  ""            "Container Number":  ""            "Master BL":  ""            "House BL":  ""            "Mode Type":  ""            "Mode Detail":  ""            "Handover City":  ""            "Handover":  ""            "Departure City":  ""            "Departure":  ""            "First Port City":  ""            "First Port Date":  ""            "Last Port City":  ""            "Last Port Date":  ""            "Door City":  ""            "Deadline":  ""            "Availability Date ":  ""            "Confirmed Departed":  ""            "Confirmed Delivered":  ""            "Transist_time":  ""            "Milestone":  ""            "Notes":  ""            "Days Delay":  ""            "Reason of Delay":  ""            "Frieght cost":  ""            "Duty Cost":  ""            "Pieces":  ""            "Cost_per_Pieces":  ""            "Units":  ""            "Cost_Per_Units":  ""            "CBM":  ""            "Cost Per CBM":  ""            "KG":  ""            "Cost_Per_KG":  ""            "Quoted By":  ""            "Booked By":  ""            }         ]      }