GET v{version}/ProductCatalogue

Gets A List Of Products For The SiteID Given, V3 will also give you a price for every price group, instead of just giving you a price if it exists. E.g. if the site has 100 products, and only 20 of these products have a takeaway price, this endpoint will return the 100 prices, 20 of them using the takeaway price, and the rest using the standard. This endpoint is how the epos works when it’s setup to use a different price group, the price group essentially acts as an override to the standard prices

Request Information

URI Parameters

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
version	string		None.

Body Parameters

None.

Response Information

Resource Description

ProductCatalogueDto

Name	Type	Description	Additional information
SiteID	integer		None.
Products	Collection of ProductDto		None.

Response Formats

application/json, text/json

Sample:

{
  "SiteID": 1,
  "Products": [
    {
      "ProductId": 1,
      "ProductName": "sample string 2",
      "Description": "sample string 3",
      "ProductGroupName": "sample string 4",
      "ProductTypeName": "sample string 5",
      "IsVirtuallySellable": true,
      "IsAlcohol": true,
      "AlcoholPercent": 8.0,
      "ThirdPartyReference": "sample string 9",
      "ProductInfo": "sample string 10",
      "CostPricePerSKU": 11.0,
      "ImageSaveDate": "2024-11-21T06:40:10.3418674+00:00",
      "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",
      "ProductGroupName": "sample string 4",
      "ProductTypeName": "sample string 5",
      "IsVirtuallySellable": true,
      "IsAlcohol": true,
      "AlcoholPercent": 8.0,
      "ThirdPartyReference": "sample string 9",
      "ProductInfo": "sample string 10",
      "CostPricePerSKU": 11.0,
      "ImageSaveDate": "2024-11-21T06:40:10.3418674+00:00",
      "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
              ]
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ProductCatalogueDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.v3.ProductCatalogue">
  <Products>
    <ProductCatalogueDto.ProductDto>
      <AlcoholPercent>8</AlcoholPercent>
      <CostPricePerSKU>11</CostPricePerSKU>
      <Description>sample string 3</Description>
      <ImageSaveDate>2024-11-21T06:40:10.3418674+00:00</ImageSaveDate>
      <IsAlcohol>true</IsAlcohol>
      <IsVirtuallySellable>true</IsVirtuallySellable>
      <Prices>
        <ProductCatalogueDto.PriceDto>
          <Barcode>sample string 5</Barcode>
          <Calories>10</Calories>
          <CostPrice>11</CostPrice>
          <DefaultOptions>
            <ProductCatalogueDto.DefaultOptionsV3>
              <OptionGroupID>1</OptionGroupID>
              <OptionItems xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </OptionItems>
            </ProductCatalogueDto.DefaultOptionsV3>
            <ProductCatalogueDto.DefaultOptionsV3>
              <OptionGroupID>1</OptionGroupID>
              <OptionItems xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </OptionItems>
            </ProductCatalogueDto.DefaultOptionsV3>
          </DefaultOptions>
          <GrossPrice>4</GrossPrice>
          <MeasureID>3</MeasureID>
          <OptionGroups>
            <ProductCatalogueDto.OptionGroups>
              <FreeQuantity>4</FreeQuantity>
              <FreeValue>3</FreeValue>
              <IsOptional>true</IsOptional>
              <OptionGroupID>1</OptionGroupID>
            </ProductCatalogueDto.OptionGroups>
            <ProductCatalogueDto.OptionGroups>
              <FreeQuantity>4</FreeQuantity>
              <FreeValue>3</FreeValue>
              <IsOptional>true</IsOptional>
              <OptionGroupID>1</OptionGroupID>
            </ProductCatalogueDto.OptionGroups>
          </OptionGroups>
          <PLU>sample string 7</PLU>
          <PriceGroupID>2</PriceGroupID>
          <PriceId>1</PriceId>
          <ProductID>8</ProductID>
          <ProductName>sample string 9</ProductName>
          <TaxGroupID>6</TaxGroupID>
        </ProductCatalogueDto.PriceDto>
        <ProductCatalogueDto.PriceDto>
          <Barcode>sample string 5</Barcode>
          <Calories>10</Calories>
          <CostPrice>11</CostPrice>
          <DefaultOptions>
            <ProductCatalogueDto.DefaultOptionsV3>
              <OptionGroupID>1</OptionGroupID>
              <OptionItems xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </OptionItems>
            </ProductCatalogueDto.DefaultOptionsV3>
            <ProductCatalogueDto.DefaultOptionsV3>
              <OptionGroupID>1</OptionGroupID>
              <OptionItems xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </OptionItems>
            </ProductCatalogueDto.DefaultOptionsV3>
          </DefaultOptions>
          <GrossPrice>4</GrossPrice>
          <MeasureID>3</MeasureID>
          <OptionGroups>
            <ProductCatalogueDto.OptionGroups>
              <FreeQuantity>4</FreeQuantity>
              <FreeValue>3</FreeValue>
              <IsOptional>true</IsOptional>
              <OptionGroupID>1</OptionGroupID>
            </ProductCatalogueDto.OptionGroups>
            <ProductCatalogueDto.OptionGroups>
              <FreeQuantity>4</FreeQuantity>
              <FreeValue>3</FreeValue>
              <IsOptional>true</IsOptional>
              <OptionGroupID>1</OptionGroupID>
            </ProductCatalogueDto.OptionGroups>
          </OptionGroups>
          <PLU>sample string 7</PLU>
          <PriceGroupID>2</PriceGroupID>
          <PriceId>1</PriceId>
          <ProductID>8</ProductID>
          <ProductName>sample string 9</ProductName>
          <TaxGroupID>6</TaxGroupID>
        </ProductCatalogueDto.PriceDto>
      </Prices>
      <ProductGroupName>sample string 4</ProductGroupName>
      <ProductId>1</ProductId>
      <ProductInfo>sample string 10</ProductInfo>
      <ProductName>sample string 2</ProductName>
      <ProductTypeName>sample string 5</ProductTypeName>
      <ThirdPartyReference>sample string 9</ThirdPartyReference>
    </ProductCatalogueDto.ProductDto>
    <ProductCatalogueDto.ProductDto>
      <AlcoholPercent>8</AlcoholPercent>
      <CostPricePerSKU>11</CostPricePerSKU>
      <Description>sample string 3</Description>
      <ImageSaveDate>2024-11-21T06:40:10.3418674+00:00</ImageSaveDate>
      <IsAlcohol>true</IsAlcohol>
      <IsVirtuallySellable>true</IsVirtuallySellable>
      <Prices>
        <ProductCatalogueDto.PriceDto>
          <Barcode>sample string 5</Barcode>
          <Calories>10</Calories>
          <CostPrice>11</CostPrice>
          <DefaultOptions>
            <ProductCatalogueDto.DefaultOptionsV3>
              <OptionGroupID>1</OptionGroupID>
              <OptionItems xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </OptionItems>
            </ProductCatalogueDto.DefaultOptionsV3>
            <ProductCatalogueDto.DefaultOptionsV3>
              <OptionGroupID>1</OptionGroupID>
              <OptionItems xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </OptionItems>
            </ProductCatalogueDto.DefaultOptionsV3>
          </DefaultOptions>
          <GrossPrice>4</GrossPrice>
          <MeasureID>3</MeasureID>
          <OptionGroups>
            <ProductCatalogueDto.OptionGroups>
              <FreeQuantity>4</FreeQuantity>
              <FreeValue>3</FreeValue>
              <IsOptional>true</IsOptional>
              <OptionGroupID>1</OptionGroupID>
            </ProductCatalogueDto.OptionGroups>
            <ProductCatalogueDto.OptionGroups>
              <FreeQuantity>4</FreeQuantity>
              <FreeValue>3</FreeValue>
              <IsOptional>true</IsOptional>
              <OptionGroupID>1</OptionGroupID>
            </ProductCatalogueDto.OptionGroups>
          </OptionGroups>
          <PLU>sample string 7</PLU>
          <PriceGroupID>2</PriceGroupID>
          <PriceId>1</PriceId>
          <ProductID>8</ProductID>
          <ProductName>sample string 9</ProductName>
          <TaxGroupID>6</TaxGroupID>
        </ProductCatalogueDto.PriceDto>
        <ProductCatalogueDto.PriceDto>
          <Barcode>sample string 5</Barcode>
          <Calories>10</Calories>
          <CostPrice>11</CostPrice>
          <DefaultOptions>
            <ProductCatalogueDto.DefaultOptionsV3>
              <OptionGroupID>1</OptionGroupID>
              <OptionItems xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </OptionItems>
            </ProductCatalogueDto.DefaultOptionsV3>
            <ProductCatalogueDto.DefaultOptionsV3>
              <OptionGroupID>1</OptionGroupID>
              <OptionItems xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </OptionItems>
            </ProductCatalogueDto.DefaultOptionsV3>
          </DefaultOptions>
          <GrossPrice>4</GrossPrice>
          <MeasureID>3</MeasureID>
          <OptionGroups>
            <ProductCatalogueDto.OptionGroups>
              <FreeQuantity>4</FreeQuantity>
              <FreeValue>3</FreeValue>
              <IsOptional>true</IsOptional>
              <OptionGroupID>1</OptionGroupID>
            </ProductCatalogueDto.OptionGroups>
            <ProductCatalogueDto.OptionGroups>
              <FreeQuantity>4</FreeQuantity>
              <FreeValue>3</FreeValue>
              <IsOptional>true</IsOptional>
              <OptionGroupID>1</OptionGroupID>
            </ProductCatalogueDto.OptionGroups>
          </OptionGroups>
          <PLU>sample string 7</PLU>
          <PriceGroupID>2</PriceGroupID>
          <PriceId>1</PriceId>
          <ProductID>8</ProductID>
          <ProductName>sample string 9</ProductName>
          <TaxGroupID>6</TaxGroupID>
        </ProductCatalogueDto.PriceDto>
      </Prices>
      <ProductGroupName>sample string 4</ProductGroupName>
      <ProductId>1</ProductId>
      <ProductInfo>sample string 10</ProductInfo>
      <ProductName>sample string 2</ProductName>
      <ProductTypeName>sample string 5</ProductTypeName>
      <ThirdPartyReference>sample string 9</ThirdPartyReference>
    </ProductCatalogueDto.ProductDto>
  </Products>
  <SiteID>1</SiteID>
</ProductCatalogueDto>