GET api/v1/products/{productId}?includeRegistrations={includeRegistrations}

Get a Product by ProductId

Request Information

URI Parameters

Name	Description	Type	Additional information
productId		integer	Required
includeRegistrations		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

ProductDto

Name	Type	Additional 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:47.1676863+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:47.1676863+01:00",
      "quantity": 6.0,
      "isCreditRegistration": true,
      "productSalePrice": 1.0,
      "ean": "sample string 8"
    }
  ],
  "id": 7,
  "inventory": 1.0
}

application/xml, text/xml

Sample:

<ProductDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.Models">
  <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:47.1676863+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:47.1676863+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>