Brands - 1.0.0

API Endpoints

Brands
- Description: Get the brands available in our Product Feed.
- Example Request: https://s3.fmtc.co/api/3/brands?api_token=API_KEY

Glossary

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

Term	Abbreviation	Definition
Parent Brand	ParentBrand	A Brand that has multiple Brands underneath it in an organization. For example, Gap (ID 51) is a Parent Brand of Old Navy (ID 148).
Child Brand	ChildBrand	A Brand that is under a Brand in an organization. For example, AmazonBasics (ID 324) is a Child Brand of Amazon (ID 257).

Brands API

Using the Brands endpoint will result in the fields listed below. This endpoint is used to translate the Brand IDs you receive from the Product Feed.

Request Parameters

Name	Value(s)	Description	Required	Default
api_token	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
id	Number	The ID of the Brand from the Brands API. Returns only that Brand.	No	null
parent_id	Number	The ID of the Parent Brand from the Brands API. Returns all the Children Brands of the Parent Brand.	No	null

Implementation

Response Elements

Name	Description
id	Our proprietary brand ID
parent_id	The parent Brand ID. Can be considered a top level Brand or the owner of the Brand.
name	The normalized name of the Brand.
links - JSON and XML link - CSV, Tab, Pipe - will be located in the HTML link header.	All the different links that are for going through the pagination. first - The first page of the endpoint call. last - The last page of the endpoint call. prev - The previous page of the endpoint call. next - The next page of the endpoint call.
meta	The information about the current endpoint call

Error Responses

Parameter Key	Error String	Possible Solutions
format	The requested format is invalid or not supported.	The format you requested is not supported by our system or is not recognized as a valid format. Make sure you pass in one of our valid formats (json, xml, csv, pipe, tab)
id	The id field must be an integer.	The id passed passed in must be a numeric integer that consists only of numbers.
parent_id	The parent id field must be an integer.	The parent_id passed in must be a numeric integer that consists only of numbers.
page_size	The page size field must be an integer.	The page_size passed in must be a numeric integer that consists only of numbers.
page_size	The page size field must not be greater than 2000.	The page_size cannot be larger than 2,000 Brands per page.

Example Response - JSON

Here is an example of a JSON Response from the Brands endpoint.

CODE

{
  "data": [
    {
      "id": 872,
      "parent_id": 0,
      "name": "1.State"
    },
    {
      "id": 1149,
      "parent_id": 0,
      "name": "10 Crosby Derek Lam"
    },
    {
      "id": 1150,
      "parent_id": 0,
      "name": "1901"
    },
    {
      "id": 612,
      "parent_id": 0,
      "name": "251 First"
    },
    {
      "id": 1151,
      "parent_id": 0,
      "name": "3.1 Phillip Lim"
    },
    {
      "id": 1152,
      "parent_id": 0,
      "name": "360 Cashmere"
    },
    {
      "id": 1153,
      "parent_id": 0,
      "name": "3x1"
    },
    {
      "id": 262,
      "parent_id": 0,
      "name": "4moms"
    },
    {
      "id": 219,
      "parent_id": 0,
      "name": "5.11 Tactical"
    },
    {
      "id": 1154,
      "parent_id": 0,
      "name": "525 America"
    }
  ],
  "links": {
    "first":  URL + "&page=1",
    "last": URL + "&page=219",
    "prev": null,
    "next": URL + "&page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "to": 10,
    "last_page": 219,
    "path": "https://s3.fmtc.co/api/3/brands",
    "per_page": 10,
    "total": 2183,
    "version": "3.0.0"
  }
}

Here is an example of a JSON Error Response from the Brands endpoint.

CODE

{
  "errors": {
    "id": [
      "The id field must be an integer."
    ]
  }
}

Example Response - XML

Here is an example of an XML Response from the Brands endpoint.

CODE

<results>
  <data>
    <brand>
      <id>872</id>
      <parent_id/>
      <name>1.State</name>
    </brand>
    <brand>
      <id>1149</id>
      <parent_id/>
      <name>10 Crosby Derek Lam</name>
    </brand>
    <brand>
      <id>1150</id>
      <parent_id/>
      <name>1901</name>
    </brand>
    <brand>
      <id>612</id>
      <parent_id/>
      <name>251 First</name>
    </brand>
    <brand>
      <id>1151</id>
      <parent_id/>
      <name>3.1 Phillip Lim</name>
    </brand>
    <brand>
      <id>1152</id>
      <parent_id/>
      <name>360 Cashmere</name>
    </brand>
    <brand>
      <id>1153</id>
      <parent_id/>
      <name>3x1</name>
    </brand>
    <brand>
      <id>262</id>
      <parent_id/>
      <name>4moms</name>
    </brand>
    <brand>
      <id>219</id>
      <parent_id/>
      <name>5.11 Tactical</name>
    </brand>
    <brand>
      <id>1154</id>
      <parent_id/>
      <name>525 America</name>
    </brand>
  </data>
  <links>
    <first>URL + &page=1</first>
    <last>URL + &page=219</last>
    <prev/>
    <next>URL + &page=2</next>
  </links>
  <meta>
    <current_page>1</current_page>
    <from>1</from>
    <to>10</to>
    <last_page>219</last_page>
    <path>http://localhost/api/3/brands</path>
    <per_page>10</per_page>
    <total>2183</total>
    <version>3.0.0</version>
  </meta>
</results>

Here is an example of an XML Error Response from the Brands endpoint.

CODE

<response>
  <errors>
    <id>
      <id>The id field must be an integer.</id>
    </id>
  </errors>
</response>

Example Response - CSV

Here is an example of a CSV Response from the Brands endpoint.

CODE

id,parent_id,name
872,0,1.State
1149,0,"10 Crosby Derek Lam"
1150,0,1901
612,0,"251 First"
1151,0,"3.1 Phillip Lim"
1152,0,"360 Cashmere"
1153,0,3x1
262,0,4moms
219,0,"5.11 Tactical"
1154,0,"525 America"

If you have an error with your API request in CSV, you will receive a JSON Error Response.

Example Response - TAB

Here is an example of a TAB Response from the Brands endpoint.

CODE

id	parent_id	name
872	0	1.State
1149	0	"10 Crosby Derek Lam"
1150	0	1901
612	0	"251 First"
1151	0	"3.1 Phillip Lim"
1152	0	"360 Cashmere"
1153	0	3x1
262	0	4moms
219	0	"5.11 Tactical"
1154	0	"525 America"

If you have an error with your API request in TAB, you will receive a JSON Error Response.

Example Response - PIPE

Here is an example of a PIPE Response from the Brands endpoint.

CODE

id|parent_id|name
872|0|1.State
1149|0|"10 Crosby Derek Lam"
1150|0|1901
612|0|"251 First"
1151|0|"3.1 Phillip Lim"
1152|0|"360 Cashmere"
1153|0|3x1
262|0|4moms
219|0|"5.11 Tactical"
1154|0|"525 America"

If you have an error with your API request in PIPE, you will receive a JSON Error Response.