Customer API

GET/cx/v1/capabilities

{
  "tenant": "youraccount",
  "tenantType": "retailer",              // manufacturer | retailer | vertical
  "mode": "live",                        // live | test, from the key
  "aggregationFloor": 5,
  "labels": {
    "location": "Showroom"               // white-label terms, when configured
  },
  "families": [
    {
      "name": "products",
      "key": "publishable",
      "scopes": ["products:read", "recommendations:read"],
      "label": null,
      "endpoints": [
        "GET /cx/v1/products/top/{range}",
        "GET /cx/v1/products/{id}",
        "GET /cx/v1/products/search",
        "GET /cx/v1/products/trending",
        "GET /cx/v1/recommendations",
        "GET /cx/v1/recommendations/model"
      ]
    },
    {
      "name": "store-performance",
      "key": "secret",
      "scopes": ["store-performance:read"],
      "label": "Showroom",
      "endpoints": [
        "GET /cx/v1/stores/{range}",
        "GET /cx/v1/stores/{range}/{storeId}"
      ]
    }
  ]
}

POST/cx/v1/ingest/event

Reorder requests. A dealer or rep portal can send "type": "reorder_request" with properties: { customerRef, lines: [{ productId, quantity, note }], poNumber, note }. Because it creates an order request, send it from your server with a secret key; a publishable key gets 403 secret_key_required. It records the event as usual and, when your account runs the Plunk Commerce order desk, also creates an order request draft; the response then adds orderRequestId and orderRequestNumber.

curl -X POST https://api.plunk.io/cx/v1/ingest/event \
  -H "Authorization: Bearer pk_live_XXXX" -H "Content-Type: application/json" \
  -d '{
        "type": "product_view",
        "visitorRef": "v_84af",
        "productId": "L-2750-52"
      }'

# 202 Accepted
{
  "accepted": true,
  "eventId": "9d1c…",
  "type": "product_view"
}

POST/cx/v1/ingest/identify

Associates an anonymous visitor with a known identity. visitorRef is required, plus at least one of email, hashedEmail, userId; optional traits object.

{
  "accepted": true,
  "eventId": "41be…",
  "visitorRef": "v_84af"
}

POST/cx/v1/ingest/sale sk

Record a settled order as real sales data: revenue dashboards, product and store performance, customer purchase history, and lifecycle stages all read from it. This is the endpoint a payment integration calls from its webhook handler; wire it to Stripe's checkout.session.completed or invoice.paid and your sales arrive as they happen. Posting the same orderId again replaces that order's lines, so webhook retries and corrections are safe. The buyer behind customerRef is created on first sight and linked to the sale; a first sale advances them to the Customer lifecycle stage automatically. Secret key only: a publishable key gets 403 secret_key_required.

curl -X POST "https://api.plunk.io/cx/v1/ingest/sale" \
  -H "Authorization: Bearer sk_live_..." -H "Content-Type: application/json" \
  -d '{
        "orderId": "cs_a1B2c3",
        "customerRef": "cus_R8xT2m",
        "email": "buyer@example.com",
        "channel": "stripe",
        "currency": "USD",
        "lines": [
          {"productId": "230-00", "description": "Skyline Sofa", "quantity": 2, "price": 2398.00}
        ]
      }'

# 200 OK
{
  "accepted": true,
  "orderId": "cs_a1B2c3",
  "linesWritten": 1,
  "customerId": "43f7…",
  "customerCreated": true
}

Two posts for the same new buyer at the same moment can return 503 ingest_busy; retry with backoff.

POST/cx/v1/ingest/order-status sk

Your ERP's order status reports: one call per status change, or a batch of up to 500 orders. erpOrderId is the join key to the order's sales rows, so open and invoiced orders report correctly everywhere. orderRequest or poNumber links the first report to a portal order request. Status words you send are stored as given. Secret key only.

curl -X POST "https://api.plunk.io/cx/v1/ingest/order-status" \
  -H "Authorization: Bearer sk_live_..." -H "Content-Type: application/json" \
  -d '{"orders":[
    {"erpOrderId":"SO-55120","status":"Shipped","poNumber":"PO-7781",
     "shipments":[{"carrier":"UPS","tracking":"1Z999…","shippedDate":"2026-10-13",
                   "lines":[{"productId":"230-00","qty":2}]}]}
  ]}'

# 200 OK
{
  "accepted": 1,
  "rejected": 0,
  "orders": [
    {
      "erpOrderId": "SO-55120",
      "orderRequestId": "…",
      "orderRequestNumber": "OR-1042",
      "linked": true,
      "from": "Open",
      "to": "Shipped",
      "salesRowsUpdated": 3,
      "error": null
    }
  ]
}

422 invalid_status_report when no order in the call was accepted (each row's error says why); 404 not_tracked when your account doesn't run the order desk.

POST/cx/v1/ingest/inventory sk

Push stock levels from your own system. Secret key only, scope inventory:write: this updates business data and flips product availability. The same numbers can arrive by CSV feed or the Shopify connector instead; all three write identically, so use whichever your stack produces most easily.

curl -X POST "https://api.plunk.io/cx/v1/ingest/inventory" \
  -H "Authorization: Bearer sk_live_..." -H "Content-Type: application/json" \
  -d '{"items":[
    {"sku":"230-00","source":"Main Warehouse","qtyOnHand":6,"qtyBackordered":4},
    {"sku":"230-00","source":"In Transit","qtyOnHand":30,"availableDate":"2026-10-12"}
  ]}'

{
  "accepted": true,
  "itemsWritten": 2,
  "skusAggregated": 1,
  "availabilityUpdated": 1,
  "unknownSkusSkipped": 0,
  "sources": ["Main Warehouse", "In Transit"]
}

Each request replaces the sources it carries and leaves other sources alone, so a snapshot per warehouse is safe to send independently. Up to 5,000 items per request; page larger snapshots. Availability on your products becomes a consequence of these numbers: on hand means in stock, inbound-only means backorder, neither means out of stock. If no SKU in the push matches your catalog, the response is 422 no_matching_skus.

GET/cx/v1/products/top/{range}

Ranked by revenue. Publishable keys receive rank, units and orders, with an aggregation floor (rows under 5 orders are suppressed). Secret keys additionally receive revenue and aov, with no floor.

curl "https://api.plunk.io/cx/v1/products/top/this_month?limit=3" \
  -H "Authorization: Bearer sk_live_XXXX"

{
  "range": "this_month",
  "groupBy": "product",
  "keyClass": "secret",
  "count": 3,
  "items": [
    {
      "rank": 1,
      "id": "L-2750-52",
      "title": "Track-Arm Sofa",
      "category": "Sofas",
      "units": 41,
      "orders": 38,
      "revenue": 61250.00,
      "aov": 1611.84
    }
  ]
}

GET/cx/v1/products/{id}

The public product card, safe for a storefront. Never includes cost.

{
  "id": "L-2750-52",
  "title": "Track-Arm Sofa",
  "category": "Sofas",
  "price": 1899.00,
  "salePrice": null,
  "image": "https://…",
  "link": "https://…",
  "availability": "in stock",
  "brand": "…"
}

GET/cx/v1/products/search

Semantic search. Matches on meaning rather than keywords, so "something for a small entryway" finds narrow console tables even when none of those words appear in a title. Results are then re-ranked by a blend of relevance, units sold and conversion rate, applied only among products that already matched.

curl "https://api.plunk.io/cx/v1/products/search?q=dresser&limit=3" \
  -H "Authorization: Bearer pk_live_..."

{
  "query": "dresser",
  "ranking": "blended",
  "count": 3,
  "items": [
    {
      "rank": 1,
      "id": "…",
      "title": "Carino Dresser - Frost",
      "category": "Bedroom",
      "link": "https://…",
      "imageLink": "https://…",
      "price": 1299.00,
      "availability": "in stock",
      "unitsSold": 24
    }
  ]
}

GET/cx/v1/products/trending

What is getting attention, which is a different question from /products/top/{range}. That one ranks by revenue actually booked; this one ranks the tracker's rollups by views, engagements, conversions or units.

{
  "range": "this_month",
  "sort": "views",
  "count": 20,
  "items": [
    { "rank": 1, "id": "…", "title": "Pacifico Dining Chair", "category": "Seating",
      "link": "https://…", "imageLink": "https://…", "price": 449.00,
      "availability": "in stock" }
  ]
}

GET/cx/v1/recommendations

{
  "basis": "co_purchase",
  "product": "L-2750-52",
  "count": 10,
  "items": [
    {
      "rank": 1,
      "id": "L-2750-OTT",
      "title": "Matching Ottoman",
      "category": "Ottomans",
      "coPurchasedOrders": 19
    }
  ]
}

GET/cx/v1/recommendations/model

The same question answered from a model rebuilt nightly instead of counted live. Prefer this one. The endpoint above counts products in the same order; this counts distinct accounts that bought both over 24 months, weights each pair by how much evidence supports it, and keeps freight, fabric surcharges and card fees out of the results. Both are kept so existing integrations do not change under you.

curl "https://api.plunk.io/cx/v1/recommendations/model?product=5422-22LF&limit=3" \
  -H "Authorization: Bearer pk_live_..."

{
  "basis": "co_purchase_model",
  "product": "5422-22LF",
  "account": null,
  "count": 3,
  "items": [
    {
      "rank": 1,
      "id": "5422-22RF",
      "title": "One Arm Curved Loveseat",
      "category": "Seating",
      "score": 0.594166,        // 0-1, higher is stronger
      "accounts": 22            // accounts that bought both
    }
  ]
}

An empty items array is a real answer, not an error. It means the product is new, has too little purchase history to be confident, or the model has not been built for that catalog yet.

Sectional and modular goods often pair a product with its own mirror half (a left-facing piece with its right-facing twin), so two results can share a title while differing by SKU. That is the strongest signal in the data rather than a duplicate. Render the SKU, not the title alone.

On ?product, score compares pairs across the whole catalog. On ?account it is scaled to the strongest hit in that response, so it ranks items within one answer and is not comparable between accounts.

GET/cx/v1/reviews

{
  "locationRef": null,
  "averageRating": 4.6,
  "reviewCount": 212,
  "recent": [
    {
      "author": "…",
      "rating": 5,
      "text": "…",
      "date": "2026-08-14T00:00:00",
      "sentiment": "positive"
    }
  ]
}

GET/cx/v1/locations

{
  "locations": [
    {
      "id": "S01",
      "name": "Main Street Showroom",
      "type": "store",
      "city": "Charlotte",
      "region": "NC",
      "postalCode": "28202",
      "lat": 35.2271,
      "lng": -80.8431
    },
    {
      "id": "O02",
      "name": "Clearance Outlet",
      "type": "outlet"
    }
  ]
}

GET/cx/v1/markets

Secret keys additionally receive conversionValue per market.

{
  "range": "this_month",
  "keyClass": "publishable",
  "count": 25,
  "items": [
    {
      "rank": 1,
      "city": "Charlotte",
      "region": "NC",
      "sessions": 4210,
      "uniqueUsers": 3384,
      "views": 11840,
      "conversions": 96,
      "lat": 35.22,
      "lng": -80.84
    }
  ]
}

GET/cx/v1/catalog

{
  "count": 50,
  "nextCursor": "L-2750-52",
  "items": [
    {
      "id": "…",
      "title": "…",
      "category": "…",
      "price": 1899.00,
      "salePrice": null,
      "image": "https://…",
      "link": "https://…",
      "availability": "in stock",
      "brand": "…",
      "modifiedDate": "2026-08-20T03:10:00"
    }
  ]
}

# Page forward with ?after=nextCursor until nextCursor is null.

GET/cx/v1/products/{id}/availability

Stock, available-to-promise and "ships in N days" for one product, from the same inventory numbers as the Inventory Planner (CSV feed, Shopify, or /ingest/inventory). Scope availability:read.

{
  "id": "230-00",
  "title": "Skyline Sofa",
  "category": "Sofas",
  "availability": "in stock",          // in stock | backorder | out of stock
  "onHand": 6,
  "inTransit": 30,
  "backordered": 4,
  "atp": 32,                           // on hand + in transit - backordered
  "nextAvailable": "2026-10-12",
  "leadTimeDays": 90,
  "shipsInDays": 0,
  "asOf": "2026-10-14T06:00:00Z",
  "sources": [
    { "source": "Main Warehouse", "status": "…", "onHand": 6, "backordered": 4, "availableDate": null }
  ]
}

404 not_tracked until your account has an inventory snapshot; 404 product_not_found for an unknown id; 404 product_not_tracked when the inventory feed never lists the product (made-to-order goods).

GET/cx/v1/visitor/{reference}/profile

{
  "reference": "18442",
  "firstName": "…",
  "lastName": "…",
  "lifecycleStage": null,
  "segmentCount": 3,
  "segments": [
    {
      "id": "…",
      "name": "High-intent sofas",
      "type": "behavioral"
    }
  ]
}

GET/cx/v1/visitor/{reference}/segments

Just the audience memberships:

{
  "reference": "18442",
  "count": 3,
  "segments": [
    {
      "id": "…",
      "name": "High-intent sofas",
      "type": "behavioral"
    }
  ]
}

GET/cx/v1/dealers

The directory with lifetime totals, ranked by revenue. The dealer id is your customer account number.

{
  "count": 50,
  "rep": null,
  "items": [
    {
      "id": "D-1042",
      "name": "Main Street Interiors",
      "city": "Charlotte",
      "region": "NC",
      "assignedRep": "R07",
      "stage": "customer",
      "lapsed": false,
      "lapseRisk": "watch",
      "customerId": "…",
      "accountStatus": "active",
      "revenue": 412870.00,
      "orders": 214,
      "units": 1130,
      "firstOrder": "2023-02-11T00:00:00",
      "lastOrder": "2026-08-19T00:00:00"
    }
  ]
}

GET/cx/v1/dealers/performance/{range}

Ranked by revenue in the window, with the comparison period and a full-period pace. Scope dealer-performance:read.

{
  "range": "this_quarter",
  "comparison": "previous_period",
  "rep": null,
  "count": 50,
  "items": [
    {
      "id": "D-1042",
      "name": "Main Street Interiors",
      "city": "Charlotte",
      "region": "NC",
      "assignedRep": "R07",
      "revenue": 88450.00,
      "units": 96,
      "orders": 41,
      "aov": 2157.32,
      "revenuePrev": 78690.00,
      "deltaPct": 12.4,
      "pace": 121400.00,              // revenue projected to the end of the window
      "lastOrder": "2026-10-02T00:00:00",
      "lapseRisk": "healthy"
    }
  ]
}

GET/cx/v1/dealers/lapse-risk

Accounts that have gone quiet compared with their own ordering rhythm: the win-back call list. Scope dealer-performance:read.

{
  "rep": "R07",
  "band": "at_risk",
  "minOrders": 3,
  "totalAccounts": 182,
  "medianCadenceDays": 41.0,
  "bands": { "healthy": 120, "watch": 31, "at_risk": 19, "lapsing": 12 },
  "revenueAtRisk": 214300.00,
  "count": 19,
  "items": [
    {
      "customerId": "D-1042",
      "name": "Main Street Interiors",
      "region": "NC",
      "assignedRep": "R07",
      "customerType": "wholesale",
      "orders": 14,
      "firstOrder": "2023-02-11",
      "lastOrder": "2026-07-30",
      "trailing12Revenue": 48210.00,
      "cadenceDays": 32.5,
      "daysSinceLast": 76,
      "ratio": 2.34,
      "band": "at_risk",
      "expectedNextOrder": "2026-08-31"
    }
  ]
}

404 not_applicable when no account has enough orders to score.

GET/cx/v1/dealers/{id}

One dealer: totals, account profile with bill-to and ship-to, the assigned rep, contacts, and top products. Contacts carry personal data, so this stays on secret keys. 404 dealer_not_found for an unknown id.

{
  "dealer": {
    "id": "D-1042",
    "name": "Main Street Interiors",
    "revenue": 412870.00,
    "orders": 214,
    "units": 1130,
    "aov": 1929.30,
    "firstOrder": "…",
    "lastOrder": "…"
  },
  "profile": {
    "accountNumber": "D-1042",
    "name": "Main Street Interiors",
    "parentAccountNumber": null,
    "accountStatus": "active",
    "email": "…",
    "phone": "…",
    "billTo": { "street": "…", "street2": null, "city": "Charlotte", "region": "NC", "postalCode": "28202", "country": "US" },
    "shipTo": { "street": "…", "street2": null, "city": "Charlotte", "region": "NC", "postalCode": "28202", "country": "US" },
    "customerId": "…",
    "stage": "customer",
    "lapsed": false,
    "lapseRisk": "watch",
    "lapseLastOrderDate": "…",
    "lapseCadenceDays": 32.5
  },
  "assignedRep": { "repCode": "R07", "name": "…", "email": "…", "phone": "…", "status": "active" },
  "contacts": [
    { "firstName": "…", "lastName": "…", "email": "…", "phone": "…", "role": "buyer", "isPrimary": true, "personId": 18442 }
  ],
  "topProducts": [
    {
      "id": "…",
      "title": "…",
      "revenue": 61200.00,
      "units": 84
    }
  ]
}

GET/cx/v1/stores/{range}

The roster with chain totals, percent change vs the prior equal-length period, and each store's share of chain revenue.

{
  "range": "this_month",
  "chainRevenue": 2410083.00,
  "chainOrders": 1181,
  "count": 5,
  "stores": [
    {
      "id": "S01",
      "name": "Main Street",
      "type": "store",
      "revenue": 612044.00,
      "orders": 292,
      "units": 631,
      "aov": 2096.04,
      "deltaPct": 7.9,
      "sharePct": 25.4
    }
  ]
}

GET/cx/v1/stores/{range}/{storeId}

One store's KPIs and top categories.

{
  "range": "this_month",
  "id": "S01",
  "name": "Main Street",
  "type": "store",
  "kpi": {
    "revenue": 612044.00,
    "orders": 292,
    "units": 631,
    "aov": 2096.04
  },
  "topCategories": [
    {
      "category": "Sofas",
      "revenue": 228412.00,
      "units": 121
    }
  ]
}

GET/cx/v1/audiences/{range}

{
  "range": "this_month",
  "count": 12,
  "audiences": [
    {
      "name": "High-intent sofas",
      "audienceId": "…",
      "members": 1840,
      "conversions": 44,
      "conversionValue": 96410.00,
      "engagements": 3120,
      "engagementValue": 8140.00,
      "views": 20110,
      "sessions": 6120,
      "uniqueUsers": 1710,
      "avgTimespan": 84.2
    }
  ]
}

GET/cx/v1/audiences/{range}/{audienceId}/trend

Daily membership counts across the window.

{
  "range": "last_90_days",
  "audienceId": "…",
  "name": "High-intent sofas",
  "points": [
    {
      "date": "2026-06-01",
      "members": 1502
    }
  ]
}

GET/cx/v1/customers/sales/{range}

The summary view:

{
  "range": "ytd",
  "summary": {
    "revenue": 1804210.00,
    "orders": 902,
    "units": 1911,
    "customers": 781,
    "aov": 2000.23,
    "repeatCustomers": 84,
    "repeatRatePct": 10.8
  },
  "topCustomers": [
    {
      "customerId": "C-2201",
      "revenue": 41210.00,
      "orders": 6,
      "units": 14,
      "aov": 6868.33,
      "lastOrder": "2026-08-12"
    }
  ]
}

?customerId=D-1042&groupBy=order&status=open, a dealer's open orders:

{
  "range": "this_year",
  "groupBy": "order",
  "status": "open",
  "customerId": "D-1042",
  "count": 1,
  "items": [
    {
      "orderId": "SO-55120",
      "orderDate": "2026-09-28",
      "customerId": "D-1042",
      "customerName": "Main Street Interiors",
      "status": "Open",
      "repCode": "R07",
      "storeId": null,
      "channel": "erp",
      "revenue": 4796.00,
      "units": 4,
      "lineCount": 2,
      "lines": [
        { "productId": "230-00", "title": "Skyline Sofa", "quantity": 2, "price": 2398.00, "status": "Open", "image": "https://…" }
      ]
    }
  ],
  "orderRequests": []
}

groupBy=product returns items: [{ productId, title, category, image, availability, revenue, units, orders, lastOrder }].

GET/cx/v1/orders/requests

Order requests from the Plunk Commerce order desk (quotes accepted and portal reorders) waiting for, or already in, your ERP. ?status= (default pending_erp), ?customerId=, ?top= (default 100). 404 not_tracked when your account doesn't run the order desk.

{
  "status": "pending_erp",
  "count": 1,
  "items": [
    {
      "orderRequestId": "…",
      "number": "OR-1042",
      "quoteNumber": "Q-3310",
      "quoteVersion": 2,
      "source": "portal_reorder",
      "customerId": "D-1042",
      "customerName": "Main Street Interiors",
      "repCode": "R07",
      "poNumber": "PO-7781",
      "requestedDate": "2026-10-20",
      "shipTo": { … },
      "lines": [ … ],
      "totalNet": 4796.00,
      "erpOrderId": null,
      "status": "pending_erp",
      "statusDate": "…",
      "createdDate": "…"
    }
  ]
}

When your ERP accepts one, report it through /ingest/order-status with orderRequest set, and the request links to the order.

GET/cx/v1/contacts/interest

{
  "range": "all_time",
  "email": "…",
  "lastSeen": "2026-08-21T14:02:11Z",
  "impressions": 214,
  "engagements": 38,
  "conversions": 2,
  "conversionValue": 4210.00,
  "topPages": [
    {
      "url": "/sofas/track-arm",
      "views": 31
    }
  ],
  "topActions": [
    {
      "type": "form",
      "action": "quote_request",
      "count": 2
    }
  ]
}

GET/cx/v1/contacts/interest/top/{range}

The most-engaged contacts in the window. ?top= 1–100, default 25.

{
  "range": "last_30_days",
  "count": 25,
  "contacts": [
    {
      "email": "…",
      "engagements": 41,
      "lastSeen": "2026-08-22T09:12:44Z",
      "conversions": 1,
      "conversionValue": 2210.00
    }
  ]
}

GET/cx/v1/forecast/restock

The Inventory Planner's reorder queue: what to order, how much, and by when, from stock on hand, inbound units, sales velocity and lead time. ?category=, ?limit= (1–500, default 100), or ?sku= for one product.

{
  "category": null,
  "windowDays": 14,
  "count": 100,
  "totalPlanable": 412,
  "items": [
    {
      "sku": "230-00",
      "title": "Skyline Sofa",
      "category": "Sofas",
      "atp": 3,
      "backordered": 4,
      "inTransit": 0,
      "nextAvailable": null,
      "unitsPerMonth": 6.5,
      "runwayWeeks": 2.0,
      "leadTimeDays": 90,
      "orderBy": "2026-07-16",
      "daysUntilOrderBy": -90,
      "status": "past",                // past | due | ok
      "suggestedQty": 24
    }
  ]
}

404 not_tracked until your account has an inventory snapshot; 404 product_not_tracked when the ?sku= isn't in the planned set. Titles can repeat across SKUs, so show the SKU with the title.

GET/cx/v1/forecast/top/{range}

Products ranked by projected views in the window. ?top= 1–100, default 25.

{
  "range": "this_month",
  "count": 25,
  "products": [
    {
      "productId": "L-2750-52",
      "title": "Track-Arm Sofa",
      "imageLink": "https://…",
      "projectedViews": 4210,
      "projectedUniqueUsers": 3180,
      "contacts": 112,
      "locations": 3,
      "places": 14
    }
  ]
}

GET/cx/v1/products/{id}/forecast/{range}

One product's forecast: the prediction series plus projected units by store.

{
  "range": "this_quarter",
  "productId": "L-2750-52",
  "title": "Track-Arm Sofa",
  "series": [
    {
      "date": "2026-09-01",
      "grain": "day",
      "views": 140,
      "uniqueUsers": 104
    }
  ],
  "projectedSalesByStore": [
    {
      "storeId": "S01",
      "projectedUnits": 9
    }
  ]
}

GET/cx/v1/forecast/similarity

All similarity forecasts, newest first. Returns 404 similarity_forecast_not_available until the similarity engine has produced output for your account.

{
  "count": 4,
  "forecasts": [
    {
      "id": "…",
      "name": "Curved-back lounge concept",
      "category": "Chairs",
      "status": "complete",
      "imageLink": "https://…",
      "projectedViews": 1840,
      "projectedUniqueUsers": 1420,
      "contacts": 40,
      "locations": 2,
      "places": 8,
      "modified": "2026-08-14",
      "similarProducts": 6
    }
  ]
}

GET/cx/v1/forecast/similarity/{id}

One similarity forecast in full: the prediction series, the comparable products it was built from (with similarity scores), and projected units by store.

{
  "forecast": {
    "id": "…",
    "name": "…",
    "category": "…",
    "description": "…",
    "status": "complete",
    "imageLink": "…",
    "projectedViews": 1840
  },
  "series": [
    {
      "date": "2026-09-01",
      "grain": "day",
      "views": 61,
      "uniqueUsers": 48
    }
  ],
  "similarProducts": [
    {
      "productId": "…",
      "title": "…",
      "link": "…",
      "imageLink": "…",
      "similarityScore": 0.9142
    }
  ],
  "projectedSalesByStore": [
    {
      "storeId": "S01",
      "projectedUnits": 4
    }
  ]
}

POST/cx/v1/enrich/contact

Body: { "email": "…" } (required).

{
  "matched": true,
  "source": "cache",
  "contact": {
    "firstName": "…",
    "lastName": "…",
    "email": "…",
    "phone": "…",
    "address": "…",
    "address2": null,
    "city": "…",
    "region": "…",
    "postalCode": "…",
    "country": "US",
    "age": 44
  }
}

# No cached match:
{
  "matched": false,
  "email": "…",
  "source": "cache",
  "note": "…"
}

GET/cx/v1/comcol/requests

Newest first. ?status=, ?limit= (1–200, default 50), and ?cursor= from the previous page's nextCursor.

{
  "requests": [
    {
      "id": 1182,
      "frameSku": "5422-22LF",
      "quantity": 1,
      "tagFor": "…",
      "status": "submitted_for_review",
      "customer": { "name": "…", "email": "…", "phone": "…" },
      "renderUrl": "https://…",
      "poNumber": null,
      "submittedAt": "2026-10-13T15:02:11Z",
      "createdDate": "2026-10-13T14:51:40Z",
      "fabricCount": 2
    }
  ],
  "nextCursor": 1181
}

GET/cx/v1/comcol/requests/{id}

One request with each fabric line's spec.

{
  "request": { "id": 1182, "frameSku": "5422-22LF", "status": "submitted_for_review", … },
  "fabrics": [
    {
      "lineNo": 1,
      "supplier": "…",
      "pattern": "…",
      "color": "…",
      "widthIn": 54.0,
      "hRepeatIn": 13.5,
      "vRepeatIn": 13.5,
      "content": "100% linen",
      "silkPct": null,
      "backing": null,
      "cleaningCode": "S",
      "grade": null,
      "railroaded": false,
      "orientation": "up_the_roll",
      "sourceUrl": "https://…",
      "swatchUrl": "https://…"
    }
  ]
}