Clickwise Product Catalog & Affiliate Links

Search fresh GTIN products in the catalog your affiliate can deliver (freshness, permissions and delivery caps apply). Requires your affiliate API key in X-API-Key or Bearer authorization. Returns Clickwise /dl/ tracked links only, created for your affiliate the first time a product is returned. country is required unless gtin is given (then every market carrying that GTIN is searched); offset paginates the currently deliverable subset.

{
  "type": "object",
  "properties": {
    "gtin": {
      "type": "string",
      "maxLength": 14
    },
    "text": {
      "type": "string",
      "maxLength": 200
    },
    "brand": {
      "type": "string",
      "maxLength": 200
    },
    "country": {
      "type": "string",
      "pattern": "^[A-Za-z]{2}$"
    },
    "category": {
      "type": "string",
      "maxLength": 200
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 20
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 50000,
      "default": 0
    }
  },
  "additionalProperties": false
}

Create or refresh a GTIN product feed for your authenticated affiliate and one country, and return its signed URL (json, csv, tsv or xml) with Clickwise /dl/ tracked product links. The same request returns the same URL. Requires your affiliate API key. Current freshness, permissions, assignments and delivery caps apply.

{
  "type": "object",
  "properties": {
    "country": {
      "type": "string",
      "pattern": "^[A-Za-z]{2}$"
    },
    "category": {
      "type": "string",
      "maxLength": 200
    },
    "format": {
      "type": "string",
      "enum": [
        "json",
        "csv",
        "tsv",
        "xml"
      ],
      "default": "json"
    }
  },
  "required": [
    "country"
  ],
  "additionalProperties": false
}

Public GTIN catalog counts as of generated_at, using the same stored snapshot as /api/v1/public/catalog-stats/. Fixed one-hour validity; snapshot_stale marks older counts served for less than six hours. No affiliate data or amounts.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

List active Clickwise deals and offers, optionally filtered by language, category, country or merchant.

{
  "type": "object",
  "properties": {
    "lang": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "pt",
        "fr",
        "de",
        "it"
      ],
      "default": "en"
    },
    "category": {
      "type": "string",
      "description": "e.g. fashion, travel, electronics, health"
    },
    "country": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 (US, ES, BR, ...)"
    },
    "merchant": {
      "type": "string",
      "description": "Merchant name or domain"
    },
    "network": {
      "type": "string",
      "description": "Optional source network slug; applies only to signed-in affiliates."
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "minimum": 1,
      "maximum": 100
    }
  }
}

Fetch the full record for a single deal by its slug. Returns title, description, code, discount, target_url, etc., in the requested language.

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string"
    },
    "lang": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "pt",
        "fr",
        "de",
        "it"
      ],
      "default": "en"
    }
  },
  "required": [
    "slug"
  ]
}

List Clickwise news announcements about affiliate programs (policy changes, launches, shutdowns, commission updates).

{
  "type": "object",
  "properties": {
    "lang": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "pt",
        "fr",
        "de",
        "it"
      ],
      "default": "en"
    },
    "severity": {
      "type": "string",
      "enum": [
        "info",
        "warn",
        "critical"
      ]
    },
    "network": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "minimum": 1,
      "maximum": 100
    }
  }
}

Fetch the full record for a single news article by its slug.

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string"
    },
    "lang": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "pt",
        "fr",
        "de",
        "it"
      ],
      "default": "en"
    }
  },
  "required": [
    "slug"
  ]
}

Find live Clickwise merchant programs that fit a publisher's site, app, newsletter or social channel, ranked by fit. Does not require signup.

{
  "type": "object",
  "properties": {
    "publisher_url": {
      "type": "string",
      "description": "Where the affiliate will publish: URL, app URL, social profile, newsletter page, etc."
    },
    "topic": {
      "type": "string",
      "description": "Audience or content topic, e.g. travel deals, AI shopping assistant, sneakers."
    },
    "category": {
      "type": "string",
      "description": "Preferred vertical/category."
    },
    "country": {
      "type": "string",
      "description": "Main audience country, ISO 3166-1 alpha-2 if known."
    },
    "channel": {
      "type": "string",
      "description": "Publishing channel: site, app, newsletter, Instagram, TikTok, coupon, cashback, etc."
    },
    "merchant": {
      "type": "string",
      "description": "Optional merchant name/domain filter."
    },
    "network": {
      "type": "string",
      "description": "Optional source network slug; applies only to signed-in affiliates."
    },
    "traffic_monthly": {
      "type": "integer",
      "description": "Estimated monthly visits/reach."
    },
    "traffic_daily": {
      "type": "integer",
      "description": "Estimated daily visits/reach."
    },
    "include_unready": {
      "type": "boolean",
      "default": false,
      "description": "Also return published matched programs whose links are not available yet; can_issue_link_now indicates availability."
    },
    "limit": {
      "type": "integer",
      "default": 8,
      "minimum": 1,
      "maximum": 20
    }
  }
}

Create a provisional Clickwise affiliate and return tracked links for the programs that can issue one now. Email is optional; the account is claimed and payout details are added later (update_profile).

{
  "type": "object",
  "properties": {
    "program_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Program IDs returned by find_affiliate_programs. If omitted, Clickwise picks fitting programs."
    },
    "publisher_url": {
      "type": "string",
      "description": "Where the affiliate will publish. URL/profile/app is strongly recommended."
    },
    "placement_description": {
      "type": "string",
      "description": "Short description of how/where links will be used."
    },
    "topic": {
      "type": "string"
    },
    "category": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "channel": {
      "type": "string"
    },
    "traffic_monthly": {
      "type": "integer"
    },
    "traffic_daily": {
      "type": "integer"
    },
    "sub_id": {
      "type": "string",
      "description": "Optional placement/sub ID for attribution."
    },
    "claim_email": {
      "type": "string",
      "description": "Optional email to claim the account later; not required to get links."
    },
    "limit": {
      "type": "integer",
      "default": 5,
      "minimum": 1,
      "maximum": 10
    }
  }
}

Create a provisional Clickwise affiliate and tracked links, as request_tracked_links does, and return them as renderable cards, an HTML embed snippet and a JSON feed for a publisher's site or app. Email is optional; the account is claimed later for payout.

{
  "type": "object",
  "properties": {
    "publisher_url": {
      "type": "string",
      "description": "The app/site/profile where the feed will be embedded."
    },
    "topic": {
      "type": "string",
      "description": "Audience/content topic, e.g. travel deals, AI shopping assistant, sneakers."
    },
    "category": {
      "type": "string",
      "description": "Preferred vertical/category."
    },
    "country": {
      "type": "string",
      "description": "Main audience country, ISO 3166-1 alpha-2."
    },
    "program_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Optional specific program IDs; omit to let Clickwise pick fitting merchants."
    },
    "sub_id": {
      "type": "string",
      "description": "Optional placement/sub ID for attribution."
    },
    "claim_email": {
      "type": "string",
      "description": "Optional email to claim the account (and payout) later."
    },
    "limit": {
      "type": "integer",
      "default": 5,
      "minimum": 1,
      "maximum": 10,
      "description": "How many cards to return."
    }
  }
}

Fetch an instant-link request, affiliate RefId, review status, and issued links using its access secret.

{
  "type": "object",
  "properties": {
    "application_id": {
      "type": "integer"
    },
    "access_secret": {
      "type": "string"
    }
  },
  "required": [
    "application_id",
    "access_secret"
  ]
}

Start a Clickwise merchant (advertiser) onboarding application. Describe the store; an automated evaluator replies with a follow-up question, an approval or a decline. Returns the status and an access secret to continue.

{
  "type": "object",
  "properties": {
    "company_name": {
      "type": "string"
    },
    "website": {
      "type": "string"
    },
    "message": {
      "type": "string",
      "description": "Free-text about the store / what they sell — the AI can drive the whole interview from this."
    },
    "contact_email": {
      "type": "string",
      "description": "Optional; lets the merchant claim/continue later."
    },
    "country": {
      "type": "string"
    },
    "vertical": {
      "type": "string"
    },
    "networks_used": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Affiliate networks the merchant already works with, if any."
    }
  }
}

Browse and paginate live Clickwise programs, filtered by merchant, category or country. Use it to go beyond find_affiliate_programs' top matches.

{
  "type": "object",
  "properties": {
    "merchant": {
      "type": "string",
      "description": "Merchant name or domain"
    },
    "category": {
      "type": "string"
    },
    "country": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2"
    },
    "network": {
      "type": "string",
      "description": "Optional source network slug; applies only to signed-in affiliates."
    },
    "ready_only": {
      "type": "boolean",
      "default": true,
      "description": "Only programs that can issue a tracked link right now."
    },
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1
    },
    "page_size": {
      "type": "integer",
      "default": 24,
      "minimum": 1,
      "maximum": 60
    }
  }
}

Update a creator's instant-monetization profile (claim email, display name, website, country, payment method) using the application_id + access_secret returned by request_tracked_links. Overwrites the fields provided. Lets a creator's assistant complete claim/payout details without leaving chat.

{
  "type": "object",
  "properties": {
    "application_id": {
      "type": "integer"
    },
    "access_secret": {
      "type": "string"
    },
    "claim_email": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "website_url": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "payment_method": {
      "type": "object",
      "description": "e.g. {\"Type\": \"Paypal\", \"Paypal_ID\": \"[email protected]\", \"Paypal_Name\": \"Your Name\"}"
    }
  },
  "required": [
    "application_id",
    "access_secret"
  ]
}