AdminReservationsResource

admin/reservations.AdminReservationsResource

Methods

create

create(payload, customHeaders?): ResponsePromise<AdminReservationsRes>

create a reservation

Parameters

payloadAdminPostReservationsReqRequired

customHeadersRecord<string, unknown>Required

Default: `{}`

Returns

ResponsePromise<AdminReservationsRes>

ResponsePromiseResponsePromise<AdminReservationsRes>Required

the created reservation

Description

create a reservation This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

---

delete

delete(id, customHeaders?): ResponsePromise<DeleteResponse>

remove a reservation

Parameters

idstringRequired

customHeadersRecord<string, unknown>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

reservation removal confirmation

Description

remove a reservation This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

---

list

list(query?, customHeaders?): ResponsePromise<AdminReservationsListRes>

List reservations This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

queryAdminGetReservationsParams

customHeadersRecord<string, unknown>Required

Default: `{}`

Returns

ResponsePromise<AdminReservationsListRes>

ResponsePromiseResponsePromise<AdminReservationsListRes>Required

A list of reservations matching the provided query

Description

Lists reservations

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminReservationsRes>

Get a reservation This feature is under development and may change in the future. To use this feature please install @medusajs/inventory

Parameters

idstringRequired

customHeadersRecord<string, unknown>Required

Default: `{}`

Returns

ResponsePromise<AdminReservationsRes>

ResponsePromiseResponsePromise<AdminReservationsRes>Required

The reservation with the provided id

Description

gets a reservation

---

update

update(id, payload, customHeaders?): ResponsePromise<AdminReservationsRes>

update a reservation

Parameters

idstringRequired

payloadAdminPostReservationsReservationReqRequired

customHeadersRecord<string, unknown>Required

Default: `{}`

Returns

ResponsePromise<AdminReservationsRes>

ResponsePromiseResponsePromise<AdminReservationsRes>Required

The updated reservation

Description

update a reservation This feature is under development and may change in the future. To use this feature please install @medusajs/inventory