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.
QR code is unique code which you can scan from your mobile and redirected to respective information. You have the option to create a QR code using a long URL, product slug, or collection slug. By scanning this QR code with a QR scanner, you'll be redirected to the corresponding URL. Additionally, you can create a shortened URL from a long URL, product slug, or collection slug. This shortened URL is particularly useful for SMS and email sharing due to the character constraints of URLs in SMS communication.
Operations
POST
# App QR code
POST
# Product QR code
POST
# Collection QR code
POST
# URL to QR code
POST
# Shorten URL
GET
# Get 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
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint.
Response
200
4XX
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:
"value"
Was this section helpful?
POST
Response
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a collection. You can get slug value from the endpoint.
Response
200
4XX
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:
"value"
Was this section helpful?
POST
Response
Parameters
url
string
Required
A link or a web address of a given URL transformed into a scannable QR code.
Response
200
4XX
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:
"value"
Was this section helpful?
POST
Response
Parameters
No Parameters
Request body
title
string
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
4XX
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
Original web address which will be converted to shortlink.
hash
string
A string value used for converting long URL to short URL and vice-versa.
short_url
string
Condensed version of a longer URL, redirecting to the original page upon being clicked.
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.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Parameters
hash
string
Required
A string value used for converting long URL to short URL and vice-versa.
Response
200
4XX
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
Original web address which will be converted to shortlink.
hash
string
A string value used for converting long URL to short URL and vice-versa.
short_url
string
Condensed version of a longer URL, redirecting to the original page upon being clicked.
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.
Examples
Parameters
hash:
"value"
Was this section helpful?
GET
Response
Parameters
hash
string
Required
A string value used for converting long URL to short URL and vice-versa.
Response
200
4XX
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
Original web address which will be converted to shortlink.
hash
string
A string value used for converting long URL to short URL and vice-versa.
short_url
string
Condensed version of a longer URL, redirecting to the original page upon being clicked.
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.
Examples
Parameters
hash:
"value"
Was this section helpful?
GET
Response