Tracking Links Via API

Overview

All consignments that have been created in MachShip will have a linked MachShip tracking page that can be accessed publicly.

This link sends the user to a branded webpage that shows all of the details of the consignment as well as live tracking updates.

The consignment tracking link is made up of two parts:

  • Base URL - the URL of the webpage, which is the same for all consignments
  • trackingPageAccessToken - unique to every consignment - it is NOT the carrier consignment ID

The outcome is a tracking page URL that takes the following form:

https://mship.io/v2/{trackingPageAccessToken}

For example: https://mship.io/v2/bk13234gb123yh1234

It is NOT possible to use the carrier consignment id for tracking purposes using our tracking urls.

Step 1: Select a Base URL to Use

Base URLs

MachShip offers multiple tracking page URLs:

  • V1 Tracking Page: https://live.machship.com/tracking/#/consignments/
  • V1 Tracking Page (Short): https://mship.io/
  • V2 Tracking Page: https://live.machship.com/trackingv2/#/consignments/
  • V2 Tracking Page (Short): https://mship.io/v2/

The URL you select is up to you - I recommend you check both and choose the one you like best.

  • V1 URL produces a tracking page with a traditional design
  • V2 URL produces a more modern design

Note, the shortened URL redirects to the related long URL and is useful for systems where the you have a shorter character limit.

Step 2: Obtain the TrackingPageAccessToken via the MachShip API

The tracking page access token is returned in responses from:

Create Consignment Endpoints

  • POST /apiv2/consignments/createConsignment
  • POST /apiv2/consignments/createConsignmentwithComplexItems

Get Consignment Endpoints

  • POST /apiv2/consignments/returnConsignments - Query by MachShip consignment IDs
  • POST /apiv2/consignments/returnConsignmentsByCarrierConsignmentId - Query by carrier consignment numbers
  • POST /apiv2/consignments/returnConsignmentsByReference1 - Query by Reference 1 field
  • POST /apiv2/consignments/returnConsignmentsByReference2 - Query by Reference 2 field
  • POST /apiv2/consignments/returnConsignmentsByPendingConsignmentIds - Query consignments by their original pending consignment IDs
  • GET /apiv2/consignments/getRecentlyCreatedOrUpdatedConsignments - query for all consignments modified inside a date range, such as last hour or day.

It will typically look as follows:

{
    "trackingPageAccessToken": "fduojh121j23-22md"
}

To create a tracking URL, append the token to your chosen base URL:

https://mship.io/v2/y1y1Q535Q0uVsOzvxNZ9WQ