Carrier Code Master Data API

Transware API users can use this API to get the available values for the available carrier codes and their corresponding names.

Note: values returned by this API are constrained to the access of the user ID the bearer token was requested with. That is, users calling this carrier master data API will only receive carrier codes and names that are associated to invoices they would otherwise have access to when logging into the Transware web application.

HTTP Method	URL	Authentication Type
Get	/api/v1/masterdata/carriercodes	Bearer Token

Request Parameters

Name	Type	Required	Description
No parameters are available for this API

Response Parameters

Name	Type	Description
valueKey	String	The value key in VTM’s database
valueDefinition	String	The key’s full carrier display name in VTM’s database

Sample Request

https://transware.vtm.com/api/v1/masterdata/carriercodes

Sample Response

{	
	"results": [
	{
		"valueKey": "<VTM Internal Carrier Code>",
		"valueDefinition": "<Carrier Name>"
	},
	{
		"valueKey": "<VTM Internal Carrier Code>",
		"valueDefinition": “<Carrier Name>"		
	}
	]
}