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 & Short Link

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

/service/application/share/v1.0/qr/

# App QR code

POST

/service/application/share/v1.0/qr/products/{slug}/

# Product QR code

POST

/service/application/share/v1.0/qr/collection/{slug}/

# Collection QR code

POST

/service/application/share/v1.0/qr/url/

# URL to QR code

POST

/service/application/share/v1.0/links/short-link/

# Shorten URL

GET

/service/application/share/v1.0/links/short-link/{hash}/

# Get short link

GET

/service/application/share/v1.0/links/short-link/{hash}/original/

# Original URL

POST

App QR code

Generates a QR code for the application for easy sharing.

Parameters

No Parameters

Response

200

Success. Check the example shown below or refer `QRCodeResp` for more details.

QRCodeResp

link

string

Optional

svg

string

Optional

Examples

Parameters

Parameters are not required.

Was this section helpful?

POST

/service/application/share/v1.0/qr/

cURLJavaScriptPythonJavaKotlinSwift

Loading...

Response

200

Loading...

App QR code

getApplicationQRCode

POST

Product QR code

Creates a QR code for a specific product identified by its slug.

Parameters

slug

string

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

Optional

svg

string

Optional

Examples

Parameters

slug:

"value"

Was this section helpful?

POST

/service/application/share/v1.0/qr/products/{slug}/

cURLJavaScriptPythonJavaKotlinSwift

Loading...

Response

2004XX

Loading...

Product QR code

getProductQRCodeBySlug

POST

Collection QR code

Generates a QR code for a specific product collection using its slug.

Parameters

slug

string

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

Optional

svg

string

Optional

Examples

Parameters

slug:

"value"

Was this section helpful?

POST

/service/application/share/v1.0/qr/collection/{slug}/

cURLJavaScriptPythonJavaKotlinSwift

Loading...

Response

2004XX

Loading...

Collection QR code

getCollectionQRCodeBySlug

POST

URL to QR code

Converts a given URL into a scannable QR code.

Parameters

url

string

A link or a web address

Response

200

4XX

Success. Check the example shown below or refer `QRCodeResp` for more details.

QRCodeResp

link

string

Optional

svg

string

Optional

Examples

Parameters

url:

"value"

Was this section helpful?

POST

/service/application/share/v1.0/qr/url/

cURLJavaScriptPythonJavaKotlinSwift

Loading...

Response

2004XX

Loading...

URL to QR code

getUrlQRCode

POST

Shorten URL

Creates a shortened version of a given URL for easier sharing.

Parameters

body

object (ShortLinkReq)

ShortLinkReq

title

string

Give a name to the link.

url

string

The web address to shorten.

hash

string

Optional

active

boolean

Optional

expire_at

string

Optional

enable_tracking

boolean

Optional

personalized

boolean

Optional

To create personalized short links.

campaign

object (CampaignShortLink)

Optional

CampaignShortLink

redirects

object (Redirects)

Optional

Redirects

attribution

object (Attribution)

Optional

Attribution

social_media_tags

object (SocialMediaTags)

Optional

SocialMediaTags

count

integer

Optional

Response

200

4XX

Success. Check the example shown below or refer `ShortLinkRes` for more details.

ShortLinkRes

title

string

Optional

url

object (UrlInfo)

Optional

UrlInfo

created_by

string

Optional

app_redirect

boolean

Optional

fallback

string

Optional

Enum

active

boolean

Optional

_id

string

Optional

enable_tracking

boolean

Optional

expire_at

string

Optional

application

string

Optional

user_id

string

Optional

created_at

string

Optional

meta

object

Optional

updated_at

string

Optional

personalized

boolean

Optional

To create personalized short links

campaign

object (CampaignShortLink)

Optional

CampaignShortLink

redirects

object (Redirects)

Optional

Redirects

attribution

object (Attribution)

Optional

Attribution

social_media_tags

object (SocialMediaTags)

Optional

SocialMediaTags

count

integer

Optional

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/application/share/v1.0/links/short-link/

cURLJavaScriptPythonJavaKotlinSwift

Loading...

Response

2004XX

Loading...

Shorten URL

createShortLink

GET

Get short link

Retrieves a previously created short link using its hash identifier.

Parameters

hash

string

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

Optional

url

object (UrlInfo)

Optional

UrlInfo

created_by

string

Optional

app_redirect

boolean

Optional

fallback

string

Optional

Enum

active

boolean

Optional

_id

string

Optional

enable_tracking

boolean

Optional

expire_at

string

Optional

application

string

Optional

user_id

string

Optional

created_at

string

Optional

meta

object

Optional

updated_at

string

Optional

personalized

boolean

Optional

To create personalized short links

campaign

object (CampaignShortLink)

Optional

CampaignShortLink

redirects

object (Redirects)

Optional

Redirects

attribution

object (Attribution)

Optional

Attribution

social_media_tags

object (SocialMediaTags)

Optional

SocialMediaTags

count

integer

Optional

Examples

Parameters

hash:

"value"

Was this section helpful?

GET

/service/application/share/v1.0/links/short-link/{hash}/

cURLJavaScriptPythonJavaKotlinSwift

Loading...

Response

2004XX

Loading...

Get short link

getShortLinkByHash

GET

Original URL

Retrieve the original link from a short-link by using a hash value.

Parameters

hash

string

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

Optional

url

object (UrlInfo)

Optional

UrlInfo

created_by

string

Optional

app_redirect

boolean

Optional

fallback

string

Optional

Enum

active

boolean

Optional

_id

string

Optional

enable_tracking

boolean

Optional

expire_at

string

Optional

application

string

Optional

user_id

string

Optional

created_at

string

Optional

meta

object

Optional

updated_at

string

Optional

personalized

boolean

Optional

To create personalized short links

campaign

object (CampaignShortLink)

Optional

CampaignShortLink

redirects

object (Redirects)

Optional

Redirects

attribution

object (Attribution)

Optional

Attribution

social_media_tags

object (SocialMediaTags)

Optional

SocialMediaTags

count

integer

Optional

Examples

Parameters

hash:

"value"

Was this section helpful?

GET

/service/application/share/v1.0/links/short-link/{hash}/original/

cURLJavaScriptPythonJavaKotlinSwift

Loading...

Response

2004XX

Loading...

Original URL

getOriginalShortLinkByHash