How to get the Tracking Page Access Link via the API

With any consignment that has been created in MachShip, you will have the option to be able to obtain back the unique link for the MachShip tracking page. This link provides through a branded webpage which will show all of the details of the consignment as well as live tracking updates. 

All of MachShip's tracking pages are navigated through to by taking the URL below:
https://live.machship.com/tracking/#/consignments

and append the trackingPageAccessToken to the end.
Note: To get the consignment tracking link in the MachShip UI, kindly refer on this link.

If this was to be viewed in a browser it would look like the below

How to Obtain the TrackingPageAccessToken via the MachShip API:

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

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

 As for the create consignment call (POST Method), you may navigate to this document link that  will outline the properties and steps required upon creating a consignment via the API for this endpoints to get the trackingPageAccessToken:

6.) /apiv2/consignments/createConsignment

7.) ​/apiv2​/consignments​/createConsignmentwithComplexItems

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#/