Skip to main content
GET
https://incarts-api-qob6vapoca-uc.a.run.app
/
v1
/
links
/
{linkId}
Get a shoppable link
curl --request GET \
  --url https://incarts-api-qob6vapoca-uc.a.run.app/v1/links/{linkId} \
  --header 'X-Incarts-API-Key: <api-key>'
{
  "data": {
    "id": "lnk_01JZ4TDK6A0NV2HG6R3Q7E28Y9",
    "projectId": "proj_123",
    "name": "Summer grilling basket",
    "shortLink": "https://in2carts.com/abc123",
    "shortId": "abc123",
    "targetUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "publicName": "Shop the grilling list",
    "products": [
      {
        "retailerProductId": "123456789",
        "quantity": 1,
        "backupProductIds": [
          "987654321",
          "555555555"
        ]
      }
    ],
    "qrCode": {
      "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"
      }
    },
    "metadata": {
      "campaignId": "cmp_123"
    },
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

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

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

Response

Link found.

data
object
required