Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Stock

Get a stock item

Retrieves a single stock item (required scope stock:read)

get/v1/stockItems/{stockItemId}

Path parameters

stockItemIdinteger required
Example:5514123

The unique identifier of the stock item

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the stock item

stockDetailsIdinteger

The unique identifier of the stock details associated with the stock item

quantitynumber double nullable

The quantity of the stock item

locationContactIdinteger nullable

The ID of the contact associated with the stock item, null if the stock item is not located at a contact

locationVehicleIdinteger nullable

The ID of the vehicle associated with the stock item, null if the stock item is not located on a vehicle

locationStockItemIdinteger nullable

The ID of the stock item this stock item is allocated to, null if the stock item is not allocated to an item

soldAtstring date-time nullable

The date when the stock item was sold

createdAtstring date-time

The UTC timestamp of when this stock item was created

notesstring nullable

Notes on the stock item

serialNumberstring nullable

The unique number or barcode assigned to each individual stock item for identification and tracking

altSerialNumberstring nullable

The alternative serial number of the stock item

supplierSerialNumberstring nullable

The unique number used by the supplier for the stock item

customerSerialNumberstring nullable

The number assigned by the customer for the stock item

isEquipmentboolean

Indicates whether the stock item is equipment or not

condition'new' | 'refurbished' | 'used'

Represents the condition of a stock item<p>Possible values:</p><ul><li><b>new</b>: New stock item</li><li><b>refurbished</b>: Refurbished stock item</li><li><b>used</b>: Used stock item</li></ul>

usagenumber double nullable

The usage of the stock item

Example response

{
  "id": 5514123,
  "stockDetailsId": 5514123,
  "quantity": 2.5,
  "locationContactId": 5514123,
  "locationVehicleId": 5514123,
  "locationStockItemId": 5514123,
  "soldAt": "2024-08-29T12:30:45.0000000+00:00",
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "notes": "Should be kept in warehouse",
  "serialNumber": "AT-25805",
  "altSerialNumber": "PA-09842",
  "supplierSerialNumber": "TW-015",
  "customerSerialNumber": "LM-214750",
  "isEquipment": true,
  "condition": "new",
  "usage": 10,
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "Purple",
      "definition": {
        "caption": "Favourite colour",
        "type": "boolean",
        "listOptions": [
          "Red",
          "Blue",
          "Green",
          "Purple"
        ],
        "isRequired": true,
        "isEditable": true,
        "default": "10"
      },
      "systemListValueMetadata": {
        "label": "John Doe",
        "entityType": "resource"
      }
    }
  ]
}