Links to other related resources
 

A Link is a representation of a related resource's URL.

Data Model

NameTypeDescription
hrefstringThe URL that can be used to get the linked resource.
classstringIdentifies the type of resource that is linked to by the URL
identifiermixedIf the linked resource uses an identifier, it is listed here. This makes it easy for you to cache the information without the need to parse identifiers from the provided URLs.

Examples

Link with an identifier to a specific target

{
	"href": "https://supplier.cmix.com/api/v2/targets/102365",
	"class": "target",
	"identifier": 102365
}

 

Link to a list of targets

{
	"href": "https://supplier.cmix.com/api/v2/targets",
	"class": "targets",
}