Quickstart

Create a shoppable Incarts link from a single API request

This guide creates a Walmart add-to-cart link. Replace the placeholders with the projectId and API key Incarts issued for your integration, plus your retailer product IDs.

1. Set the base URL

   export INCARTS_API_BASE_URL="https://incarts-api-qob6vapoca-uc.a.run.app"
   
2. Set your API key

   export INCARTS_API_KEY="ic_live_your_key_here"
   

   Every authenticated endpoint expects the key in the X-Incarts-API-Key header. Incarts issues an API key with the scopes your integration needs.

3. Set your project ID

   export INCARTS_PROJECT_ID="proj_abc123"
   

   Incarts provides this value during onboarding. It identifies which project owns the created link.

4. Create a shoppable link

   curl --request POST "$INCARTS_API_BASE_URL/v1/links" \
     --header "Content-Type: application/json" \
     --header "X-Incarts-API-Key: $INCARTS_API_KEY" \
     --header "Idempotency-Key: link-create-20260521-001" \
     --data '{
       "projectId": "'"$INCARTS_PROJECT_ID"'",
       "name": "Summer grilling basket",
       "publicName": "Shop the grilling list",
       "retailer": "walmart",
       "intent": "add_to_cart",
       "products": [
         {
           "retailerProductId": "550098461",
           "quantity": 1,
           "backupProductIds": []
         }
       ],
       "fallbackUrl": "https://www.walmart.com/",
       "tracking": {
         "utm": {
           "source": "newsletter",
           "medium": "email",
           "campaign": "summer-grilling"
         },
         "tags": ["grilling", "q3"]
       }
     }'
   
5. Use the returned link

   A successful request returns a 201 response with the created link resource, including the shareable shortLink and default QR code metadata.

To use Walmart smart-select, include location.zipCode and optionally location.storeId. Without location data, Walmart requests create a direct add-to-cart URL from the product IDs you send.

Next steps

Authentication

Pass API keys and retry write requests safely.

Get API access

See where projectId, API keys, and scopes come from.

Link workflows

Compare supported retailer intents and payload rules.

QR codes

Create additional QR codes for placements and channels.

Endpoint reference

See schemas, examples, and response codes.