Skip to main content
POST
https://incarts-api-qob6vapoca-uc.a.run.app
/
v1
/
links
curl --request POST \
  --url https://incarts-api-qob6vapoca-uc.a.run.app/v1/links \
  --header 'Content-Type: application/json' \
  --header 'X-Incarts-API-Key: <api-key>' \
  --data '
{
  "projectId": "proj_123",
  "name": "Summer grilling basket",
  "retailer": "walmart",
  "intent": "add_to_cart"
}
'
{
  "data": {
    "id": "lnk_01JZ4TDK6A0NV2HG6R3Q7E28Y9",
    "projectId": "proj_123",
    "name": "Summer grilling basket",
    "publicName": "Shop the grilling list",
    "retailer": "walmart",
    "intent": "add_to_cart",
    "status": "active",
    "shortLink": "https://in2carts.com/abc123",
    "shortId": "abc123",
    "targetUrl": "https://www.walmart.com/sc/cart/addToCart?items=123456789_1",
    "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": "2026-05-20T07:19:00Z"
    },
    "createdAt": "2026-05-20T07:19:00Z"
  }
}

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

Body

application/json
​
projectId
string
required

Project that owns the link.

Required string length: 1 - 128
Example:

"proj_123"

​
name
string
required

Internal name for the link, shown in your dashboards.

Required string length: 1 - 160
Example:

"Summer grilling basket"

​
retailer
enum<string>
required
Available options:
walmart,
target,
instacart,
custom
​
intent
enum<string>
required
Available options:
add_to_cart,
product_detail,
shopping_list,
recipe,
custom_url
​
publicName
string

Optional display name for public surfaces.

Required string length: 1 - 160
Example:

"Shop the grilling list"

​
products
object[]

Retailer product selections for product and cart style links.

Required array length: 1 - 100 elements
​
customUrl
string<uri>

Destination URL for custom_url links.

Example:

"https://www.example.com/landing-page"

​
fallbackUrl
string<uri>

Fallback destination used when a better retailer URL can't be built.

Example:

"https://www.walmart.com/"

​
location
object
​
options
object
​
tracking
object
​
metadata
object

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

Example:
{ "campaignId": "cmp_123" }
​
defaultQrCode
object

Response

Link created.

​
data
object
required