Skip to main content
POST
/
admin
/
reservations
JS SDK
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.create({
  inventory_item_id: "iitem_123",
  location_id: "sloc_123",
  quantity: 10,
})
.then(({ reservation }) => {
  console.log(reservation)
})
{
  "reservation": {
    "id": "<string>",
    "line_item_id": "<string>",
    "location_id": "<string>",
    "quantity": 123,
    "external_id": "<string>",
    "description": "<string>",
    "inventory_item_id": "<string>",
    "inventory_item": {
      "id": "<string>",
      "requires_shipping": true,
      "sku": "<string>",
      "origin_country": "<string>",
      "hs_code": "<string>",
      "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": {},
          "available_quantity": 123,
          "inventory_item": {}
        }
      ]
    },
    "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.

Body

application/json

The reservation's details.

​
location_id
string
required

The ID of the location the quantity is reserved from.

​
inventory_item_id
string
required

The ID of the inventory item associated with the line item's variant.

​
quantity
number
required

The reserved quantity.

​
line_item_id
string

The ID of the line item this reservation is created for.

​
description
string

The reservation's description.

​
metadata
object

The reservation's metadata, used to store custom key-value pairs.

Response

OK

The reservation's details.

​
reservation
object
required

The reservation's details.