How to get the Tracking Page Access Link via the API

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:

1. Base URL - the URL of the webpage, which is the same for all consignments
2. trackingPageAccessToken - unique to every consignment
   

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

Note: To get the consignment tracking link in the MachShip UI, kindly refer on this link.

Step 1: Select a Base URL to Use

A consignments MachShip tracking pages are can be accessed by taking one of the URLs below:
- V1 Tracking Page - https://live.machship.com/tracking/#/consignments/
- V1 Tracking Page (Shortened) - https://mship.io/
- V2 Tracking Page - https://live.machship.com/trackingv2/#/consignments/
- V2 Tracking Page (Shortened) - https://mship.io/v2/

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

1. V1 URL produces a tracking page with a traditional design
   
2. 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:

Below is the sample response from the MachShip API which contains the trackingPageAccessToken 

Via Create Consignment Endpoints

This access token is returned in the response to a create consignment API request via the following endpoints:

1. /apiv2/consignments/createConsignment
   
2. /apiv2/consignments/createConsignmentwithComplexItems

Via Get Consignment Endpoints

You can get the trackingPageAccessToken using the (GET Method) consignment call via the following endpoints:

1. /apiv2/consignments/getConsignment - passes thru via the consignment ID
   
2. /apiv2/consignments/returnConsignments - can pass thru up to 10 con IDs in an array.
   
3. /apiv2/consignments/returnConsignmentsByReference1 - passed thru via the consignment Reference ID
   
4. /apiv2/consignments/returnConsignmentsByReference2 - passes thru via the consignment Reference ID2
   
5. /apiv2/consignments/returnConsignmentsByCarrierConsignmentId - passes thru via the Carrier Consignment ID
   
6. /apiv2/consignments/getRecentlyCreatedOrUpdatedConsignments - query for all consignments modified inside a date range, such as last hour or day.

Note: For further information/reference of the API endpoints/definitions, you may check out our swagger link under "CONSIGNMENTS" Section: https://live.machship.com/swagger/index.html#/

• Related Articles

• How to Edit Consignments Via The API

  The following article will cover how to edit a consignment via the API. The main use cases for an edit workflow include: Adjusting item weights/dimensions Adding new items Removing items Note: This article will not cover the basics of creating ...

• Auto-Consolidation Via The MachShip API

  What is auto-consolidation? Auto-consolidation is a feature of Machship that is enabled on a per carrier basis, where we combine newly created consignments into existing consignments at the point they are created, rather than making a new ...

• How to Obtain Tracking, Consignment or Proof of Delivery (POD) information from the MachShip API

  This article has been moved to our developers handbook. Please find a link to the new article below: Tracking & PODs Getting A Tracking Link

• A guide to editing Complex Consignments Via The API when setting Item References

  The following article will cover how to edit a consignment via the API when you are delegating your own carrier consignment numbers and item references/barcodes. The main use cases for an edit workflow include: Adjusting item weights/dimensions ...

• How to Manifest via the MachShip API

  ## Current Content This article has been moved to our developer handbook and can be found here: Manifesting Consignments via the API For detailed information on the `pickupAlreadyBooked` field and its impact on pickup notifications, see the companion ...