Skip to content

Create an asset lot

Assets module

POST/asset-lotsassetLots.create

A quantity of an asset class at a place (lot grain). Creates an asset lot. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability assets.asset.write.
  • OAuth scopes: assets.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: AssetLotCreate

assetLots.create: AssetLotCreate
FieldTypeRequiredDescription
asset_class_idstring (uuid)YesIdentifier of the asset class.
venue_idstring (uuid)YesIdentifier of the venue the lot sits at.
quantitynumberYesQuantity on hand.
{
  "asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity": 36
}

Response 201: AssetLot

assetLots.create: AssetLot
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset lot.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
asset_class_idstring (uuid)YesIdentifier of the asset class.
venue_idstring (uuid)YesIdentifier of the venue the lot sits at.
quantitynumberYesQuantity on hand.
on_handnumberYesQuantity on hand: the opening count plus the lot ledger.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity": 36,
  "on_hand": 34
}

Code samples

curl -X POST "$XOS_BASE_URL/asset-lots" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"asset_class_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","quantity":36}'
const { data } = await xos.assetLots.create({
    "asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "quantity": 36
  });
response = xos.asset_lots.create({"asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "quantity": 36})
xos asset-lots create --data '{"asset_class_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","quantity":36}'