Share
The Sharing module simplifies the creation and sharing of QR codes and short links. Use it to generate QR codes for apps, products, collections, and URLs. Create short links for long URLs and retrieve them, along with the original URLs, using their respective codes.
It facilitates QR code generation for applications, products, collections, URLs, and also enables the management of short links, including their creation and retrieval of original links using their hashes.
Operations
POST
# App QR code.
POST
# Product QR code.
POST
# Collection QR code.
POST
# URL to QR code.
POST
# Shorten URL.
GET
# Fetch short link.
GET
# Original URL.
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `QRCodeResp` for more details.
QRCodeResp
link
string
Original url that was used to encoded url into a QR code.
svg
string
String representation of the QR Code in SVG format.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
App QR code.
getApplicationQRCode
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint.
Response
200
Success. Check the example shown below or refer `QRCodeResp` for more details.
QRCodeResp
link
string
Original url that was used to encoded url into a QR code.
svg
string
String representation of the QR Code in SVG format.
Examples
Parameters
slug:
"1SDQa"
Was this section helpful?
POST
Response
Product QR code.
getProductQRCodeBySlug
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a collection. You can get slug value from the endpoint.
Response
200
Success. Check the example shown below or refer `QRCodeResp` for more details.
QRCodeResp
link
string
Original url that was used to encoded url into a QR code.
svg
string
String representation of the QR Code in SVG format.
Examples
Parameters
slug:
"1SDQa"
Was this section helpful?
POST
Response
Collection QR code.
getCollectionQRCodeBySlug
Parameters
url
string
Required
A link or a web address of a given URL transformed into a scannable QR code.
Response
200
400
Success. Check the example shown below or refer `QRCodeResp` for more details.
QRCodeResp
link
string
Original url that was used to encoded url into a QR code.
svg
string
String representation of the QR Code in SVG format.
Examples
Parameters
url:
"https://fynd.com"
Was this section helpful?
POST
Response
URL to QR code.
getUrlQRCode
Parameters
No Parameters
Request body
title
string
Required
Give a name to the link.
url
string
Required
The web address to shorten.
hash
string
A string value used for converting long URL to short URL and vice-versa.
active
boolean
Status of the shortlink.
expire_at
string
| date-time
Expiry of the shortlink.
enable_tracking
boolean
Flag to enable tracking of a short link.
personalized
boolean
To create personalized short links.
campaign
object (CampaignShortLink)
CampaignShortLink
source
string
Source of communication of campaign.
medium
string
Channel of communication of campaign.
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
web
object (WebRedirect)
WebRedirect
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
force_web
boolean
Flag for overriding redirection traffic to the web if the app is not installed when the link is clicked.
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
Expiration of campaign.
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
Title to be displayed when link is shared on social media platforms.
description
string
Description to be displayed when link is shared on social media platforms.
image
string
Preview to be displayed when link is shared on social media platforms.
count
integer
Click count of shortlink.
Response
200
400
Success. Check the example shown below or refer `ShortLinkRes` for more details.
ShortLinkRes
title
string
Name reference of the shortlink.
url
object (UrlInfo)
UrlInfo
original
string
hash
string
A string value used for converting long URL to short URL and vice-versa.
short_url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Reference of the creator of the shortlink.
app_redirect
boolean
Application redirection flag of shortlink.
fallback
string
Fallback attributes of shortlink.
Enum
active
boolean
Status of the shortlink.
_id
string
Key used to uniquely identify document that contains shortlink details.
enable_tracking
boolean
Flag to enable tracking of a short link.
expire_at
string
| date-time
Expiry of the shortlink.
application
string
The ID of the sales channel associated with the shortlink.
user_id
string
Identifier which can uniquely identify the user.
created_at
string
| date-time
The timestamp indicating when a record was initially created.
meta
object
Additional attributes of shortlink.
updated_at
string
| date-time
The timestamp indicating when a record was last modified or updated.
personalized
boolean
To create personalized short links.
campaign
object (CampaignShortLink)
CampaignShortLink
source
string
Source of communication of campaign.
medium
string
Channel of communication of campaign.
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
web
object (WebRedirect)
WebRedirect
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
force_web
boolean
Flag for overriding redirection traffic to the web if the app is not installed when the link is clicked.
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
Expiration of campaign.
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
Title to be displayed when link is shared on social media platforms.
description
string
Description to be displayed when link is shared on social media platforms.
image
string
Preview to be displayed when link is shared on social media platforms.
count
integer
Click count of shortlink.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Shorten URL.
createShortLink
Parameters
hash
string
Required
A string value used for converting long URL to short URL and vice-versa.
Response
200
404
Success. Check the example shown below or refer `ShortLinkRes` for more details.
ShortLinkRes
title
string
Name reference of the shortlink.
url
object (UrlInfo)
UrlInfo
original
string
hash
string
A string value used for converting long URL to short URL and vice-versa.
short_url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Reference of the creator of the shortlink.
app_redirect
boolean
Application redirection flag of shortlink.
fallback
string
Fallback attributes of shortlink.
Enum
active
boolean
Status of the shortlink.
_id
string
Key used to uniquely identify document that contains shortlink details.
enable_tracking
boolean
Flag to enable tracking of a short link.
expire_at
string
| date-time
Expiry of the shortlink.
application
string
The ID of the sales channel associated with the shortlink.
user_id
string
Identifier which can uniquely identify the user.
created_at
string
| date-time
The timestamp indicating when a record was initially created.
meta
object
Additional attributes of shortlink.
updated_at
string
| date-time
The timestamp indicating when a record was last modified or updated.
personalized
boolean
To create personalized short links.
campaign
object (CampaignShortLink)
CampaignShortLink
source
string
Source of communication of campaign.
medium
string
Channel of communication of campaign.
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
web
object (WebRedirect)
WebRedirect
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
force_web
boolean
Flag for overriding redirection traffic to the web if the app is not installed when the link is clicked.
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
Expiration of campaign.
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
Title to be displayed when link is shared on social media platforms.
description
string
Description to be displayed when link is shared on social media platforms.
image
string
Preview to be displayed when link is shared on social media platforms.
count
integer
Click count of shortlink.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
hash:
"1SDQa"
Was this section helpful?
GET
Response
Fetch short link.
getShortLinkByHash
Parameters
hash
string
Required
A string value used for converting long URL to short URL and vice-versa.
Response
200
404
Success. Check the example shown below or refer `ShortLinkRes` for more details.
ShortLinkRes
title
string
Name reference of the shortlink.
url
object (UrlInfo)
UrlInfo
original
string
hash
string
A string value used for converting long URL to short URL and vice-versa.
short_url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_by
string
Reference of the creator of the shortlink.
app_redirect
boolean
Application redirection flag of shortlink.
fallback
string
Fallback attributes of shortlink.
Enum
active
boolean
Status of the shortlink.
_id
string
Key used to uniquely identify document that contains shortlink details.
enable_tracking
boolean
Flag to enable tracking of a short link.
expire_at
string
| date-time
Expiry of the shortlink.
application
string
The ID of the sales channel associated with the shortlink.
user_id
string
Identifier which can uniquely identify the user.
created_at
string
| date-time
The timestamp indicating when a record was initially created.
meta
object
Additional attributes of shortlink.
updated_at
string
| date-time
The timestamp indicating when a record was last modified or updated.
personalized
boolean
To create personalized short links.
campaign
object (CampaignShortLink)
CampaignShortLink
source
string
Source of communication of campaign.
medium
string
Channel of communication of campaign.
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
web
object (WebRedirect)
WebRedirect
link
string
Fallback URL to redirect users to the app store or a web page if the app is not installed when they click the link.
type
string
Type of fallback used to redirect users to the app store or a web page if the app is not installed when they click the link.
Enum
force_web
boolean
Flag for overriding redirection traffic to the web if the app is not installed when the link is clicked.
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
Expiration of campaign.
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
Title to be displayed when link is shared on social media platforms.
description
string
Description to be displayed when link is shared on social media platforms.
image
string
Preview to be displayed when link is shared on social media platforms.
count
integer
Click count of shortlink.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
hash:
"1SDQa"
Was this section helpful?
GET
Response