Files
medusa-store/www/utils/generated/oas-output/schemas/AdminInventoryLevel.ts
Shahed Nasser 5eafa5a184 oas: [5/n] improve oas schemas (#9066)
Improve oas schemas [5/n]
2024-09-10 12:03:18 +00:00

73 lines
2.2 KiB
TypeScript

/**
* @schema AdminInventoryLevel
* type: object
* description: The inventory level's details.
* x-schemaName: AdminInventoryLevel
* required:
* - id
* - created_at
* - updated_at
* - deleted_at
* - inventory_item_id
* - location_id
* - stocked_quantity
* - raw_stocked_quantity
* - reserved_quantity
* - raw_reserved_quantity
* - incoming_quantity
* - raw_incoming_quantity
* - metadata
* - available_quantity
* properties:
* id:
* type: string
* title: id
* description: The inventory level's ID.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The ID of the inventory item this level belongs to.
* location_id:
* type: string
* title: location_id
* description: The ID of the stock location this level belongs to.
* stocked_quantity:
* type: number
* title: stocked_quantity
* description: The quantity of the associated inventory item stocked in the associated stock location.
* reserved_quantity:
* type: number
* title: reserved_quantity
* description: The reserved quantity of the associated inventory item stocked in the associated stock location.
* incoming_quantity:
* type: number
* title: incoming_quantity
* description: The incoming quantity of the associated inventory item stocked in the associated stock location.
* metadata:
* type: object
* description: The location level's metadata, can hold custom key-value pairs.
* inventory_item:
* $ref: "#/components/schemas/AdminInventoryItem"
* available_quantity:
* type: number
* title: available_quantity
* description: The quantity available for order of the associated inventory item in the associated stock location.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the inventory level was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the inventory level was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the inventory level was deleted.
*
*/