GET product/upc?UserId={UserId}&Token={Token}&Query={Query}&Page={Page}&PageSize={PageSize}&Upc={Upc}&BestMatch={BestMatch}&Id={Id}&AutoApprove={AutoApprove}&CompanyId={CompanyId}&Text={Text}&ClientCode={ClientCode}&IsMro={IsMro}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
UserId

string

None.

Token

string

None.

Query

string

None.

Page

integer

None.

PageSize

integer

None.

Upc

string

None.

BestMatch

boolean

None.

Id

integer

None.

AutoApprove

boolean

None.

CompanyId

string

None.

Text

string

None.

ClientCode

string

None.

IsMro

boolean

None.

Body Parameters

None.

Response Information

Resource Description

ProductModel
NameDescriptionTypeAdditional information
Id

integer

None.

ProductImageId

integer

None.

Name

string

None.

CategoryId

integer

None.

Approved

boolean

None.

AddedBy

string

None.

Upc

string

None.

Ingredients

string

None.

Information

string

None.

InvalidUpcMessage

string

None.

ImagePath

string

None.

ClientCode

string

None.

IsMro

boolean

None.

Change

string

None.

IsNew

boolean

None.

Status

string

None.

ServingsPerContainer

string

None.

ServingSize

string

None.

Calories

string

None.

CaloriesFromFat

string

None.

TotalFat

string

None.

TotalFatPercent

string

None.

SaturatedFat

string

None.

SaturatedFatPercent

string

None.

TransFat

string

None.

TransFatPercent

string

None.

Cholesterol

string

None.

CholesterolPercent

string

None.

Sodium

string

None.

SodiumPercent

string

None.

TotalCarbohydrate

string

None.

TotalCarbohydratePercent

string

None.

DietaryFiber

string

None.

DietaryFiberPercent

string

None.

Sugars

string

None.

AddedSugars

string

None.

SugarsPercent

string

None.

Protein

string

None.

ProteinPercent

string

None.

ImageUrl

string

None.

ImageDataBase64

string

None.

FormattedNutrition

string

None.

ModifiedDate

date

None.

NutritionalXml

string

None.

CategoryName

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "productImageId": 1,
  "name": "sample string 2",
  "categoryId": 3,
  "approved": true,
  "addedBy": "sample string 5",
  "upc": "sample string 6",
  "ingredients": "sample string 7",
  "information": "sample string 8",
  "invalidUpcMessage": "sample string 9",
  "imagePath": "sample string 10",
  "clientCode": "sample string 11",
  "isMro": true,
  "change": "sample string 13",
  "isNew": true,
  "status": "sample string 15",
  "servingsPerContainer": "sample string 16",
  "servingSize": "sample string 17",
  "calories": "sample string 18",
  "caloriesFromFat": "sample string 19",
  "totalFat": "sample string 20",
  "totalFatPercent": "sample string 21",
  "saturatedFat": "sample string 22",
  "saturatedFatPercent": "sample string 23",
  "transFat": "sample string 24",
  "transFatPercent": "sample string 25",
  "cholesterol": "sample string 26",
  "cholesterolPercent": "sample string 27",
  "sodium": "sample string 28",
  "sodiumPercent": "sample string 29",
  "totalCarbohydrate": "sample string 30",
  "totalCarbohydratePercent": "sample string 31",
  "dietaryFiber": "sample string 32",
  "dietaryFiberPercent": "sample string 33",
  "sugars": "sample string 34",
  "addedSugars": "sample string 35",
  "sugarsPercent": "sample string 36",
  "protein": "sample string 37",
  "proteinPercent": "sample string 38",
  "imageUrl": "sample string 39",
  "imageDataBase64": "sample string 40",
  "formattedNutrition": "sample string 41",
  "modifiedDate": "2024-10-09T08:53:00.3791153+00:00",
  "nutritionalXml": "<NutritionalInfo servingsPerContainer=\"sample string 16\" servingSize=\"sample string 17\">\r\n  <Group name=\"Amount Per Serving\">\r\n    <Item name=\"Calories\" amount=\"sample string 18\">\r\n      <SubItem name=\"From Fat\" amount=\"sample string 19\" />\r\n    </Item>\r\n    <Item name=\"Total Fat\" amount=\"sample string 20\" percent=\"sample string 21\">\r\n      <SubItem name=\"Saturated Fat\" amount=\"sample string 22\" percent=\"sample string 23\" />\r\n      <SubItem name=\"Trans Fat\" amount=\"sample string 24\" percent=\"sample string 25\" />\r\n    </Item>\r\n    <Item name=\"Cholesterol\" amount=\"sample string 26\" percent=\"sample string 27\" />\r\n    <Item name=\"Sodium\" amount=\"sample string 28\" percent=\"sample string 29\" />\r\n    <Item name=\"Total Carbohydrate\" amount=\"sample string 30\" percent=\"sample string 31\">\r\n      <SubItem name=\"Dietary Fiber\" amount=\"sample string 32\" percent=\"sample string 33\" />\r\n      <SubItem name=\"Sugars\" amount=\"sample string 34\" percent=\"sample string 36\" />\r\n      <SubItem name=\"Added Sugars\" amount=\"sample string 35\" />\r\n    </Item>\r\n    <Item name=\"Protein\" amount=\"sample string 37\" percent=\"sample string 38\" />\r\n  </Group>\r\n</NutritionalInfo>",
  "categoryName": "sample string 42"
}

text/html

Sample:
{"id":1,"productImageId":1,"name":"sample string 2","categoryId":3,"approved":true,"addedBy":"sample string 5","upc":"sample string 6","ingredients":"sample string 7","information":"sample string 8","invalidUpcMessage":"sample string 9","imagePath":"sample string 10","clientCode":"sample string 11","isMro":true,"change":"sample string 13","isNew":true,"status":"sample string 15","servingsPerContainer":"sample string 16","servingSize":"sample string 17","calories":"sample string 18","caloriesFromFat":"sample string 19","totalFat":"sample string 20","totalFatPercent":"sample string 21","saturatedFat":"sample string 22","saturatedFatPercent":"sample string 23","transFat":"sample string 24","transFatPercent":"sample string 25","cholesterol":"sample string 26","cholesterolPercent":"sample string 27","sodium":"sample string 28","sodiumPercent":"sample string 29","totalCarbohydrate":"sample string 30","totalCarbohydratePercent":"sample string 31","dietaryFiber":"sample string 32","dietaryFiberPercent":"sample string 33","sugars":"sample string 34","addedSugars":"sample string 35","sugarsPercent":"sample string 36","protein":"sample string 37","proteinPercent":"sample string 38","imageUrl":"sample string 39","imageDataBase64":"sample string 40","formattedNutrition":"sample string 41","modifiedDate":"2024-10-09T08:53:00.3791153+00:00","nutritionalXml":"<NutritionalInfo servingsPerContainer=\"sample string 16\" servingSize=\"sample string 17\">\r\n  <Group name=\"Amount Per Serving\">\r\n    <Item name=\"Calories\" amount=\"sample string 18\">\r\n      <SubItem name=\"From Fat\" amount=\"sample string 19\" />\r\n    </Item>\r\n    <Item name=\"Total Fat\" amount=\"sample string 20\" percent=\"sample string 21\">\r\n      <SubItem name=\"Saturated Fat\" amount=\"sample string 22\" percent=\"sample string 23\" />\r\n      <SubItem name=\"Trans Fat\" amount=\"sample string 24\" percent=\"sample string 25\" />\r\n    </Item>\r\n    <Item name=\"Cholesterol\" amount=\"sample string 26\" percent=\"sample string 27\" />\r\n    <Item name=\"Sodium\" amount=\"sample string 28\" percent=\"sample string 29\" />\r\n    <Item name=\"Total Carbohydrate\" amount=\"sample string 30\" percent=\"sample string 31\">\r\n      <SubItem name=\"Dietary Fiber\" amount=\"sample string 32\" percent=\"sample string 33\" />\r\n      <SubItem name=\"Sugars\" amount=\"sample string 34\" percent=\"sample string 36\" />\r\n      <SubItem name=\"Added Sugars\" amount=\"sample string 35\" />\r\n    </Item>\r\n    <Item name=\"Protein\" amount=\"sample string 37\" percent=\"sample string 38\" />\r\n  </Group>\r\n</NutritionalInfo>","categoryName":"sample string 42"}

application/xml, text/xml

Sample:
<ProductModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TsfRetailMarkets.ProductApi.Models">
  <AddedBy>sample string 5</AddedBy>
  <AddedSugars>sample string 35</AddedSugars>
  <Approved>true</Approved>
  <Calories>sample string 18</Calories>
  <CaloriesFromFat>sample string 19</CaloriesFromFat>
  <CategoryId>3</CategoryId>
  <CategoryName>sample string 42</CategoryName>
  <Change>sample string 13</Change>
  <Cholesterol>sample string 26</Cholesterol>
  <CholesterolPercent>sample string 27</CholesterolPercent>
  <ClientCode>sample string 11</ClientCode>
  <DietaryFiber>sample string 32</DietaryFiber>
  <DietaryFiberPercent>sample string 33</DietaryFiberPercent>
  <FormattedNutrition>sample string 41</FormattedNutrition>
  <Id>1</Id>
  <ImageDataBase64>sample string 40</ImageDataBase64>
  <ImagePath>sample string 10</ImagePath>
  <ImageUrl>sample string 39</ImageUrl>
  <Information>sample string 8</Information>
  <Ingredients>sample string 7</Ingredients>
  <InvalidUpcMessage>sample string 9</InvalidUpcMessage>
  <IsMro>true</IsMro>
  <IsNew>true</IsNew>
  <ModifiedDate>2024-10-09T08:53:00.3791153+00:00</ModifiedDate>
  <Name>sample string 2</Name>
  <ProductImageId>1</ProductImageId>
  <Protein>sample string 37</Protein>
  <ProteinPercent>sample string 38</ProteinPercent>
  <SaturatedFat>sample string 22</SaturatedFat>
  <SaturatedFatPercent>sample string 23</SaturatedFatPercent>
  <ServingSize>sample string 17</ServingSize>
  <ServingsPerContainer>sample string 16</ServingsPerContainer>
  <Sodium>sample string 28</Sodium>
  <SodiumPercent>sample string 29</SodiumPercent>
  <Status>sample string 15</Status>
  <Sugars>sample string 34</Sugars>
  <SugarsPercent>sample string 36</SugarsPercent>
  <TotalCarbohydrate>sample string 30</TotalCarbohydrate>
  <TotalCarbohydratePercent>sample string 31</TotalCarbohydratePercent>
  <TotalFat>sample string 20</TotalFat>
  <TotalFatPercent>sample string 21</TotalFatPercent>
  <TransFat>sample string 24</TransFat>
  <TransFatPercent>sample string 25</TransFatPercent>
  <Upc>sample string 6</Upc>
</ProductModel>