Off-Platform Shipment

POST


      https://cargobase-check.prod.integration.us.axway.com:9443/off-platform-tracking

Purpose

It allows shippers to record and track shipments arranged outside the Cargobase platform, ensuring complete visibility and centralized reporting. Note: The shipment data will be sent as an array of shipment objects.

Access

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

Sample JSON

{
    "shipments": [
        {
            "shipment_title": "12345",
            "external_id": "12345",
            "custom_field_01": "Custom Value 01",
            "custom_field_02": "Custom Value 02",
            "custom_field_03": "Custom Value 03",
            "location": "Singapore",
            "freight_mode": "Air",
            "provider": "DHL",
            "provider_tracking_number": "DHL123456789",
            "mawb_number": "176-98765432",
            "mbl_number": null,
            "container_number": null,
            "truck_number": null,
            "pickup_company_name": "ABC Electronics Ltd.",
            "pickup_contact": "John Doe",
            "pickup_contact_phone": "+1-202-555-0143",
            "pickup_contact_email": "[email protected]",
            "pickup_address_line_1": "1234 Innovation Way",
            "pickup_address_line_2": "Suite 100",
            "pickup_zipcode": "94043",
            "pickup_city": "Mountain View",
            "pickup_state": "CA",
            "pickup_country": "USA",
            "delivery_company_name": "Tech Distribution Pte Ltd.",
            "delivery_contact": "Jane Tan",
            "delivery_contact_phone": "+65-6123-4567",
            "delivery_contact_email": "[email protected]",
            "delivery_address_line_1": "1 HarbourFront Walk",
            "delivery_address_line_2": "#03-02",
            "delivery_zipcode": "098585",
            "delivery_city": "Singapore",
            "delivery_state": null,
            "delivery_country": "Singapore"
        }
    ]
}

Shipment Information

Details that describe and identify the shipment itself.

Field Name	Mandatory	Value	Description
`shipment_title`	Yes	string	Brief title or external shipment ID
`external_id`	Yes	string	External shipment ID
`location`	Yes	string	Payment location of shipment
`freight_mode`	Yes	string	Mode of transport used for shipment
`provider`	No	string	Logistics service provider that handles the shipment

Tracking Numbers

Tracking identifiers based on freight mode.

Field Name	Mandatory	Value	Description
`provider_tracking_number`	Yes	string	For Parcel or Road freight
`mawb_number`	Yes	string	For Regular air freight (e.g. 123-45678901)
`mbl_number`	Yes	string	For Regular air freight (e.g. 123-45678901)
`container_number`	Yes	string	For Ocean or Rail freight (e.g. ABCD1234567)
`truck_number`	Yes	string	For Road freight

Pickup Details

Information about the pickup location and contacts.

Field Name	Mandatory	Value	Description
`pickup_company_name`	Yes	string	Name of the company responsible for pickup
`pickup_contact`	No	string	Contact person for pickup
`pickup_contact_phone`	No	string	Phone number for pickup contact
`pickup_contact_email`	No	string	Email for pickup contact
`pickup_address_line_1`	No	string	First line of pickup address
`pickup_address_line_2`	No	string	Second line of pickup address
`pickup_zipcode`	No	string	Postal code of pickup location
`pickup_city`	Yes	string	City of pickup location
`pickup_state`	No	string	State of pickup location
`pickup_country`	Yes	string	Country of pickup location

Delivery Details

Information about the delivery location and contacts.

Field Name	Mandatory	Value	Description
`delivery_company_name`	Yes	string	Name of the company responsible for delivery
`delivery_contact`	No	string	Contact person for delivery
`delivery_contact_phone`	No	string	Phone number for delivery contact
`delivery_contact_email`	No	string	Email for delivery contact
`delivery_address_line_1`	No	string	First line of delivery address
`delivery_address_line_2`	No	string	Second line of delivery address
`delivery_zipcode`	No	string	Postal code of delivery location
`delivery_city`	Yes	string	City of delivery location
`delivery_state`	No	string	State of delivery location
`delivery_country`	Yes	string	Country of delivery location