Hi ! h_title
Support
Home
Developers
REST API
REST API

The Tweakwise front-end REST API lets you link to your website for merchandising and facet filtering of all your lister pages. To fill your lister pages, use the navigation endpoint. The response consists of a few parts:

  • A list of facets
    These facets aim to let the end-user have the option to filter on, for example, category, brand, or color. There are 5 different types, each of which needs a different front-end implementation: Tree (for category filters), link, slider, checkbox, and color.
  • A list of products
    The result contains a list of products. These products correspond to the current filters. These products are sorted based on the Merchandising module in the Tweakwise App.
  • An object with properties of the request
    This object contains information such as the number of pages, the number of products and the options that can be used for sorting.

Check the API documentation for a complete overview of the parameters and the options in the response: https://developers.tweakwise.com/api/#/Navigation

Testing

To start testing the front-end API, you need a domain and an instance key.

Credentials:
Instance key: 
ca555417

Domain: https://gateway.tweakwisenavigator.com 

Available categories:

Name

ID

Parent-ID

Root

1000

 

Clothing

1001

1000

Sweaters & Hoodies

1004

1001

Shirts

1005

1001

Accessories

1002

1000

Office Supplies

1003

1000

See our demo shop for more information.

Example requests

https://gateway.tweakwisenavigator.com/navigation/ca555417/?tn_cid=1000-1001&tn_fk_color=Black&tn_fk_ae-price=14.95-18.95

https://gateway.tweakwisenavigator.com/navigation/ca555417/?tn_cid=1000-1001-1005&tn_fk_color=Green&tn_fk_onderstecategorie=Polo

Hosts

The endpoint for the frontend API is available in two different domains. For the use of these domains, see: https://support.tweakwise.com/en/cat/rest-api/1284/


Has reading the relevant articles not helped you?

Share article

Link copied to clipboard

Cookies

We are using cookies.

Want to know more? Take a look at our cookie statement.

The Livechat uses trackingcookies, do you accept these cookies?

Accept