Skip to main content
POST
https://incarts-api-qob6vapoca-uc.a.run.app
/
v1
/
links
/
{linkId}
/
qr-codes
Create a QR code for a shoppable link
curl --request POST \
  --url https://incarts-api-qob6vapoca-uc.a.run.app/v1/links/{linkId}/qr-codes \
  --header 'Content-Type: application/json' \
  --header 'X-Incarts-API-Key: <api-key>' \
  --data '
{
  "identifier": "in-store-display",
  "name": "In-store display"
}
'
{
  "data": {
    "id": "qr_default",
    "linkId": "lnk_01JZ4TDK6A0NV2HG6R3Q7E28Y9",
    "name": "Default QR code",
    "imageUrl": "https://in2carts.com/qr/qr_default",
    "encodedUrl": "https://in2carts.com/abc123",
    "isDefault": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "metadata": {
      "campaignId": "cmp_123"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://incarts.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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:
{ "campaignId": "cmp_123" }

Response

QR code created.

data
object
required