REST API
Search…
Docu Guidelines

General overview

In this section you will learn how to properly read an endpoint on this documentation.
Each endpoint is displayed in the form of an accordion, so keep in mind that every time you see an arrow like the highlighted in red below, it means that there is further information available.
Closed endpoint accordion
References:
GET: the type of request of the endpoint. Options we use can be PUT, POST, DELETE and GET.
https://api.outshifter.com/catalog/users/:id/products: The endpoint itself, the address to send the required operation.
Multiple products by user id: The endpoint title

Parameters

Once you open the accordion to get further information, you will see the included endpoint parameters. It will include the field, the type of data and a description of what is required.
Opened endpoint accordion
References:
Path: It is a parameter that is included in the address of the endpoint. In the example, it is the user id.
Header: We use it primarily for the authentication. Each endpoint that requires it, should include it in the header.
Body: The payload. In the example, it is the possibility to apply filters, but it can also be an object with information required to create a new user.

Responses

When you open the "Responses" tab, you will get the type of response and if there is data expected, the content. In the below example we see that the response is an array with all the selected seller products.