GS1 Digital Link

Add a link type

Adds a destination for one link type. Exactly one link is the default; setting a new default unsets the others.

post/gs1/products/{product_id}/links/

Request

  • Base URL: https://hovercode.com/api/v2
  • URL: https://hovercode.com/api/v2/gs1/products/{product_id}/links/
  • Auth: API key in header Authorization

Path parameters

product_idstring uuid required

GS1 product ID.

Request body

link_type'gs1:pip' | 'gs1:quickStartGuide' | 'gs1:instructions' | 'gs1:safetyInfo' | 'gs1:recipeInfo' | 'gs1:traceability' | 'gs1:hasRetailers' | 'gs1:recallStatus' | 'gs1:review' | 'gs1:ePIL' | 'gs1:productSustainabilityInfo' | 'gs1:promotion' | 'gs1:masterData' | 'gs1:smpc' | 'gs1:certificationInfo' | 'gs1:registerProduct' required
titlestring required
destination_urlstring required
is_defaultboolean
languagestring nullable
media_typestring nullable

Example request

{
  "language": "en"
}

Response

Link created.

idstring uuid required
link_type'gs1:pip' | 'gs1:quickStartGuide' | 'gs1:instructions' | 'gs1:safetyInfo' | 'gs1:recipeInfo' | 'gs1:traceability' | 'gs1:hasRetailers' | 'gs1:recallStatus' | 'gs1:review' | 'gs1:ePIL' | 'gs1:productSustainabilityInfo' | 'gs1:promotion' | 'gs1:masterData' | 'gs1:smpc' | 'gs1:certificationInfo' | 'gs1:registerProduct' required
titlestring required
destination_urlstring required
is_defaultboolean required
languagestring nullable
media_typestring nullable

Example response

{
  "language": "en"
}

Changes

No recorded changes to this operation across all 1 revision of this API.