GET api/catalogs/{catalogName}/products?market={market}&query={query}&skus={skus}

Returns codes and names of all products in the catalog.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
catalogName

Catalog name.

string

Required

market

Filter products by market.

string

Optional

query

Filter products by text in the name or code.

string

Optional

skus

Return SKU's (including packages) instead of just products.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

ProductSearchResult
NameDescriptionTypeAdditional information
TotalCount

Total count of found products.

integer

None.

Language

Products language.

string

None.

Products

A list of found products containing their id's and names.

Collection of ProductListItem

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "language": "sample string 2",
  "products": [
    {
      "id": 1,
      "code": "sample string 2",
      "name": "sample string 3"
    },
    {
      "id": 1,
      "code": "sample string 2",
      "name": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<ProductSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PDB.Api.Models">
  <Language>sample string 2</Language>
  <Products>
    <ProductListItem>
      <Code>sample string 2</Code>
      <Id>1</Id>
      <Name>sample string 3</Name>
    </ProductListItem>
    <ProductListItem>
      <Code>sample string 2</Code>
      <Id>1</Id>
      <Name>sample string 3</Name>
    </ProductListItem>
  </Products>
  <TotalCount>1</TotalCount>
</ProductSearchResult>