Glossary

Here is the glossary of all terms that are used within this document.

Term	Abbreviation	Definition
Slug	Slug	A URL safe string used to identify an entity, usually generated by the name of the entity.

API Endpoints

deal-types
- Description: Use this service call to get information about deal type supported by FMTC.
- Example Request: https://s3.fmtc.co/v3/deal-types?key=APIKEY
- For a full list of deal types, see Deal Types List

deal-types

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

JSON

slug

String

Filter by deal type to only return the passed in deal type

No

N/A, by default will return all deal types

Implementation

Response Elements

Name	Description
slug	The unique slug assigned to the type.
name	The human readable name of the type.
id	The FMTC ID of the deal type to be used in other FMTC endpoints.

Example Response - JSON

Here is an example of a JSON Response from the deal-types endpoint.

{
  "id": 14,
  "name": "APO Free Shipping",
  "slug": "apofreeshipping"
}

Example Response - XML

Here is an example of an XML Response from the deal-types endpoint.

<?xml version="1.0" encoding="iso-8859-1" ?>
<dealType>
  <id>14</id>
  <name>APO Free Shipping</name>
  <slug>apofreeshipping</slug>
</dealType>

Example Response - CSV

Here is an example of a CSV Response from the deal-types endpoint.

id,name,slug
14,"APO Free Shipping",apofreeshipping

Example Response - TAB

Here is an example of a TAB Response from the deal-types endpoint.

id	name	slug
14	"APO Free Shipping"	apofreeshipping

Example Response - PIPE

Here is an example of a PIPE Response from the deal-types endpoint.

id|name|slug
14|"APO Free Shipping"|apofreeshipping

Types - v3