GET api/catalogs/{catalogName}/products/{productCode}
Returns entire product info by its code.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
catalogName |
Catalog name. |
string |
Required |
productCode |
Product code in PDB. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
LegacyProductName | Description | Type | Additional information |
---|---|---|---|
Id |
ID of the product in PDB. |
integer |
None. |
Code |
Product code. |
string |
None. |
Ean |
Product EAN-13 barcode (International Article Number). |
string |
None. |
Name |
Public friendly product name. |
string |
None. |
UrlSegment |
URL-friendly product name equivalent. |
string |
None. |
Language |
Product language. |
string |
None. |
PublishedOn |
Date and time when the product was published in PDB. |
date |
None. |
ModifiedOn |
Date and time when the product was last modified in PDB. |
date |
None. |
ItemCount |
Count of items in the package. Always `1` for products. |
integer |
None. |
Image |
Product image URL. |
string |
None. |
Brand |
Product brand info. |
ProductBrand |
None. |
Categories |
A list of product categories. |
Collection of ProductCategory |
None. |
Tags |
A list of product tags. |
Collection of ProductTag |
None. |
Markets |
A list of markets where this product is available. |
Collection of string |
None. |
Bundles |
Product bundles available for sale. |
Collection of ProductBundle |
None. |
ShortDescription |
Short product description. Multiline text. |
string |
None. |
Description |
Full product description. Multiline text. |
string |
None. |
TasteSignature |
Short text about product taste. |
string |
None. |
Manufacturers |
A list of product manufacturers. |
Collection of string |
None. |
Ecological |
Marks a product as ecological. |
boolean |
None. |
Keyhole |
Marks a product with keyhole (identifies healthy products). |
boolean |
None. |
AttachedDocuments |
Attached document URLs list. |
Collection of string |
None. |
Nutrition |
Product nutrition values per 100 grams. |
LegacyProductNutrition |
None. |
Ingredients |
Product ingredients. Multiline text. |
string |
None. |
HasNuts |
Marks product as containing nuts. |
boolean |
None. |
StorageTemperature |
Required storage termperatures for a product. |
ProductStorageTemperature |
None. |
StorageTerm |
Max storage terms for a product. |
LegacyProductStorageTerm |
None. |
Packaging |
Information about product packaging. |
ProductPackaging |
None. |
Weight |
Product weight or volume. |
ProductWeight |
None. |
Dimensions |
Product shipping dimensions. |
ProductDimensions |
None. |
CountPerPallet |
Count of products which can be placed on one pallet. |
integer |
None. |
MarkAsNew |
Marks a product as new. |
boolean |
None. |
MarkAsNewFrom |
A date when a product become considered as new. |
date |
None. |
MarkAsNewTill |
A date when a product stop being considered as new. |
date |
None. |
Response Formats
application/json, text/json
{ "id": 1, "code": "sample string 2", "ean": "sample string 3", "name": "sample string 4", "urlSegment": "sample string 5", "language": "sample string 6", "publishedOn": "2024-03-29T06:54:57.7738332+01:00", "modifiedOn": "2024-03-29T06:54:57.7738332+01:00", "itemCount": 9, "image": "sample string 10", "brand": { "logo": "sample string 1", "id": 2, "code": "sample string 3", "name": "sample string 4", "urlSegment": "sample string 5", "language": "sample string 6", "sortOrder": 7, "parentCode": "sample string 8" }, "categories": [ { "id": 1, "code": "sample string 2", "name": "sample string 3", "urlSegment": "sample string 4", "language": "sample string 5", "sortOrder": 6, "parentCode": "sample string 7" }, { "id": 1, "code": "sample string 2", "name": "sample string 3", "urlSegment": "sample string 4", "language": "sample string 5", "sortOrder": 6, "parentCode": "sample string 7" } ], "tags": [ { "group": "sample string 1", "id": 2, "code": "sample string 3", "name": "sample string 4", "urlSegment": "sample string 5", "language": "sample string 6", "sortOrder": 7, "parentCode": "sample string 8" }, { "group": "sample string 1", "id": 2, "code": "sample string 3", "name": "sample string 4", "urlSegment": "sample string 5", "language": "sample string 6", "sortOrder": 7, "parentCode": "sample string 8" } ], "markets": [ "sample string 1", "sample string 2" ], "bundles": [ { "id": 1, "code": "sample string 2", "quantity": 3 }, { "id": 1, "code": "sample string 2", "quantity": 3 } ], "shortDescription": "sample string 11", "description": "sample string 12", "tasteSignature": "sample string 13", "manufacturers": [ "sample string 1", "sample string 2" ], "ecological": true, "keyhole": true, "attachedDocuments": [ "sample string 1", "sample string 2" ], "nutrition": { "energyKcal": "sample string 1", "energyKj": "sample string 2", "fat": "sample string 3", "saturatedFat": "sample string 4", "carbohydrate": "sample string 5", "sugar": "sample string 6", "protein": "sample string 7", "salt": "sample string 8", "calcium": "sample string 9", "lactose": "sample string 10" }, "ingredients": "sample string 16", "hasNuts": true, "storageTemperature": { "max": 1, "recommended": 1, "opened": 1, "freezing": true }, "storageTerm": { "unopened": 1, "opened": "sample string 2" }, "packaging": { "name": "sample string 1", "description": "sample string 2" }, "weight": { "value": 1.1, "unit": "sample string 2" }, "dimensions": { "width": 1.1, "height": 2.1, "length": 3.1 }, "countPerPallet": 18, "markAsNew": true, "markAsNewFrom": "2024-03-29T06:54:57.7788343+01:00", "markAsNewTill": "2024-03-29T06:54:57.7788343+01:00" }
application/xml, text/xml
<LegacyProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PDB.Api.Models"> <AttachedDocuments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </AttachedDocuments> <Brand> <Code>sample string 3</Code> <Id>2</Id> <Language>sample string 6</Language> <Name>sample string 4</Name> <ParentCode>sample string 8</ParentCode> <SortOrder>7</SortOrder> <UrlSegment>sample string 5</UrlSegment> <Logo>sample string 1</Logo> </Brand> <Bundles> <ProductBundle> <Code>sample string 2</Code> <Id>1</Id> <Quantity>3</Quantity> </ProductBundle> <ProductBundle> <Code>sample string 2</Code> <Id>1</Id> <Quantity>3</Quantity> </ProductBundle> </Bundles> <Categories> <ProductCategory> <Code>sample string 2</Code> <Id>1</Id> <Language>sample string 5</Language> <Name>sample string 3</Name> <ParentCode>sample string 7</ParentCode> <SortOrder>6</SortOrder> <UrlSegment>sample string 4</UrlSegment> </ProductCategory> <ProductCategory> <Code>sample string 2</Code> <Id>1</Id> <Language>sample string 5</Language> <Name>sample string 3</Name> <ParentCode>sample string 7</ParentCode> <SortOrder>6</SortOrder> <UrlSegment>sample string 4</UrlSegment> </ProductCategory> </Categories> <Code>sample string 2</Code> <CountPerPallet>18</CountPerPallet> <Description>sample string 12</Description> <Dimensions> <Height>2.1</Height> <Length>3.1</Length> <Width>1.1</Width> </Dimensions> <Ean>sample string 3</Ean> <Ecological>true</Ecological> <HasNuts>true</HasNuts> <Id>1</Id> <Image>sample string 10</Image> <Ingredients>sample string 16</Ingredients> <ItemCount>9</ItemCount> <Keyhole>true</Keyhole> <Language>sample string 6</Language> <Manufacturers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Manufacturers> <MarkAsNew>true</MarkAsNew> <MarkAsNewFrom>2024-03-29T06:54:57.7788343+01:00</MarkAsNewFrom> <MarkAsNewTill>2024-03-29T06:54:57.7788343+01:00</MarkAsNewTill> <Markets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Markets> <ModifiedOn>2024-03-29T06:54:57.7738332+01:00</ModifiedOn> <Name>sample string 4</Name> <Nutrition> <Calcium>sample string 9</Calcium> <Carbohydrate>sample string 5</Carbohydrate> <EnergyKcal>sample string 1</EnergyKcal> <EnergyKj>sample string 2</EnergyKj> <Fat>sample string 3</Fat> <Lactose>sample string 10</Lactose> <Protein>sample string 7</Protein> <Salt>sample string 8</Salt> <SaturatedFat>sample string 4</SaturatedFat> <Sugar>sample string 6</Sugar> </Nutrition> <Packaging> <Description>sample string 2</Description> <Name>sample string 1</Name> </Packaging> <PublishedOn>2024-03-29T06:54:57.7738332+01:00</PublishedOn> <ShortDescription>sample string 11</ShortDescription> <StorageTemperature> <Freezing>true</Freezing> <Max>1</Max> <Opened>1</Opened> <Recommended>1</Recommended> </StorageTemperature> <StorageTerm> <Opened>sample string 2</Opened> <Unopened>1</Unopened> </StorageTerm> <Tags> <ProductTag> <Code>sample string 3</Code> <Id>2</Id> <Language>sample string 6</Language> <Name>sample string 4</Name> <ParentCode>sample string 8</ParentCode> <SortOrder>7</SortOrder> <UrlSegment>sample string 5</UrlSegment> <Group>sample string 1</Group> </ProductTag> <ProductTag> <Code>sample string 3</Code> <Id>2</Id> <Language>sample string 6</Language> <Name>sample string 4</Name> <ParentCode>sample string 8</ParentCode> <SortOrder>7</SortOrder> <UrlSegment>sample string 5</UrlSegment> <Group>sample string 1</Group> </ProductTag> </Tags> <TasteSignature>sample string 13</TasteSignature> <UrlSegment>sample string 5</UrlSegment> <Weight> <Unit>sample string 2</Unit> <Value>1.1</Value> </Weight> </LegacyProduct>