GET api/v1/products?searchText={searchText}&Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
searchText

string

Required

Limit

integer

None.

Offset

integer

None.

OrderBy

string

None.

Body Parameters

None.

Response Information

Resource Description

MultiResultResponseOfProductDto
NameDescriptionTypeAdditional information
Meta

MetaMultiResult

None.

Notifications

None.

Response Formats

application/json, text/json

Sample:
{
  "meta": {
    "limit": 1,
    "offset": 2,
    "totalResults": 3
  },
  "notifications": [
    {},
    {}
  ],
  "results": [
    {
      "id": "f550ed83-df8a-4549-af61-30140f126859",
      "code": "sample string 1",
      "name": "sample string 2",
      "price": 1.0,
      "barcode": "sample string 3",
      "brandCode": "sample string 4",
      "brandName": "sample string 5",
      "organizationCode": "sample string 6",
      "productCategories": [
        "sample string 1",
        "sample string 2"
      ],
      "categories": [
        {
          "id": "dba95c00-39a8-4ca3-89e9-fa1260b28c87",
          "code": "sample string 1",
          "name": "sample string 2",
          "organizationCode": "sample string 3",
          "creationDate": "2025-08-31T08:55:32.5204291+00:00"
        },
        {
          "id": "dba95c00-39a8-4ca3-89e9-fa1260b28c87",
          "code": "sample string 1",
          "name": "sample string 2",
          "organizationCode": "sample string 3",
          "creationDate": "2025-08-31T08:55:32.5204291+00:00"
        }
      ],
      "productTypeCode": "sample string 7",
      "isDeletable": true,
      "creationDate": "2025-08-31T08:55:32.5204291+00:00"
    },
    {
      "id": "f550ed83-df8a-4549-af61-30140f126859",
      "code": "sample string 1",
      "name": "sample string 2",
      "price": 1.0,
      "barcode": "sample string 3",
      "brandCode": "sample string 4",
      "brandName": "sample string 5",
      "organizationCode": "sample string 6",
      "productCategories": [
        "sample string 1",
        "sample string 2"
      ],
      "categories": [
        {
          "id": "dba95c00-39a8-4ca3-89e9-fa1260b28c87",
          "code": "sample string 1",
          "name": "sample string 2",
          "organizationCode": "sample string 3",
          "creationDate": "2025-08-31T08:55:32.5204291+00:00"
        },
        {
          "id": "dba95c00-39a8-4ca3-89e9-fa1260b28c87",
          "code": "sample string 1",
          "name": "sample string 2",
          "organizationCode": "sample string 3",
          "creationDate": "2025-08-31T08:55:32.5204291+00:00"
        }
      ],
      "productTypeCode": "sample string 7",
      "isDeletable": true,
      "creationDate": "2025-08-31T08:55:32.5204291+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<MultiResultResponseOfProductDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta>
    <Limit>1</Limit>
    <Offset>2</Offset>
    <TotalResults>3</TotalResults>
  </Meta>
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
    <d2p1:ProductDto>
      <d2p1:Barcode>sample string 3</d2p1:Barcode>
      <d2p1:BrandCode>sample string 4</d2p1:BrandCode>
      <d2p1:BrandName>sample string 5</d2p1:BrandName>
      <d2p1:Categories>
        <d2p1:ProductCategoryDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:CreationDate>2025-08-31T08:55:32.5204291+00:00</d2p1:CreationDate>
          <d2p1:Id>dba95c00-39a8-4ca3-89e9-fa1260b28c87</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:OrganizationCode>sample string 3</d2p1:OrganizationCode>
        </d2p1:ProductCategoryDto>
        <d2p1:ProductCategoryDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:CreationDate>2025-08-31T08:55:32.5204291+00:00</d2p1:CreationDate>
          <d2p1:Id>dba95c00-39a8-4ca3-89e9-fa1260b28c87</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:OrganizationCode>sample string 3</d2p1:OrganizationCode>
        </d2p1:ProductCategoryDto>
      </d2p1:Categories>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:CreationDate>2025-08-31T08:55:32.5204291+00:00</d2p1:CreationDate>
      <d2p1:Id>f550ed83-df8a-4549-af61-30140f126859</d2p1:Id>
      <d2p1:IsDeletable>true</d2p1:IsDeletable>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:OrganizationCode>sample string 6</d2p1:OrganizationCode>
      <d2p1:Price>1</d2p1:Price>
      <d2p1:ProductCategories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:ProductCategories>
      <d2p1:ProductTypeCode>sample string 7</d2p1:ProductTypeCode>
    </d2p1:ProductDto>
    <d2p1:ProductDto>
      <d2p1:Barcode>sample string 3</d2p1:Barcode>
      <d2p1:BrandCode>sample string 4</d2p1:BrandCode>
      <d2p1:BrandName>sample string 5</d2p1:BrandName>
      <d2p1:Categories>
        <d2p1:ProductCategoryDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:CreationDate>2025-08-31T08:55:32.5204291+00:00</d2p1:CreationDate>
          <d2p1:Id>dba95c00-39a8-4ca3-89e9-fa1260b28c87</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:OrganizationCode>sample string 3</d2p1:OrganizationCode>
        </d2p1:ProductCategoryDto>
        <d2p1:ProductCategoryDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:CreationDate>2025-08-31T08:55:32.5204291+00:00</d2p1:CreationDate>
          <d2p1:Id>dba95c00-39a8-4ca3-89e9-fa1260b28c87</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
          <d2p1:OrganizationCode>sample string 3</d2p1:OrganizationCode>
        </d2p1:ProductCategoryDto>
      </d2p1:Categories>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:CreationDate>2025-08-31T08:55:32.5204291+00:00</d2p1:CreationDate>
      <d2p1:Id>f550ed83-df8a-4549-af61-30140f126859</d2p1:Id>
      <d2p1:IsDeletable>true</d2p1:IsDeletable>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:OrganizationCode>sample string 6</d2p1:OrganizationCode>
      <d2p1:Price>1</d2p1:Price>
      <d2p1:ProductCategories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:ProductCategories>
      <d2p1:ProductTypeCode>sample string 7</d2p1:ProductTypeCode>
    </d2p1:ProductDto>
  </Results>
</MultiResultResponseOfProductDtoaM_S85dVU>