How do I browse the REST API using Swagger?

Overview

metasfresh uses Swagger to expose REST API functions and endpoints.

Via Swagger you can browse through and use all available endpoints.
For more information about using the REST API, please refer to our general guide on the metasfresh web service.

Depending on your metasfresh build version, you can reach the REST API by appending the following path to your personal instance/server URL, which usually begins with https://<yourserver:port>:

Builds up to version 5.175

• metasfresh webui (webapi) REST API
  • /swagger-ui/index.html

    Note: Useful endpoint for enabling migration scripts.

• metasfresh application server REST API
  • /app/swagger-ui/index.html

Builds as of version 5.176 (Java 17)

The instance/server URL of these build versions is always composed in the same way: https://<yourserver:port>/swagger-ui/index.html.
For browsing, the Swagger web pages include an “Explore” search box at the top where you can enter the URL path in order to open the desired REST API endpoint.

• metasfresh webui (webapi) REST API
  • /v3/api-docs
    
• metasfresh application server REST API
  • /app/v3/api-docs
    

Next Steps (optional)

• Change the user session language via Swagger.
• Enable the Developer View using Swagger.