SNsnipeitapp

/hardware/:id/checkout

Changed on

Checkout an asset to a user, location or another asset

post/hardware/{id}/checkout

Request

  • Base URL
    https://develop.snipeitapp.com/api/v1
  • URL
    https://develop.snipeitapp.com/api/v1/hardware/{id}/checkout
  • Auth
    none required

Path parameters

idinteger required

The id (not the asset tag) of the asset you'd like to query

Request body

status_idinteger required

Valid status ID

checkout_to_type'asset' | 'location' | 'user' required

Type of entity the asset is being checked out to: user, asset, or location

assigned_userinteger

The ID of the user to check the asset out to. Required if checkout_to_type is set to user

assigned_assetinteger

The asset ID to associate the asset to. Required if checkout_to_type is set to asset

assigned_locationinteger

The location ID to check the asset out to. Required if checkout_to_type is set to location

expected_checkinstring date

Optional date the asset is expected to be checked in

checkout_atstring date

Optional date to override the checkout time of now

namestring

Optional new asset name. This is useful for changing the asset's name on new checkout, for example, an asset that was named "Anna's Macbook Pro" could be renamed on the fly when it's checked out to Elizabeth, to "Beth's Macbook Pro"

notestring

Optional note about the checkout

Response

200

statusstring
messagesstring

Example response

{
  "status": "error",
  "messages": "Asset does not exist."
}

Changes