The Coupon Bureau® Manufacturers API Version 2.0
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 Connected Providers GET
- Assign Provider to Brand PUT
- Remove Provider from Brand DELETE
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
- Update Campaign Metadata POST
- My Master Offer Files GET
- Master Offer File Detail GET
- Get Connected Providers GET
- Assign / Unassign provider to master offer file POST
- Assign / Unassign retailer to master offer file (restricted redemption) POST
- Mandatory retailer selection during deposit PUT
- Assign Provider Custom Circulation POST
- Get Provider Custom Circulation GET
- Delete Provider Custom Circulation DELETE
- Get assigned providers of master offer file GET
- Get assigned retailers of master offer file (restricted redemption) GET
- Lock / Unlock master offer file PUT
- Delete master offer file DELETE
- Attach Lookup Code PUT
- Get Lookup Codes of MOF GET
- Get MOF from Lookup Code GET
- Skip Purchase Validation of Lookup Code PUT
- Delete Lookup Code DELETE
- MOF Redemption Errors GET
- MOF Redemption Error with Reason GET
- Update Redemption Days & Timewindow POST
- Delete Redemption Days & Timewindow DELETE
- Extend MOF POST
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
- Connected Authorized Partners GET
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
- All Funder IDs GET
- All Funder Details GET
- Funder Detail GET
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
- Last updated time of Master Offer File GET
- Master Offer File Distribution (with redemption) GET
- Master Offer Files Created Between GET
- Distribution & Redemption between days GET
- Offline Redemption Report GET
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
Save Access Token for API Playground
How to generate access token?
/access_token
Request Headers
| Content-Type(Optional) | application/json |
| x-api-key | ACCESS_KEY |
Request Body
{
"access_key": "ACCESS_KEY (Get it from enterprise setting page))",
"secret_key": "SECRET_KEY (Get it from enterprise setting page)"
}
Response
{
"status": "success"
"x-access-token": "YOUR ACCESS TOKEN (Valid for 24 hours)"
}
CURL Command
curl -X POST '{{API_SERVER}}/access_token' \
-H 'Content-Type: application/json' \
-H 'x-api-key: ACCESS_KEY' \
--data '{
"access_key": "ACCESS_KEY",
"secret_key": "SECRET_KEY"
}'
x-access-token will be valid for next 24 hours. You can use the same access token to access your API endpoints till it expires.
URL parameters
Request Header
Populate Request JSON Body
CURL Command
Request body JSON
{{ input_body_json_pretty }}
Response body JSON
HTTP Status Code: {{ http_status_code }}
{{ output_body_json_pretty }}
The Coupon Bureau® Authorized Partner API Version 2.0
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
- Update Campaign Metadata POST
- My Master Offer Files GET
- Master Offer File Detail GET
- Get Manufacturer Providers GET
- Assign / Unassign provider to master offer file POST
- Assign / Unassign retailer to master offer file (restricted redemption) POST
- Mandatory retailer selection during deposit PUT
- Assign Provider Custom Circulation POST
- Get Provider Custom Circulation GET
- Delete Provider Custom Circulation DELETE
- Get assigned providers of master offer file GET
- Get assigned retailers of master offer file (restricted redemption) GET
- Lock / Unlock master offer file PUT
- Delete master offer file DELETE
- Attach Lookup Code PUT
- Get Lookup Codes of MOF GET
- Get MOF from Lookup code GET
- Skip Purchase Validation of Lookup code PUT
- Delete Lookup Code DELETE
- MOF Redemption Errors GET
- MOF Redemption Error with Reason GET
- Update Redemption Days & Timewindow POST
- Delete Redemption Days & Timewindow POST
- Extend MOF POST
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
- Last updated time of Master Offer File GET
- Master Offer File Distribution (with redemption) GET
- Master Offer Files Created Between GET
- Distribution & Redemption between days GET
- Offline Redemption Report GET
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
- All Funder IDs GET
- All Funder Details GET
- Funder Detail GET
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
How to get Access Token
/access_token
Request Headers
| Content-Type(Optional) | application/json |
| x-api-key | ACCESS_KEY |
Request Body
{
"access_key": "ACCESS_KEY (Get it from enterprise setting page))",
"secret_key": "SECRET_KEY (Get it from enterprise setting page)"
}
Response
{
"status": "success"
"x-access-token": "YOUR ACCESS TOKEN (Valid for 24 hours)"
}
CURL Command
curl -X POST '{{API_SERVER}}/access_token' \
-H 'Content-Type: application/json' \
-H 'x-api-key: ACCESS_KEY' \
--data '{
"access_key": "ACCESS_KEY",
"secret_key": "SECRET_KEY"
}'
x-access-token will be valid for next 24 hours. You can use the same access token to access your API endpoints till it expires.
URL parameters
Request Header
Populate Request JSON Body
CURL Command
Request body JSON
{{ input_body_json_pretty }}
Response body JSON
HTTP Status Code: {{ http_status_code }}
{{ output_body_json_pretty }}
The Coupon Bureau® Provider API Version 2.0
Provider APIs allow a coupon provider to deposit (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
- Get Allowed Circulation GET
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
- Serialization Prefix GET
- Deposit Serialized GS1s POST
- Create time bound fetch code POST
- Get time bound fetch code GET
- Delete time bound fetch code DELETE
- Validate Serialized GS1s POST
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
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
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
- Deposited Serialized GS1s GET
/{{ api_endpoint_orig }}
{{ config[type].name }}
Request
Request Headers
| Name | Type | Description |
|---|---|---|
| Content-Type | string | Required. application/json |
| x-api-key | string | Required. See it in Enterprise Settings page |
| 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 }} |
Status codes
| Status Code | HTTP Status Code | Description |
|---|---|---|
| {{ bodyparam.key }} | {{ bodyparam.http_status_code }} | {{ 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. |
| 503 | Service Unavailable. Please refer to status page for more details. |
API Retry Policy: In case of 5XX error, please retry the API call after 10 seconds and again after 20 seconds.
execution_time_in_ms will return the time taken in TCB server to process your request. NOTE: this does not include network latency.
How to get Access Token
/access_token
Request Headers
| Content-Type(Optional) | application/json |
| x-api-key | ACCESS_KEY |
Request Body
{
"access_key": "ACCESS_KEY (Get it from enterprise setting page))",
"secret_key": "SECRET_KEY (Get it from enterprise setting page)"
}
Response
{
"status": "success"
"x-access-token": "YOUR ACCESS TOKEN (Valid for 24 hours)"
}
CURL Command
curl -X POST '{{API_SERVER}}/access_token' \
-H 'Content-Type: application/json' \
-H 'x-api-key: ACCESS_KEY' \
--data '{
"access_key": "ACCESS_KEY",
"secret_key": "SECRET_KEY"
}'
x-access-token will be valid for next 24 hours. You can use the same access token to access your API endpoints till it expires.
URL parameters
Request Header
Populate Request JSON Body
CURL Command
Request body JSON
{{ input_body_json_pretty }}
Response body JSON
HTTP Status Code: {{ http_status_code }}
{{ output_body_json_pretty }}