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

Get a list of Products based on a searchstring. Does not implement pagination, only limit on rows returned.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
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

Collection of ProductDto
NameDescriptionTypeAdditional information
EanNumber

string

None.

SearchName

string

None.

Title

string

None.

Description

string

None.

UnitCode

string

None.

SupplierName

string

None.

CostPrice

decimal number

None.

SalesPrice

decimal number

None.

ProductRegistrationInfos

Collection of ProductRegistrationDto

None.

Id

integer

None.

Inventory

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "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:18:19.0190221+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:18:19.0190221+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:18:19.0190221+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:18:19.0190221+01:00",
        "quantity": 6.0,
        "isCreditRegistration": true,
        "productSalePrice": 1.0,
        "ean": "sample string 8"
      }
    ],
    "id": 7,
    "inventory": 1.0
  }
]

application/xml, text/xml

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