Tricycle Catalog API Help Page

Introduction

This API exposes various REST endpoints used in searching designs/colorways, retrieving design specific information, user account management/authorization, and sample ordering.

User Login

Login is achieved through the use of OAuth 2.0 bearer tokens. For more information, this implementation should adhere closely to RFC 6749 4.3.

To attempt a login, a POST request should be constructed that points to the endpoint below with content type "application/x-www-form-urlencoded; charset=utf-8":

{{API_BASE_URL}}/oauth/token

An example body of this POST looks like this:

grant_type=password&username=test-user%40organization.com&password=testing123

Note: JSON can be specified to be accepted as the response type.

A successful response (HTTP Status 200) looks like this:

{ "access_token":"{{REDACTED_TOKEN_STRING}}", "token_type":"bearer", "expires_in":1209599 }

A failure response (HTTP Status 400) looks like this:

{ "error":"invalid_grant", "error_description":"The email address or password is incorrect." }

Once a valid token is obtained for the user, it must be included as a custom HTTP header for requests that require authorization:

Authorization: Bearer {{REDACTED_TOKEN_STRING}}

OData Pagination

For HTTP GET requests that require pagination due to the potential for large result sets (i.e. searching), additional OData parameters must be appended to the query string.

Here is an example URL used to retrieve the first page of a search result set:

{{API_BASE_URL}}/search?$inlinecount=allpages&$orderby=DesignName,ColorName&$top=15&$skip=0&c=6004,6130&q=

Here are the OData components to this URL:

$inlinecount=allpages

This specifies that we want the total page count included inline in the response.

$orderby=DesignName,ColorName

This specifies that we want our result set ordered by the DesignName property then the ColorName property.

$top=15

This specifies how many items we want to consume per page.

$skip=0

This specifies how many items to skip and effectively indicates which page you are interested in retrieving via multiplying by the page size.

Shipping

Endpoints for retrieving shipping data.

API	Description
GET shipping/history	Retrieves the shipping history for a user. This requires an authorization token.
GET shipping/countries	Retrieves a list of countries. This does not requires an authorization token. This endpoint can also be used to populate country selection during account registration.

Search

Endpoints for searching designs and colorways.

API	Description
GET search?c={c}&i={i}&q={q}&r={r}	Used for standard search operations. This will return colorway level results if color categories are provided. This returns a paged result set and allows for custimization of page sizing.
GET search/colors?c={c}&i={i}&q={q}&r={r}	Forces a colorway search operation. This returns a paged result set and allows for custimization of page sizing.

API	Description
GET categories	Retrieves the categories available for filtering/searching products.

Account

Endpoints for retrieving account data and performing account related actions.

API	Description
GET account	Retrieves the account information for the authorized user. This requires an authorization token.
POST account/create	Validates and creates a new user account.
POST account/forgot	Validates and initiates the password reset process. This can fail if the hostname in the URL format is not recognized by the system.
POST account/reset	Validates and completes the password reset process.
POST account/update	Validates and updates an account's primary contact information. This requires an authorization token.

Endpoints for sharing designs.

API	Description
POST share/design	Initiates a request from an anonymous user to share a design via email.

TrykProducts

Endpoints for retrieving Tryk product data.

API	Description
GET tryk/products	Retrieves a list of all available Tryk products for each brand associated with the site.

Colorways

Endpoints for retrieving colorway data.

API	Description
GET designs/{designCode}/colorways	Retrieves a list of colorways associated with a design code.
GET designs/{designCode}/colorways/{colorCode}	Retrieves the requested colorway associated with a design code.
GET designs/{designCode}/colorways/custom?yarns={yarns}&refColor={refColor}	No documentation available.

TrykOrders

Endpoints for sample ordering.

API	Description
POST tryks/order	Used for posting a sample order request. This requires an authorization token.

Site

Endpoints for global/site level data retrieval.

API	Description
GET status	Retrieves basic status information for the API.

RoomScenes

Endpoints for retrieving room scene data.

API	Description
GET rooms	Retrieves a list of all available room scenes for each brand associated with the site.

Installs

Endpoints for retrieving installation data.

API	Description
GET designs/{designCode}/installs	Retrieves a list of installations associated with a design code.

YarnLibraries

API	Description
GET yarns/libraries	Retrieves the yarn libraries available for recoloring products.

Designs

Endpoints for retrieving design data.

API	Description
GET designs/{designCode}	Retrieves an overview of a design.