| Table of Contents |
|---|
Glossary
Here is the glossary of all terms that are used within this document.
Term | Abbreviation | Definition |
|---|---|---|
Slug | Slug | The unique identifying part of a web address, typically at the end of the URL. |
API Endpoints
getTypes
Description: Use this service call to get information about deal type supported by FMTC.
Example Request: https://services.fmtc.co/v2/getTypes?key=APIKEY
getTypes
Request Parameters
Name | Value(s) | Description | Required | Default |
|---|---|---|---|---|
key | APIKEY | API key for authentication, available on the API Keys & Calls page.(https://account.fmtc.co/cp/api_keys) | Yes | N/A, must always be provided |
format | String XML, JSON, CSV, TAB, or PIPE | Choose the feed format you would like returned. | No | |
v2 | Boolean | We recently consolidated our deal types. To receive a list of our active deal types include | No |
Implementation
Response Elements
Name | Description |
|---|---|
Slug | The unique slug assigned to the type. |
Name | The human readable name of the type. |
Example Response - JSON
Here is an example of a JSON Response from the getTypes endpoint.
| Code Block |
|---|
[
{
"cSlug": "apofreeshipping",
"cName": "APO Free Shipping"
},
{
"cSlug": "bogo",
"cName": "BOGO"
}
] |
Example Response - XML
Here is an example of an XML Response from the getTypes endpoint.
| Code Block |
|---|
<?xml version="1.0" encoding="iso-8859-1" ?>
<types>
<type>
<slug>apofreeshipping</slug>
<name>APO Free Shipping</name>
</type>
<type>
<slug>bogo</slug>
<name>BOGO</name>
</type>
</types> |
Example Response - CSV
Here is an example of a CSV Response from the getTypes endpoint.
| Code Block |
|---|
Slug,Name
apofreeshipping,"APO Free Shipping"
bogo,BOGO |
Example Response - TAB
Here is an example of a TAB Response from the getTypes endpoint.
| Code Block |
|---|
Slug,Name
apofreeshipping,"APO Free Shipping"
bogo,BOGO |
Example Response - PIPE
Here is an example of a PIPE Response from the getTypes endpoint.
| Code Block |
|---|
Slug|Name
apofreeshipping|"APO Free Shipping"
bogo|BOGO |