Files
medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReq.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

2.0 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: AdminPostReservationsReq

internal.internal.AdminPostReservationsReq

Schema

AdminPostReservationsReq type: object required:

  • location_id
  • inventory_item_id
  • quantity properties: line_item_id: description: "The ID of the line item of the reservation." type: string location_id: description: "The ID of the location of the reservation." type: string inventory_item_id: description: "The ID of the inventory item the reservation is associated with." type: string quantity: description: "The quantity to reserve." type: number metadata: description: An optional set of key-value pairs with additional information. type: object externalDocs: description: "Learn about the metadata attribute, and how to delete and update it." url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute"

Properties

description

Optional description: string

Defined in

packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:100


inventory_item_id

inventory_item_id: string

Defined in

packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:98


line_item_id

Optional line_item_id: string

Defined in

packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:96


location_id

location_id: string

Defined in

packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:97


metadata

Optional metadata: Record<string, unknown>

Defined in

packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:101


quantity

quantity: number

Defined in

packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:99