GET Catalogue/GetCatalogues/{SiteID}
Returns Products (V3), Measure, OptionGroups (V2), PriceGroups Catalogues and TenderTypes.
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteID | integer |
The SiteID From The Sites Call To Get The Product Catalogue For |
Body Parameters
ProductCatalogueFilter| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteID | integer |
Required |
|
| ProductType | string |
Product Type Name |
|
| ProductTypeID | integer |
Product Type ID |
|
| ProductGroup | string |
Product Group Name |
|
| ProductGroupID | integer |
Product Group ID |
|
| ProductGroupIDs | Collection of integer |
List of Product Group IDs |
|
| Product | string |
Product Name |
|
| ProductID | integer |
Product ID |
|
| PriceGroup | integer |
Price Group ID |
|
| DesignModeId | integer |
Design Mode ID |
|
| PLU | string |
Price PLU |
|
| IsActive | boolean |
Product IsActive |
|
| HideDefaultPrices | boolean |
Product HideDefaultPrices |
Request Formats
application/json, text/json
Sample:
{
"SiteID": 1,
"ProductType": "sample string 1",
"ProductTypeID": 1,
"ProductGroup": "sample string 2",
"ProductGroupID": 1,
"ProductGroupIDs": [
1,
2
],
"Product": "sample string 3",
"ProductID": 1,
"PriceGroup": 1,
"DesignModeId": 1,
"PLU": "sample string 4",
"IsActive": true,
"HideDefaultPrices": true
}
application/xml, text/xml
Sample:
System.Xml.XmlDocument
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ConcatenatedCatalogue| Name | Type | Description | Additional information |
|---|---|---|---|
| Products | ProductCatalogueDto |
None. |
|
| Measures | MeasureCatalogue |
None. |
|
| OptionGroups | Collection of OptionGroupDto |
None. |
|
| PriceGroups | PriceGroupCatalogue |
None. |
|
| TenderTypes | TenderTypesCatalogue |
None. |
Response Formats
application/json, text/json
Sample:
{
"Products": {
"SiteID": 1,
"Products": [
{
"ProductId": 1,
"ProductName": "sample string 2",
"Description": "sample string 3",
"ProductGroupId": 4,
"ProductGroupName": "sample string 5",
"ProductTypeId": 6,
"ProductTypeName": "sample string 7",
"IsVirtuallySellable": true,
"IsAlcohol": true,
"AlcoholPercent": 10.0,
"ThirdPartyReference": "sample string 11",
"ProductInfo": "sample string 12",
"CostPricePerSKU": 13.0,
"ImageSaveDate": "2026-10-17T02:40:14.4709044",
"Prices": [
{
"PriceId": 1,
"PriceGroupID": 2,
"MeasureID": 3,
"GrossPrice": 4.0,
"Barcode": "sample string 5",
"TaxGroupID": 6,
"PLU": "sample string 7",
"ProductID": 8,
"ProductName": "sample string 9",
"Calories": 10,
"CostPrice": 11.0,
"OptionGroups": [
{
"OptionGroupID": 1,
"IsOptional": true,
"FreeValue": 3.0,
"FreeQuantity": 4
},
{
"OptionGroupID": 1,
"IsOptional": true,
"FreeValue": 3.0,
"FreeQuantity": 4
}
],
"DefaultOptions": [
{
"OptionGroupID": 1,
"OptionItems": [
1,
2
]
},
{
"OptionGroupID": 1,
"OptionItems": [
1,
2
]
}
]
},
{
"PriceId": 1,
"PriceGroupID": 2,
"MeasureID": 3,
"GrossPrice": 4.0,
"Barcode": "sample string 5",
"TaxGroupID": 6,
"PLU": "sample string 7",
"ProductID": 8,
"ProductName": "sample string 9",
"Calories": 10,
"CostPrice": 11.0,
"OptionGroups": [
{
"OptionGroupID": 1,
"IsOptional": true,
"FreeValue": 3.0,
"FreeQuantity": 4
},
{
"OptionGroupID": 1,
"IsOptional": true,
"FreeValue": 3.0,
"FreeQuantity": 4
}
],
"DefaultOptions": [
{
"OptionGroupID": 1,
"OptionItems": [
1,
2
]
},
{
"OptionGroupID": 1,
"OptionItems": [
1,
2
]
}
]
}
]
},
{
"ProductId": 1,
"ProductName": "sample string 2",
"Description": "sample string 3",
"ProductGroupId": 4,
"ProductGroupName": "sample string 5",
"ProductTypeId": 6,
"ProductTypeName": "sample string 7",
"IsVirtuallySellable": true,
"IsAlcohol": true,
"AlcoholPercent": 10.0,
"ThirdPartyReference": "sample string 11",
"ProductInfo": "sample string 12",
"CostPricePerSKU": 13.0,
"ImageSaveDate": "2026-10-17T02:40:14.4709044",
"Prices": [
{
"PriceId": 1,
"PriceGroupID": 2,
"MeasureID": 3,
"GrossPrice": 4.0,
"Barcode": "sample string 5",
"TaxGroupID": 6,
"PLU": "sample string 7",
"ProductID": 8,
"ProductName": "sample string 9",
"Calories": 10,
"CostPrice": 11.0,
"OptionGroups": [
{
"OptionGroupID": 1,
"IsOptional": true,
"FreeValue": 3.0,
"FreeQuantity": 4
},
{
"OptionGroupID": 1,
"IsOptional": true,
"FreeValue": 3.0,
"FreeQuantity": 4
}
],
"DefaultOptions": [
{
"OptionGroupID": 1,
"OptionItems": [
1,
2
]
},
{
"OptionGroupID": 1,
"OptionItems": [
1,
2
]
}
]
},
{
"PriceId": 1,
"PriceGroupID": 2,
"MeasureID": 3,
"GrossPrice": 4.0,
"Barcode": "sample string 5",
"TaxGroupID": 6,
"PLU": "sample string 7",
"ProductID": 8,
"ProductName": "sample string 9",
"Calories": 10,
"CostPrice": 11.0,
"OptionGroups": [
{
"OptionGroupID": 1,
"IsOptional": true,
"FreeValue": 3.0,
"FreeQuantity": 4
},
{
"OptionGroupID": 1,
"IsOptional": true,
"FreeValue": 3.0,
"FreeQuantity": 4
}
],
"DefaultOptions": [
{
"OptionGroupID": 1,
"OptionItems": [
1,
2
]
},
{
"OptionGroupID": 1,
"OptionItems": [
1,
2
]
}
]
}
]
}
]
},
"Measures": null,
"OptionGroups": [
{
"OptionGroupID": 1,
"SiteID": 2,
"Name": "sample string 3",
"MinOptionCount": 4,
"MaxOptionCount": 5,
"PromptForQuantity": true,
"Order": 7,
"Active": true,
"OptionItems": [
{
"OptionItemID": 1,
"SiteID": 2,
"OptionGroupID": 3,
"Name": "sample string 4",
"ProductID": 5,
"MeasureID": 6,
"Active": true,
"Prices": [
{
"PriceGroupID": 1,
"GrossPrice": 2.0,
"PLU": "sample string 3"
},
{
"PriceGroupID": 1,
"GrossPrice": 2.0,
"PLU": "sample string 3"
}
]
},
{
"OptionItemID": 1,
"SiteID": 2,
"OptionGroupID": 3,
"Name": "sample string 4",
"ProductID": 5,
"MeasureID": 6,
"Active": true,
"Prices": [
{
"PriceGroupID": 1,
"GrossPrice": 2.0,
"PLU": "sample string 3"
},
{
"PriceGroupID": 1,
"GrossPrice": 2.0,
"PLU": "sample string 3"
}
]
}
]
},
{
"OptionGroupID": 1,
"SiteID": 2,
"Name": "sample string 3",
"MinOptionCount": 4,
"MaxOptionCount": 5,
"PromptForQuantity": true,
"Order": 7,
"Active": true,
"OptionItems": [
{
"OptionItemID": 1,
"SiteID": 2,
"OptionGroupID": 3,
"Name": "sample string 4",
"ProductID": 5,
"MeasureID": 6,
"Active": true,
"Prices": [
{
"PriceGroupID": 1,
"GrossPrice": 2.0,
"PLU": "sample string 3"
},
{
"PriceGroupID": 1,
"GrossPrice": 2.0,
"PLU": "sample string 3"
}
]
},
{
"OptionItemID": 1,
"SiteID": 2,
"OptionGroupID": 3,
"Name": "sample string 4",
"ProductID": 5,
"MeasureID": 6,
"Active": true,
"Prices": [
{
"PriceGroupID": 1,
"GrossPrice": 2.0,
"PLU": "sample string 3"
},
{
"PriceGroupID": 1,
"GrossPrice": 2.0,
"PLU": "sample string 3"
}
]
}
]
}
],
"PriceGroups": null,
"TenderTypes": {
"SiteID": 1,
"TenderTypes": [
{
"TenderTypeID": 1,
"SiteID": 2,
"Name": "sample string 3"
},
{
"TenderTypeID": 1,
"SiteID": 2,
"Name": "sample string 3"
}
]
}
}
application/xml, text/xml
Sample:
System.Xml.XmlDocument