TCB.Admin Home
  1. Home
  2. The Coupon Bureau API

The Coupon Bureau® Manufacturers API

Manufacturer APIs allow a manufacturer to deposit their own offers into TCB through their own internal systems. APIs are NOT required for a Manufacturer to connect to The Coupon Bureau, these APIs are designed specifically for partners who are looking to integrate these functions into your own system.

API functions include Master Offer File deposits, Authorized Partner authorization by account for Master Offer File management, and Provider authorization by Master Offer File for distribution.
  • Add Brand POST
  • Update Brand PUT
  • Get My Brands GET
  • Delete Brand DELETE
  • Get All Providers GET
  • Assign Provider to Brand PUT
  • Remove Provider from Brand DELETE

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Create / Edit Master Offer File POST
  • My Master Offer Files GET
  • Master Offer File Detail GET
  • All Providers GET
  • Assign / Unassign provider for master offer file POST
  • Get assigned providers of master offer file GET
  • Lock / Unlock master offer file PUT
  • Delete master offer file DELETE

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • All Authorized Partners GET
  • Toggle Authorized Partner PUT
  • Connected Authorized Partners GET
  • Assign / Unassign Brand to Authorized Partner PUT
  • Get Allowed Brands of a Authorized Partner GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Master Offer File Distribution / Redemption GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Missing 8110s GET
  • Reported By Retailers GET
  • Add to Positive Offer File POST
  • Add to Negative Offer File POST
  • Get My Positive / Negative Offer File GET
  • Get Full Positive / Negative Offer File GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

The Coupon Bureau® Authorized Partner API

Authorized Partner APIs allow the ability to connect to the TCB from your internal systems so that you can directly deposit and manage an 8112 offer into a manufacturer’s TCB account. APIs are NOT required for a Authorized Partner to reform your functions as they relate to The Coupon Bureau, these APIs are designed specifically for partners who are looking to integrate these functions into your own system.
  • Get Connected Manufacturers GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Get Manufacturer Brands GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Create / Edit Master Offer File POST
  • My Master Offer Files GET
  • Master Offer File Detail GET
  • All Providers GET
  • Assign / Unassign provider for master offer file POST
  • Get assigned providers of master offer file GET
  • Lock / Unlock master offer file PUT
  • Delete master offer file DELETE

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Master Offer File Distribution / Redemption GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Missing 8110s GET
  • Reported By Retailers GET
  • Add to Positive Offer File POST
  • Add to Negative Offer File POST
  • Get Manufacturer Positive / Negative Offer File GET
  • Get Full Positive / Negative Offer File GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

The Coupon Bureau® Provider API

Provider APIs allow a coupon provider to deposit/ delete a serialized GS1 (the GS1 distributed to a consumer) at the time of distribution into a manufacturer’s TCB account. These APIs are required for a provider to participate with TCB. Note: A provider will only be able to deposit serialized GS1s into Master Offer Files of those manufacturers who have authorized them.
  • Authorized Master Offer Files GET
  • Master Offer File Detail GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Deposit Serialised GS1s POST
  • Delete Serialised GS1s DELETE
  • Get Fetch Code GET
  • Bundle GS1s POST
  • Validate Serialised GS1s POST

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Deposited Serialised GS1s GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Get Positive / Negative Offer File GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

The Coupon Bureau® Retailer API

When an AI (8112) serialized data string is scanned at the POS, the POS makes an API request to POF with that serialized data string. The POF will then return the serialized data string with a status of “success” or “Failure” – if “success,” it will also send additional purchase requirement data. The POS then uses the additional purchase requirement data from the API response to validate offer against basket data and apply the discount or send a rollback response if the discount cannot be applied.
  • Add Store POST
  • My Stores GET
  • Delete Store DELETE

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Redeem Serialized GS1s POST
  • Rollback Serialised GS1 DELETE

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • All Accelerators GET
  • Authorized Accelerators GET
  • Authorize/Unauthorize Accelerators PUT

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • All Clearinghouses GET
  • Authorized Clearinghouses GET
  • Authorize/Unauthorize Clearinghouse PUT

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Redeemed Serialized GS1s GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Report Missing 8110 POST
  • Get Positive / Negative Offer File GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

The Coupon Bureau® Clearinghouse API

Retailer clearinghouse will be able to view the redemption report of authorized retailers. Retailers connected to The Coupon Bureau® will authorize a clearinghouse to do the final settlement with the manufacturer. Once the clearinghouse is authorized, they will be able to view the redemption data in realtime.
  • Authorized Retailers GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Retailer Redemption GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Validate Base GS1 GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Get Funder GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

The Coupon Bureau® Accelerator API

Accelerators will facilitate retailer connectivity to The Coupon Bureau Positive Offer File. The Coupon Bureau will authorize an Accelerator to execute coupon redemption/ rollback on behalf of multiple retailers. Retailers will use this accelerator connectivity as their connection to The Coupon Bureau Positive Offer File (POF).
  • Authorized Retailers GET
  • Add Retailer Store POST
  • Get Retailer Stores GET
  • Delete Retailer Store GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Redeem Serialized GS1s POST
  • Rollback Serialised GS1 DELETE

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Retailer Redemption GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

  • Report Missing 8110 POST
  • Get Positive / Negative Offer File GET

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

/{{ api_endpoint_orig }}   


{{ config[type].name }}

Request

{{ config[type].method }} {{API_SERVER}}/{{ api_endpoint_orig }}

Try in API explorer

Request Headers

Name Type Description
Content-Type string Required. application/json
x-access-key string Required. See it in Developer Access tab
x-access-token string Required. how to get access token

URL Parameters

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc }}

Request JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Request Body 

{{ config[type].sample_request }}

Response JSON Body Attributes

Name Type Description
{{ bodyparam.key }} {{ bodyparam.type }} {{ bodyparam.longDesc ? bodyparam.longDesc : bodyparam.desc }}

Sample Response Body 

{{ config[type].sample_response }}

HTTP Status Code

Code Description
200 Successfully executed. Response body will have status = success.
400 Request can not be fulfulled. Response body will have status = error along with a message describing the error.
401 Unauthorized. Either x-access-token is missing or expired.

We log each and every api calls in our backend. In case if you face any issue, please send us the execution_id which will be returned with every API call so that we can track it for you.

All update apis (POST, PUT, DELETE) will be exposed to you in TCB portal in Activities tab.

execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.

Developer Access Credentials

To Access The Coupon Bureau® API
Access Key

Secret Key



This will invalidate all sessions / api tokens associated with your account
Sorry! You do not have developer access.