GET
/
admin
/
reservations
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.reservation.list()
.then(({ reservations, count, limit, offset }) => {
  console.log(reservations)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "reservations": [
    {
      "id": "<string>",
      "line_item_id": "<string>",
      "location_id": "<string>",
      "quantity": 123,
      "external_id": "<string>",
      "description": "<string>",
      "inventory_item_id": "<string>",
      "inventory_item": {
        "id": "<string>",
        "sku": "<string>",
        "origin_country": "<string>",
        "hs_code": "<string>",
        "requires_shipping": true,
        "mid_code": "<string>",
        "material": "<string>",
        "weight": 123,
        "length": 123,
        "height": 123,
        "width": 123,
        "title": "<string>",
        "description": "<string>",
        "thumbnail": "<string>",
        "metadata": {},
        "location_levels": [
          {
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "inventory_item_id": "<string>",
            "location_id": "<string>",
            "stocked_quantity": 123,
            "reserved_quantity": 123,
            "incoming_quantity": 123,
            "metadata": {},
            "inventory_item": {},
            "available_quantity": 123
          }
        ]
      },
      "metadata": {},
      "created_by": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
location_id

Filter by a location's ID to retrieve its associated reservations.

​
inventory_item_id

Filter by an inventory item's ID to retrieve its associated reservations.

​
line_item_id

Filter by a line item's ID to retrieve its associated reservations.

​
created_by

Filter by the ID of a user to retrieve the reservations they created.

​
description

Filter by a reservation's description. This filter applies a full-text match. To search by keywords, use the q query parameter instead.

​
created_at
object

Filter by a reservation's creation date.

​
updated_at
object

Filter by a reservation's update date.

​
deleted_at
object

Filter by a reservation's deletion date.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The paginated list of reservations.