VigLink (Sovrn Commerce) Product Coupons API

openapi: 3.0.0
info:
  title: Bid Check Account Product Coupons API
  version: 1.0.0
  description: 'Use Bid Check during the click redirect flow to request a real-time bid from Sovrn for a destination URL. When Sovrn can monetize the click, Bid Check returns a redirect URL that you can use to redirect the user.


    Partners typically use Bid Check when comparing offers from multiple affiliate networks in real time. After receiving Sovrn''s bid, you can decide whether to route the click through Sovrn or through another network.


    For CPC bids, the returned `eepc` is the rate you can earn by routing the click through Sovrn before the bid expires. Sovrn''s revenue share has already been deducted from this value. For CPA offers, `eepc` is the average amount Sovrn expects you to earn per click and is not guaranteed for an individual click.


    **Note on URL encoding:** query parameter values, especially `out`, `userAgent`, `referrerUrl`, `subId`, and tracking values that contain spaces or reserved characters, must be URL-encoded when constructing the request. The `example` values below show the raw decoded form; your HTTP client or the ReadMe "Try It" panel will encode them automatically.

    '
  x-source: https://developer.sovrn.com/llms.txt (per-endpoint OpenAPI definitions, harvested 2026-07-21)
servers:
- url: https://api.viglink.com
  description: Production
tags:
- name: Product Coupons
paths:
  /product:
    get:
      summary: Product coupons by URL
      description: 'Returns verified and unverified coupon codes for a specific product URL, along with merchant information and verification status.

        '
      tags:
      - Product Coupons
      security:
      - SecretKey: []
      parameters:
      - name: api_key
        in: query
        required: true
        description: 'Site API key for the site requesting coupons.

          '
        schema:
          type: string
        example: b5d593ce9de90b8a324ca24e5fcc32af
      - name: product_url
        in: query
        required: true
        description: 'Original retailer product page URL. Must not be an affiliate or redirect URL.

          '
        schema:
          type: string
          format: url
        example: https://www.kiehls.com/3605970407964.html
      - name: include_unverified
        in: query
        required: false
        description: 'Whether to include unverified coupon codes after verified results. Defaults to true.

          '
        schema:
          type: boolean
          default: true
        example: true
      - name: cuid
        in: query
        required: false
        description: 'Custom identifier used to associate the click with a user, page, campaign, or event.

          '
        schema:
          type: string
        example: cuid152
      - name: utm_source
        in: query
        required: false
        description: Identifies the source of the traffic (e.g., website, newsletter, twitter).
        schema:
          type: string
      - name: utm_medium
        in: query
        required: false
        description: Identifies the marketing medium (e.g., email, social, banner).
        schema:
          type: string
      - name: utm_campaign
        in: query
        required: false
        description: Identifies the campaign name, promotion, or initiative.
        schema:
          type: string
      - name: utm_term
        in: query
        required: false
        description: Identifies paid search keywords or targeting terms.
        schema:
          type: string
      - name: utm_content
        in: query
        required: false
        description: Differentiates similar links or placements on the same page.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved coupon code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductCouponsResponse'
              examples:
                unverifiedExample:
                  summary: Example response with unverified coupons
                  value:
                    merchant:
                      domain: kiehls.com
                      group_id: 2528
                      group_name: Kiehl's
                      logo_url: https://images.viglink.com/merchant/logo/official/240x120/kiehl-s/922daea08e0d6b4e23cf16843bf89e5b5d68d367.png?url=http%3A%2F%2Fwww.viglink.com%2Fmerchants%2F2528.gif&text=Kiehl%27s&logoId=1633
                    scan:
                      verification_active: false
                      when_to_check_back: 3600
                    coupons:
                    - id: 0d5c0846d5430357e07820f153040c36
                      code: WELCOME20
                      currency: USD
                      verified: true
                      affiliated_url: https://redirect.viglink.com/...
                      original_price: 52
                      price_with_code: 41.6
                      verified_at: '2026-02-06T15:18:11.746Z'
                      code_description: null
        '400':
          description: Invalid request parameters.
        '401':
          description: Unauthorized.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
components:
  schemas:
    Merchant:
      type: object
      required:
      - domain
      - group_id
      - group_name
      properties:
        domain:
          type: string
          example: kiehls.com
        group_id:
          type: integer
          format: int64
          example: 2528
        group_name:
          type: string
          example: Kiehl's
        logo_url:
          type: string
          format: url
          nullable: true
    ProductCouponsResponse:
      type: object
      required:
      - merchant
      - scan
      - coupons
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        scan:
          $ref: '#/components/schemas/Scan'
        coupons:
          type: array
          description: 'Ranked list of coupon codes. Verified coupons appear first, followed by unverified codes.

            '
          items:
            $ref: '#/components/schemas/Coupon'
    Coupon:
      type: object
      required:
      - id
      - code
      - affiliated_url
      - currency
      - verified
      properties:
        id:
          type: string
          description: Sovrn coupon identifier.
          example: f556475089750904030e28ad62c6727f
        code:
          type: string
          description: Promo code text.
          example: WELCOME20
        affiliated_url:
          type: string
          format: url
          description: 'Affiliate redirect URL with tracking parameters applied.

            '
        original_price:
          type: number
          format: double
          nullable: true
          description: Original product price.
          example: 52
        price_with_code:
          type: number
          format: double
          nullable: true
          description: 'Final price after applying the code. May be null while verification is in progress.

            '
          example: 41.6
        currency:
          type: string
          description: ISO 4217 currency code.
          example: USD
        verified:
          type: boolean
          description: Whether the code has been verified to work.
          example: true
        verified_at:
          type: string
          format: date-time
          nullable: true
          description: 'Timestamp when the code was last verified. May be null if not yet verified.

            '
          example: '2026-02-06T15:18:11.746Z'
        code_description:
          type: string
          nullable: true
          description: 'Best-effort description of the promotion. May be null or inaccurate.

            '
    Scan:
      type: object
      required:
      - verification_active
      - when_to_check_back
      properties:
        verification_active:
          type: boolean
          description: 'Indicates whether coupon verification is currently running.

            '
          example: false
        when_to_check_back:
          type: integer
          format: int32
          description: 'Recommended delay (in seconds) before polling again.

            '
          example: 3600