Login
      Contents x
      /CatalogItems
      • 18 Jan 2024
      • Print
      • PDF
      Contents

      /CatalogItems

      • Updated on 18 Jan 2024
      • Print
      • PDF
      Article summary

      Get
      /CatalogItems

      Retrieve a list of information related to catalog items.

      Security
      Http
      Type bearer
      Bearer Authorization Token
      Query parameters
      $select
      string
      $filter
      string
      $expand
      string
      $orderby
      string
      $skip
      string
      $top
      string
      $pageNumber
      string
      $limit
      string
      Responses
      200

      Success

      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Array of object
      object
      CatalogItemID
      integer (int32)
      CatalogItemCategoryID
      integer (int32)
      ItemType
      string
      Max length10
      Min length0
      ItemName
      string
      Max length200
      Min length0
      ItemAlternateName
      string
      Max length200
      Min length0
      ItemDescription
      string
      Max length2147483647
      Min length0
      ItemCode
      string
      Max length50
      Min length0
      ItemCost
      number (double)
      PurchaseUnitTypeID
      integer (int32)
      PurchaseUnitTypeName
      string
      Max length50
      Min length0
      AllocationUnitTypeID
      integer (int32)
      AllocationUnitTypeName
      string
      Max length50
      Min length0
      UnitTypeAllocationConversion
      number (double)
      EPANumber
      string
      Max length50
      Min length0
      EPAName
      string
      Max length250
      Min length0
      Inventory
      boolean
      AvailableToBid
      boolean
      Active
      boolean
      LastUpdatedDateTime
      string (date-time)
      LastUpdatedByUserID
      integer (int32)
      LastUpdatedByUserName
      string
      Max length101
      Min length0
      PurchaseUnitCost
      number (double)
      ForceUnitPricing
      boolean
      AllocateFromMobile
      boolean
      CatalogId
      integer (int32)
      CatalogName
      string
      Max length200
      Min length0
      TakeoffItemID
      integer (int32)
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout