GET api/v1/products?pageNumber={pageNumber}&searchString={searchString}&rowLimit={rowLimit}

Get a list of products. Implements pagination.

Request Information

URI Parameters

Name	Description	Type	Additional information
pageNumber	Page of results to return.	integer	Required
searchString	String to search for. Optional.	string	Default value is
rowLimit	Number of rows to return. Default is 50. Max allowed limit is 500.	integer	Default value is 50

Body Parameters

None.

Response Information

Resource Description

ProductsWithPagingViewModel

Name	Type	Additional information
Products	Collection of ProductDto	None.
NextUrl	string	None.
PreviousUrl	string	None.

Response Formats

application/json, text/json

Sample:

{
  "products": [
    {
      "eanNumber": "sample string 1",
      "searchName": "sample string 2",
      "title": "sample string 3",
      "description": "sample string 4",
      "unitCode": "sample string 5",
      "supplierName": "sample string 6",
      "costPrice": 1.0,
      "salesPrice": 1.0,
      "productRegistrationInfos": [
        {
          "id": 1,
          "userId": 2,
          "caseId": 3,
          "productId": 4,
          "productName": "sample string 5",
          "timestamp": "2025-12-08T10:21:34.6838273+01:00",
          "quantity": 6.0,
          "isCreditRegistration": true,
          "productSalePrice": 1.0,
          "ean": "sample string 8"
        },
        {
          "id": 1,
          "userId": 2,
          "caseId": 3,
          "productId": 4,
          "productName": "sample string 5",
          "timestamp": "2025-12-08T10:21:34.6838273+01:00",
          "quantity": 6.0,
          "isCreditRegistration": true,
          "productSalePrice": 1.0,
          "ean": "sample string 8"
        }
      ],
      "id": 7,
      "inventory": 1.0
    },
    {
      "eanNumber": "sample string 1",
      "searchName": "sample string 2",
      "title": "sample string 3",
      "description": "sample string 4",
      "unitCode": "sample string 5",
      "supplierName": "sample string 6",
      "costPrice": 1.0,
      "salesPrice": 1.0,
      "productRegistrationInfos": [
        {
          "id": 1,
          "userId": 2,
          "caseId": 3,
          "productId": 4,
          "productName": "sample string 5",
          "timestamp": "2025-12-08T10:21:34.6838273+01:00",
          "quantity": 6.0,
          "isCreditRegistration": true,
          "productSalePrice": 1.0,
          "ean": "sample string 8"
        },
        {
          "id": 1,
          "userId": 2,
          "caseId": 3,
          "productId": 4,
          "productName": "sample string 5",
          "timestamp": "2025-12-08T10:21:34.6838273+01:00",
          "quantity": 6.0,
          "isCreditRegistration": true,
          "productSalePrice": 1.0,
          "ean": "sample string 8"
        }
      ],
      "id": 7,
      "inventory": 1.0
    }
  ],
  "nextUrl": "sample string 1",
  "previousUrl": "sample string 2"
}

application/xml, text/xml

Sample:

<ProductsWithPagingViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.ViewModels.ViewModels">
  <NextUrl>sample string 1</NextUrl>
  <PreviousUrl>sample string 2</PreviousUrl>
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.Models">
    <d2p1:ProductDto>
      <d2p1:Id>7</d2p1:Id>
      <d2p1:Inventory>1</d2p1:Inventory>
      <d2p1:CostPrice>1</d2p1:CostPrice>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:EanNumber>sample string 1</d2p1:EanNumber>
      <d2p1:ProductRegistrationInfos>
        <d2p1:ProductRegistrationDto>
          <d2p1:CaseId>3</d2p1:CaseId>
          <d2p1:Ean>sample string 8</d2p1:Ean>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsCreditRegistration>true</d2p1:IsCreditRegistration>
          <d2p1:ProductId>4</d2p1:ProductId>
          <d2p1:ProductName>sample string 5</d2p1:ProductName>
          <d2p1:ProductSalePrice>1</d2p1:ProductSalePrice>
          <d2p1:Quantity>6</d2p1:Quantity>
          <d2p1:Timestamp>2025-12-08T10:21:34.6838273+01:00</d2p1:Timestamp>
          <d2p1:UserId>2</d2p1:UserId>
        </d2p1:ProductRegistrationDto>
        <d2p1:ProductRegistrationDto>
          <d2p1:CaseId>3</d2p1:CaseId>
          <d2p1:Ean>sample string 8</d2p1:Ean>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsCreditRegistration>true</d2p1:IsCreditRegistration>
          <d2p1:ProductId>4</d2p1:ProductId>
          <d2p1:ProductName>sample string 5</d2p1:ProductName>
          <d2p1:ProductSalePrice>1</d2p1:ProductSalePrice>
          <d2p1:Quantity>6</d2p1:Quantity>
          <d2p1:Timestamp>2025-12-08T10:21:34.6838273+01:00</d2p1:Timestamp>
          <d2p1:UserId>2</d2p1:UserId>
        </d2p1:ProductRegistrationDto>
      </d2p1:ProductRegistrationInfos>
      <d2p1:SalesPrice>1</d2p1:SalesPrice>
      <d2p1:SearchName>sample string 2</d2p1:SearchName>
      <d2p1:SupplierName>sample string 6</d2p1:SupplierName>
      <d2p1:Title>sample string 3</d2p1:Title>
      <d2p1:UnitCode>sample string 5</d2p1:UnitCode>
    </d2p1:ProductDto>
    <d2p1:ProductDto>
      <d2p1:Id>7</d2p1:Id>
      <d2p1:Inventory>1</d2p1:Inventory>
      <d2p1:CostPrice>1</d2p1:CostPrice>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:EanNumber>sample string 1</d2p1:EanNumber>
      <d2p1:ProductRegistrationInfos>
        <d2p1:ProductRegistrationDto>
          <d2p1:CaseId>3</d2p1:CaseId>
          <d2p1:Ean>sample string 8</d2p1:Ean>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsCreditRegistration>true</d2p1:IsCreditRegistration>
          <d2p1:ProductId>4</d2p1:ProductId>
          <d2p1:ProductName>sample string 5</d2p1:ProductName>
          <d2p1:ProductSalePrice>1</d2p1:ProductSalePrice>
          <d2p1:Quantity>6</d2p1:Quantity>
          <d2p1:Timestamp>2025-12-08T10:21:34.6838273+01:00</d2p1:Timestamp>
          <d2p1:UserId>2</d2p1:UserId>
        </d2p1:ProductRegistrationDto>
        <d2p1:ProductRegistrationDto>
          <d2p1:CaseId>3</d2p1:CaseId>
          <d2p1:Ean>sample string 8</d2p1:Ean>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsCreditRegistration>true</d2p1:IsCreditRegistration>
          <d2p1:ProductId>4</d2p1:ProductId>
          <d2p1:ProductName>sample string 5</d2p1:ProductName>
          <d2p1:ProductSalePrice>1</d2p1:ProductSalePrice>
          <d2p1:Quantity>6</d2p1:Quantity>
          <d2p1:Timestamp>2025-12-08T10:21:34.6838273+01:00</d2p1:Timestamp>
          <d2p1:UserId>2</d2p1:UserId>
        </d2p1:ProductRegistrationDto>
      </d2p1:ProductRegistrationInfos>
      <d2p1:SalesPrice>1</d2p1:SalesPrice>
      <d2p1:SearchName>sample string 2</d2p1:SearchName>
      <d2p1:SupplierName>sample string 6</d2p1:SupplierName>
      <d2p1:Title>sample string 3</d2p1:Title>
      <d2p1:UnitCode>sample string 5</d2p1:UnitCode>
    </d2p1:ProductDto>
  </Products>
</ProductsWithPagingViewModel>