Endpoint - Shipping Tags

This call is expected to return an array of shipping methods friendly names and their tags to generate a pre-populated list in the config shipping mapping screen.

Request

Post

ShippingTagsRequest

Field Name	Type	Description
AuthorizationToken	String	Authorization Token from the customers integration.

Sample

Sample Request

{
	"AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148"
}

Response

ShippingTagsResponse

Field Name	Type	Description
Error	String	If there was an error with the request.
ShippingTags	ShippingTag[]	Array of shipping tags. See Shipping Tag table.

ShippingTag

Field Name	Type	Description
Tag	String	The shipping tag that is supplied on the order.
FriendlyName	String	Friendly name of the shipping tag.
Site	String	Site of the shipping tag, this is usually used when the channel has one set of credentials however has multiple sites for example UK, DE, US and so on. Leave blank if this is not applicable.

Sample

Sample Response

{
	"Error": null,
	"ShippingTags": [
		{
			"Tag": "RM CLR01",
			"FriendlyName": "Royal Mail First Class",
			"Site": ""
		},
		{
			"Tag": "RM_SpecialDelivery_9am",
			"FriendlyName": "Royal Mail Special Delivery",
			"Site": ""
		},
		{
			"Tag": "dpd",
			"FriendlyName": "DPD - Next Day",
			"Site": ""
		},
		{
			"Tag": "fedex_ground",
			"FriendlyName": "Fedex - Ground",
			"Site": ""
		},
		{
			"Tag": "matrix_rate_10221",
			"FriendlyName": "Some other service",
			"ListValues": [],
			"Site": ""
		}
	]
}

Response with error

{
	"Error": "Invalid authorization token",
	"ShippingTags": []
}