Skip to main content

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.

The current Incarts API covers link and QR code creation. Product, project, and campaign APIs are on the way.
These areas are not yet available. Use this page to plan ahead.

Product APIs

Product APIs will let you import and manage the products that power links, QR codes, and shoppable pages.
CapabilityWhat it will support
Import productsSubmit a retailer URL and receive normalized product details such as name, brand, price, images, retailer product ID, UPC or GTIN, and retailer metadata. Direct import is planned for Walmart, Target, and Kroger URLs.
Manage productsCreate, list, update, and delete project-scoped products.
Retailer metadataStore retailer-specific records such as retailerItemId, tcin, walmartOfferId, product page URLs, categories, and verification status.
Editable display fieldsEdit display name, description, and other presentation details without losing the retailer-imported source data.

Project APIs

Project APIs will expose the organization layer that scopes products, links, pages, campaigns, and team access.
CapabilityWhat it will support
List projectsReturn projects your API key can access, including status and basic counts.
Manage projectsCreate and update project names, descriptions, status, and selected settings.
Read project settingsRetrieve link prefix, tracking, branding, and default retailer settings used by other workflows.
Project-scoped accessManage which API keys and team members can access each project.

Campaign APIs

Campaign APIs will let you group links and QR codes into marketing initiatives and keep tracking metadata consistent.
CapabilityWhat it will support
Manage campaignsCreate, list, update, archive, and delete project-scoped campaigns, including name, description, status, date range, and budget.
Default UTM parametersSet campaign-level UTM defaults that flow into linked links and QR codes.
Attach linksAssociate existing links with campaigns after link creation.
Manage variationsCreate campaign variations for channels such as email, social, paid media, or in-store placements, with per-variation UTM overrides.
Out-of-stock notificationsConfigure alert settings for campaign products.

Release order

Product APIs will land first, followed by project and campaign APIs.
Keep using the link and QR code endpoints for production today. Use this page to plan how product, project, and campaign APIs will fit into your integration.