The link object

A comprehensive list of the link resource's attributes and relationships

A link object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/links endpoint.

Fields

Field	Type	Description
type	string	links
id	string	The link unique identifier
links.self	string	The link endpoint URL
attributes.name	string	The link internal name.
attributes.client_id	string	The link application client id, used to fetch JWT.
attributes.scope	string	The link application scope, used to fetch JWT.
attributes.starts_at	datetime	The activation date/time of this link.
attributes.expires_at	datetime	The expiration date/time of this link (must be after starts_at).
attributes.active	boolean	Indicates if the link is active (enabled and not expired).
attributes.status	string	The link status. One of 'disabled', 'expired', 'pending', or 'active'.
attributes.domain	string	The link URL second level domain.
attributes.url	string	The link URL.
attributes.item_type	string	The type of the associated item. One of 'orders', 'skus', or 'sku_lists'.
attributes.params	object	The link params to be passed in URL the query string.
attributes._disable	boolean	Send this attribute if you want to mark this resource as disabled.
attributes._enable	boolean	Send this attribute if you want to mark this resource as enabled.
attributes.disabled_at	datetime	Time at which this resource was disabled.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.item	object	The polymorphic item associated to the link. One of 'orders', 'skus', or 'sku_lists'.
relationships.events	array	The associated events.
meta.mode	string	The resource environment (can be one of test or live)