Skip to main content
POST
Create app link

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /app-links.

gtin
string<gtin>
required

GTIN of the product to show the link on (8, 12, 13 or 14 digits). Must be a product the caller's organization owns, else 404.

Required string length: 8 - 14
name
string
required

App name.

Required string length: 1 - 255
Pattern: ^[^\x00]{1,255}$
url
string
required

Store listing or web app URL. Must start with https://.

Required string length: 9 - 500
Pattern: ^[Hh][Tt][Tt][Pp][Ss]://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,491}$
platform
enum<string>
default:ios

Where the app runs.

Available options:
ios,
android,
macos,
windows,
linux,
amazon,
huawei,
samsung,
web,
other
description
string
default:""

Short description.

Maximum string length: 500
Pattern: ^[^\x00]{0,500}$
minimum_version
string
default:""

Minimum app version the product needs.

Maximum string length: 50
Pattern: ^[^\x00]{0,50}$
is_required
boolean
default:false

Whether the product needs the app to work.

priority
integer
default:0

Display order on the hosted page (ascending).

Required range: 0 <= x <= 32767

Response

Created

An app link as read from the API. Mirrors :class:apps.products.models.AppLink.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
product_id
string<shortuuid>
required

The product this link is shown on.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string
required

The product's GTIN, normalized to GTIN-14.

platform
enum<string>
required

Where the app runs.

Available options:
ios,
android,
macos,
windows,
linux,
amazon,
huawei,
samsung,
web,
other
name
string
required

App name.

url
string
required

Store listing or web app URL (https).

description
string
required

Short description. Empty string when unset.

minimum_version
string
required

Minimum app version the product needs. Empty string when unset.

is_required
boolean
required

Whether the product needs the app to work.

priority
integer
required

Display order on the hosted page (ascending).

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).