Skip to content

Resolve a funnel

GET /funnel

Validate candidate funnel IDs against the connected store and return the first valid match. Use this when a product has more than one Antla Funnel tag.

Authentication: X-Antla-SDK-Key: YOUR_ANTLA_SDK_KEY.

Uses the shared IP rate limit. See Errors and rate limits.

Query parameterTypeRequiredDescription
funnelIdsstringYesComma-separated positive integer funnel IDs from product tags, in preferred order.
Terminal window
curl --fail-with-body \
"https://app-antla.com/api/headless/funnel?funnelIds=123,456" \
-H "X-Antla-SDK-Key: YOUR_ANTLA_SDK_KEY"

HTTP 200, JSON envelope:

{
"data": {
"id": 123,
"funnelType": "upper_body",
"generationModel": "ANTLA_PRO"
}
}

funnelType is upper_body, lower_body, dress, accessory, or custom.

generationModel is ANTLA_PRO, ANTLA_FAST, or ANTLA_LIGHT.

The first ID is the one you prefer. Later IDs are fallbacks. Duplicate IDs are ignored. A non-integer or non-positive item makes the whole query invalid.

This endpoint checks store ownership and existence of the funnel. It does not receive a product ID and cannot validate that a particular product belongs to that funnel. Generation performs the product-tag check.

400 funnelIds are invalid. 404 Funnel not found when none of the IDs belong to this store. See Errors and rate limits.