Skip to main content
Skip table of contents

Forbidden Codes - Workflow

Explore the API Documentation for the endpoints available from FMTC. Please refer any general questions regarding the API Endpoints and/or this documentation to your Account Manager or support@fmtc.co.

Introduction

This document provides a technical walkthrough for using the Forbidden Codes endpoint alongside the Merchants and Deals endpoints. The primary goal is to help our subscribers prevent the use of coupon codes that have been flagged as forbidden and are not to be used by the public.

By incorporating this workflow into your system, you can ensure deals containing forbidden codes are not promoted to the public. This places the responsibility of maintaining code compliance on subscribers who consume our API.

Free Affiliate Account

Prerequisites

Before proceeding, ensure you meet the following requirements:

  • API Token: You will need a valid API token to authenticate requests. Contact your account manager if you do not have one.

  • Endpoint Access: Confirm that you have access to the forbidden-codes endpoint. Contact your account manager if you do not have access to this endpoint.

Once you have completed these prerequisites, you can proceed with the following steps to effectively filter and block forbidden coupon codes using our API.

Overview of Relevant Endpoints

Forbidden Codes Endpoint

  • Purpose: Retrieve a list of forbidden coupon codes flagged by program managers.

  • Key Response Values: code, program_platform_name, program_id.

  • Use Case: Cross-check information within the Program Platform to ensure no forbidden codes are used.

  • Optional Parameter: You can pass a comma-separated list of merchant_ids to filter forbidden codes for specific merchants.

  • Example Response:

    CODE 
    {
  "data": [
    {
      "merchant_id": 13,
      "merchant_name": "AreYouGame.com",
      "program_platform_id": 3,
      "program_platform_name": "CJ Affiliate",
      "program_id": 247913,
      "code": "SAVE20",
      "created_at": "2025-03-18T13:23:14.000000Z",
      "updated_at": "2025-03-18T13:23:14.000000Z"
    }
  ],
  "links": {
    "first": URL + "&page=1",
    "last": URL + "&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "to": 1,
    "last_page": 1,
    "path": "https://s3.fmtc.co/api/1.0.0/forbidden-codes",
    "per_page": 5,
    "total": 1,
    "version": "1.0.0"
  }
}

Note: Line 7 contains the key response value program_platform_name Line 8 contains the key response value program_id and line 9 contains the key response value code.

This endpoint along with information from the specific Program Platform will allow you to maintain code compliance within your system by identifying and filtering out forbidden codes before presenting deals for consumption.

Sample Workflow: Forbidden Codes and the Program Platform

Step 1: Retrieve Forbidden Codes

Now, call the forbidden-codes endpoint. You can either fetch all forbidden codes or filter by specific merchant IDs using the merchant_ids parameter.

Example Request:

CODE 
https://s3.fmtc.co/api/{api_version}/forbidden-codes?api_token=API_KEY

Example Response:

CODE 
{
  "data": [
    {
      "merchant_id": 13,
      "merchant_name": "AreYouGame.com",
      "program_platform_id": 3,
      "program_platform_name": "CJ Affiliate",
      "program_id": 247913,
      "code": "SAVE20",
      "created_at": "2025-03-18T13:23:14.000000Z",
      "updated_at": "2025-03-18T13:23:14.000000Z"
    }
  ]
}

Step 2: Utilizing the Program Platform

With the provided program_id, program_platform_name and code you will be able to search for and filter specific merchant deals within the Program Platform.

By following this workflow, you ensure that no forbidden codes are presented to your users, maintaining compliance with program manager restrictions.

Paid Affiliate Subscriber

Prerequisites

Before proceeding, ensure you meet the following requirements:

  • API Token: You will need a valid API token to authenticate requests. Contact your account manager if you do not have one.

  • Endpoint Access: Confirm that you have access to the deals-merchants, deals, and forbidden-codes endpoints.

  • Merchant and Deal Integration: Ensure your system is integrated with our merchant and deal data using our API endpoints.

Once you have completed these prerequisites, you can proceed with the following steps to effectively filter and block forbidden coupon codes using our API.

Overview of Relevant Endpoints

Merchants Endpoint

  • Purpose: Retrieve a list of merchants from our database.

  • Key Response Value: id.

  • Use Case: Identify merchants for which you may want to fetch deals and forbidden codes.

  • Example Response:

    CODE 
    {
    "data": [
        {
            "id": 13,
            "master_merchant_id": 13,
            "name": "AreYouGame.com",
            "homepage": "https://www.areyougame.com/",
            "premium": 0,
            "network_id": 3,
            "program_id": "247913",
            "dual_merchants": [],
            "status": "active",
            "created": "2007-01-01T08:00:00.000000Z",
            "last_updated": "2022-05-01T13:07:59.000000Z",
            "selected_status": 1,
            "relationship_status": 1,
            "affiliate_url": "https://www.dpbolvw.net/click-TestCJP-55431",
            "skimlinks_url": "https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F",
            "freshreach_url": "https://freshreach.co/click.php?m=13&cid=FMTC&uid=9107&sid=4mtc",
            "fmtc_url": "https://fmtc.co/m/13/",
            "primary_country": "US",
            "shiptocountries": [
                "US",
                "CA",
                "UK",
                "AU"
            ],
            "categories": [
                "toys-games"
            ],
            "skimlinks_id": 645,
            "network_notes": "",
            "rep_name": "Heather Mannion",
            "rep_email": "affiliates@areyougame.com ",
            "rep_phone": "",
            "apo_fpo_shipping": 0,
            "curbside_pickup": 0,
            "mobile_certified": 0,
            "logos": [
                {
                    "size": "88x31",
                    "image_name": "MerchantID_88x31.jpg",
                    "last_updated": "2021-05-06T10:45:12.000000Z",
                    "image_url": url
                },
                {
                    "size": "120x60",
                    "image_name": "MerchantID_120x60.jpg",
                    "last_updated": "2021-05-06T10:45:12.000000Z",
                    "image_url": url
                },
                {
                    "size": "600x450",
                    "image_name": "MerchantID_600x450.png",
                    "last_updated": "2024-09-15T05:15:22.000000Z",
                    "image_url": url
                },
                {
                    "size": "280x210",
                    "image_name": "MerchantID_280x210.png",
                    "last_updated": "2024-09-15T05:15:22.000000Z",
                    "image_url": url
                }
            ]
        }
    ],
    "links": {
      "first": URL + "&page=1",
      "last": URL + "&page=16",
      "prev": null,
      "next": URL + "&page=2"
      },
      "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 16,
      "path": "http://s3.fmtc.co/api/v3/deals-merchants",
      "per_page": 100,
      "to": 100,
      "total": 1518
    },
}

Note: Line 4 contains the key response value id.

Deals Endpoint

  • Purpose: Retrieve active deals and coupons associated with merchants.

  • Key Response Values: merchant_id, code.

  • Use Case: Obtain deal data to display or analyze within your platform.

  • Optional Parameter: You can pass the parameter codesonly with value of 1 in order to limit the response to only deals with coupon codes.

  • Example Response:

    CODE 
    {
    "data": [
        {
            "id": 92,
            "merchant_name": "AreYouGame.com",
            "merchant_id": 13,
            "master_merchant_id": 13,
            "network_id": 3,
            "program_id": "247913",
            "status": "active",
            "label": "test",
            "image": null,
            "code": "SAVE20",
            "start_date": "2022-05-06T20:50:11.000000Z",
            "end_date": "2072-05-08T23:59:59.000000Z",
            "last_updated": "2022-05-06T20:50:11.000000Z",
            "created": "2022-05-06T20:50:11.000000Z",
            "affiliate_url": "test.com",
            "direct_link": null,
            "freshreach_url": "https://freshreach.co/click.php?c=92&m=13&cid=FMTC&uid=9107&sid=4mtc",
            "skimlinks_url": "https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F",
            "subaffiliate_url": "https://freshreach.co/click.php?c=92&m=13&cid=FMTC&uid=9107&sid=4mtc",
            "fmtc_url": "https://fmtc.co/92/",
            "cascading_full_url": "https://www.areyougame.com/",
            "link_verified_at": "2022-05-06T20:50:11.000000Z",
            "pixel_html": null,
            "types": [],
            "sale_price": "0.00",
            "was_price": "0.00",
            "discount": "0.00",
            "percent": 0,
            "threshold": null,
            "rating": null,
            "tiered_deal": null,
            "brands": null,
            "local": null,
            "restrictions": null,
            "categories": [],
            "link_id": "",
            "deal_types": {
                "shipping-type": [
                    3,
                    4
                ]
            },
            exclusive = 0,
        },
    ],
    "links": {
    "first": URL + "&page=1",
    "last": URL + "&page=16",
    "prev": null,
    "next": URL + "&page=2"
    },
    "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 16,
    "path": "https://s3.fmtc.co/api/v3/deals",
    "per_page": 100,
    "to": 100,
    "total": 1518
    },
}

Note: Line 6 contains the key response value merchant_id and line 13 contains the key response value code.

Forbidden Codes Endpoint

  • Purpose: Retrieve a list of forbidden coupon codes flagged by program managers.

  • Key Response Values: merchant_id, code.

  • Use Case: Cross-check deals to ensure no forbidden codes are used.

  • Optional Parameter: You can pass a comma-separated list of merchant_ids to filter forbidden codes for specific merchants.

  • Example Response:

    CODE 
    {
  "data": [
    {
      "merchant_id": 13,
      "code": "SAVE20",
      "created_at": "2025-03-18T13:23:14.000000Z",
      "updated_at": "2025-03-18T13:23:14.000000Z"
    }
  ],
  "links": {
    "first": URL + "&page=1",
    "last": URL + "&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "to": 1,
    "last_page": 1,
    "path": "https://s3.fmtc.co/api/1.0.0/forbidden-codes",
    "per_page": 5,
    "total": 1,
    "version": "1.0.0"
  }
}

Note: Line 4 contains the key response value merchant_id and line 6 contains the key response value code.

These endpoints are designed to work together, allowing you to maintain code compliance within your system by identifying and filtering out forbidden codes before presenting deals for consumption.

Sample Workflow: Removing Deals with Forbidden Codes

Follow these steps to identify and remove deals containing forbidden codes:

Step 1: Retrieve Merchants

Example Request:

CODE 
https://s3.fmtc.co/api/{api_version}/deals-merchants?api_token=API_KEY

Example Response:

JSON 
{
    "data": [
        {
            "id": 13,
            "master_merchant_id": 13,
            "name": "AreYouGame.com",
            "homepage": "https://www.areyougame.com/",
            "premium": 0,
            "network_id": 3,
            "program_id": "247913",
            "dual_merchants": [],
            "status": "active",
            "created": "2007-01-01T08:00:00.000000Z",
            "last_updated": "2022-05-01T13:07:59.000000Z",

The response value id is the FMTC assigned ID for the merchant, which correlates to the merchant_id for our deals and forbidden codes responses.

Step 2: Retrieve Deals

Next, fetch deals using the deals-merchants endpoint. This will provide you with available deals, including the merchant ID and coupon code.

Example Request:

CODE 
https://s3.fmtc.co/api/{api_version}/deals?api_token=API_KEY

Example Response:

CODE 
{
    "data": [
        {
            "id": 92,
            "merchant_name": "AreYouGame.com",
            "merchant_id": 13,
            "master_merchant_id": 13,
            "network_id": 3,
            "program_id": "247913",
            "status": "active",
            "label": "test",
            "image": null,
            "code": "SAVE20",
            "start_date": "2022-05-06T20:50:11.000000Z",
            "end_date": "2072-05-08T23:59:59.000000Z",
            "last_updated": "2022-05-06T20:50:11.000000Z",
            "created": "2022-05-06T20:50:11.000000Z",
            "affiliate_url": "test.com",
            "direct_link": null,

For each Deal you will find the merchant_id and the code. If the code is null, you can continue with the expected deals workflow.

Step 3: Retrieve Forbidden Codes

Now, call the forbidden-codes endpoint. You can either fetch all forbidden codes or filter by specific merchant IDs using the merchant_ids parameter.

Example Request:

CODE 
https://s3.fmtc.co/api/{api_version}/forbidden-codes?api_token=API_KEY

Example Response:

CODE 
{
  "data": [
    {
      "merchant_id": 13,
      "code": "SAVE20",
      "created_at": "2025-03-18T13:23:14.000000Z",
      "updated_at": "2025-03-18T13:23:14.000000Z"
    }
  ]
}

Step 4: Determine Deals with Forbidden Codes

Compare the coupon codes from the deals response with the forbidden codes. Remove any deals that have matching merchant_id and code values. The combination of merchant_id and code represents a unique record.

CODE 
for each deal in deals:
  for each forbidden_code in forbidden_codes:
    if (deal.merchant_id == forbidden_code.merchant_id) and (deal.code == forbidden_code.code):
      remove deal from results

By following this workflow, you ensure that no forbidden codes are presented to your users, maintaining compliance with program manager restrictions.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close