Tracking | Post Tracking Update

post

https://pluto.cargobase.com/api/1/tracking/generic

Purpose

The Cargobase tracking update end-point is available only to Provider companies for the purpose of posting tracking updates to Cargobase. This end-point allows a provider to post tracking events onto a shipment. At this moment, all events are posted 'as-is'.

Access

A provider can only post tracking updates for shipments associated with their account. POSTS for other shipments will be rejected.

An access token is required to POST to this end-point.
Contact [email protected] to obtain your token.

Request URI

POST https://pluto.cargobase.com/api/1/tracking/generic
Content-Type: application/json
Authorization: Token 'your_token_here'

Sample Request Body :

{
  "tracking_number": "TG166222",
  "shipment_id": "S22316102",
  "tracking_type": "mawb",
  "mode_of_transport": "air_freight",
  "tracking_update_text": "Your parcel has been delivered",
  "tracking_status_tag": "DELIVERED",
  "event_time": "2023-07-01T14:59:56.711",
  "event_time_with_timezone": "2032-04-23T10:20:30.400+02:30",
  "expected_departure_time": "2023-07-01T14:59:57.711",
  "expected_arrival_time": "2023-07-01T14:59:58.711",
  "actual_departure_time": "2023-07-01T14:59:59.711",
  "actual_arrival_time": "2023-08-19T14:59:00.711",
  "additional_info": {
    "sample_additional_info_key": "asdasd"
  },
  "bill_of_lading": {
    "bill_of_lading_number": "COSU6349613240",
    "carrier_no": "COSU",
    "container_no": "BMOU1589176"
  },
  "flight_information": {
    "flight_number": "MH197",
    "airline": "Malaysia Airlines"
  },
  "location": {
    "airport_name": "Incheon International Airport",
    "country": "Singapore",
    "country_code": "US",
    "state": "Arkansas",
    "icao_code": "LTAF",
    "unlocode": "SGSIN",
    "iata_code": "AA",
    "coordinates": {
      "lat": -34.397,
      "lng": 150.644
    },
    "location_text": "free-text"
  },
  "document_link": "https://getsamplefiles.com/filedownloadhere",
  "milestone_details": {
    "event_type": "booked_for_transport",
    "location_type": "other",
  },
  "event_weight": 123,
  "event_weight_unit": "kg",
  "event_piece": 2,
  "weight": 456,
  "piece": 3
}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

tracking_number

string

required

Tracking number provided by the 3rd party.

tracking_type

string

required

Identifier for the carrier and source of the tracking update.

tracking_update_text

string

required

Free-text description of the tracking update event.

tracking_status_tag

string

enum

required

Status tag identifying key tracking events.

Allowed:

mode_of_transport

string

enum

Mode of transport for the shipment.

shipment_id

string

The Cargobase shipment ID tied to this tracking number.

event_time

date-time

Datetime of the tracking event. (local time)

event_time_with_timezone

date-time

Datetime of the tracking event with timezone.

expected_departure_time

date-time

Expected departure datetime. (local time)

expected_arrival_time

date-time

Expected arrival datetime. (local time)

actual_departure_time

date-time

Actual departure datetime. (local time)

actual_arrival_time

date-time

Actual arrival datetime. (local time)

additional_info

object

Additional information related to the tracking event. A free JSON object with no fixed keys

bill_of_lading

object

JSON object containing fields describing a bill of lading.

flight_information

object

Information related to the flight.

location

object

Information related to the location of the tracking event.

document_link

string

Link to the document related to the tracking event.

event_weight

integer

Weight of the shipment for this event

event_weight_unit

string

enum

Unit of weight of the shipment for this event

Allowed:

event_piece

string

Number of pieces for this event

weight

integer

Weight of the entire shipment for this tracking number

piece

string

Number of pieces for this shipment

milestone_details

object

Details about the milestone event.

Responses

200

Tracking update successfully posted.

400

Bad request. Check the request parameters or body.

401

Unauthorized. Invalid or missing authentication token.

500

Internal server error. Please contact support if the issue persists.