- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
4.2.2. API Route Parameters
In this chapter, you’ll learn about path, query, and request body parameters.
Path Parameters#
To create an API route that accepts a path parameter, create a directory within the route file's path whose name is of the format [param]
.
For example, to create an API Route at the path /hello-world/:id
, where :id
is a path parameter, create the file src/api/hello-world/[id]/route.ts
with the following content:
The MedusaRequest
object has a params
property. params
holds the path parameters in key-value pairs.
Multiple Path Parameters#
To create an API route that accepts multiple path parameters, create within the file's path multiple directories whose names are of the format [param]
.
For example, to create an API route at /hello-world/:id/name/:name
, create the file src/api/hello-world/[id]/name/[name]/route.ts
with the following content:
You access the id
and name
path parameters using the req.params
property.
Query Parameters#
You can access all query parameters in the query
property of the MedusaRequest
object. query
is an object of key-value pairs, where the key is a query parameter's name, and the value is its value.
For example:
The value of req.query.name
is the value passed in ?name=John
, for example.
Request Body Parameters#
The Medusa application parses the body of any request having its Content-Type
header set to application/json
. The request body parameters are set in the MedusaRequest
's body
property.
For example: