Skip to main content

link

Required Field

This field is required and must not be omitted

Description​

We need links to be able to re-direct users to your product page. In the link attribute you provide the URL for your product page.

Validation Rules​

  • Must be valid RFC 3986 uri
  • Must have a protocol (eg. https)
  • Must have a path (eg. .../my-product)
  • Must be shorter than 2047 characters
  • Unicode characters must be url encoded

Best Practices​

Do​

  • Use stable url (for better user experience)
  • Use URL to pre-selected product variants (if applicable)
  • Use as few redirects as possible (for better user experience)

Don´t​

  • Don't add affiliate tracking in this field, we have a separate field affiliate_link for that

Example Values​

Here are examples of how a valid link value should look like in XML and CSV (with header) respectively.

Valid Value
<g:link>http://example.com/link</g:link>
Click to show more valid XML examples
<g:link>http://example.com/link</g:link>
<g:link>https://example.com/link</g:link>
<g:link>https://example.com/link(black)_(large)</g:link>
<g:link>https://example.com/link#foo</g:link>
<g:link><![CDATA[https://example.com/link?utm_source=1&utm_medium=2]]></g:link>
<g:link>http://example.com/link-%E2%84%A2-mu-20%C2%B5m</g:link>

Error Codes​

Below you will find possible error codes generated when validating this field alongside with an example in XML and CSV that would trigger the code. Please refer to the validation rules to understand the cause.

validation_invalid_length
<g:link>https://example.com/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa (more than 2047 characters value)</g:link>
validation_invalid_url
<g:link>http://bar</g:link>
validation_invalid_url_fragment
<g:link>https://example.com/link##</g:link>
validation_invalid_url_host
<g:link>http://example%.com/link</g:link>
validation_invalid_url_path
<g:link>https://example.com/link[12-34]</g:link>
validation_invalid_url_port
<g:link>http://example.com:foo/link</g:link>
validation_invalid_url_query
<g:link>https://example.com/link?param=value^up-arrow</g:link>
validation_url_scheme_not_allowed
<g:link>foo://example.com/link</g:link>
<g:link>ftp://example.com/link</g:link>
<g:link>ftps://example.com/link</g:link>
<g:link>sftp://example.com/link</g:link>

Properties​

PropertyValueDescription
Data TypeurlClosest data type in code
NestedFalseDefines if this field consists of one or more sub-fields
Case SensitiveTrueIf small or large letters matter for this field
RepeatableFalseIf you can supply multiple items of this field (it´s a list)
Repeatable limit0If a list, this specifices the max number of items

Changelog​

📅 2022-12-07

Added

Initial definition

References​