Skip to main content
POST
Create a QR code for a shoppable link

Authorizations

X-Incarts-API-Key
string
header
required

Headers

Idempotency-Key
string

Stable client-generated key used to safely retry write requests.

Required string length: 8 - 128
X-Correlation-ID
string

Client-supplied request correlation ID. The API echoes this value when provided.

Required string length: 8 - 128

Path Parameters

Public Incarts link identifier.

Required string length: 3 - 128

Body

application/json
identifier
string
required

Client-chosen QR code identifier unique within the link.

Pattern: ^[A-Za-z0-9-]{3,64}$
Example:

"in-store-display"

name
string
required
Required string length: 1 - 120
Example:

"In-store display"

metadata
object

Caller-supplied metadata stored with the resource. Do not put secrets here.

Example:

Response

QR code created.

data
object
required