INVENTORY

Gets inventory equipment based on search criteria.

GET/api/v2/inventory

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

PageInfo.PageNumberqueryinteger · int32

PageInfo.PageSizequeryinteger · int32

NewUsedquerystring

The inventory equipment type. Valid types are either New or Used

Statusesquerystring[]

The statuses of the inventory equipment.

Makesquerystring[]

Modelquerystring

InventoryTypequerystring

Machine, Attachment, or All

Branchesqueryinteger[]

SerialNoquerystring

StockNoquerystring

GroupCodesquerystring[]

Classesquerystring[]

Fleetsquerystring[]

FleetTypesquerystring[]

InOutquerystring[]

HourMinqueryinteger · int32

HourMaxqueryinteger · int32

YearMinqueryinteger · int32

YearMaxqueryinteger · int32

FilterYearsqueryboolean

FilterHoursqueryboolean

Responses

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

totalCountinteger · int32
pageCountinteger · int32
currentPageCountinteger · int32
nextPageNumberinteger · int32nullable
hasNextPageboolean

REQUEST EXAMPLE

curl --request GET \
  'https://apiv2.crmseries.com/api/v2/inventory' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "totalCount": 42,
    "data": {
      "equipmentId": 1024,
      "parentId": 1024,
      "parentType": "string",
      "machine": true,
      "make": "Caterpillar",
      "model": "320",
      "fullModel": "string",
      "stockNo": "STK-1001",
      "serialNo": "CAT0320XABC12345",
      "equipmentNo": "string",
      "baseNo": "string",
      "description": "string",
      "hours": 3250,
      "makeModelDescription": "string",
      "branch": "string",
      "equipYear": "string",
      "fleet": "string",
      "fleetType": "string",
      "fleetCombined": "string",
      "status": "string",
      "newUsed": "string",
      "acquisitionCost": 125000.5,
      "bookValue": 125000.5,
      "priceGuide": 125000.5,
      "configurationBookValue": 125000.5,
      "currentCost": 125000.5,
      "listPrice": 125000.5,
      "sellPrice": 125000.5,
      "acquisitionDate": "2026-01-15T14:30:00Z",
      "availableForQuote": true,
      "availableForAllocation": true,
      "stockNoLink": "https://example.com",
      "notes": "string",
      "inOut": "string",
      "hasImages": true,
      "headerImage": "string",
      "warnSellPrice": true,
      "openWorkOrders": true,
      "groupCode": "string",
      "class": "string",
      "onRentTo": "string",
      "options": [
        {
          "description": "string",
          "cost": 125000.5,
          "list": 1.5
        }
      ],
      "parentUnit": "string",
      "expectedReceiptDate": "2026-01-15T14:30:00Z",
      "actualReceiptDate": "2026-01-15T14:30:00Z",
      "rentalContractType": "string",
      "erpCompanyCode": "string",
      "erpCompanyDivision": "string",
      "attachments": [
        {
          "equipmentId": 1024,
          "parentId": 1024,
          "machine": true,
          "categoryId": 1024,
          "make": "Caterpillar",
          "model": "320",
          "description": "string",
          "serialNo": "CAT0320XABC12345",
          "stockNo": "STK-1001",
          "equipmentNo": "string",
          "equipYear": "string"
        }
      ]
    },
    "pageCount": 42,
    "currentPageCount": 42,
    "nextPageNumber": 1,
    "hasNextPage": true
  },
  "errors": []
}