GET api/ProductsRelationshipView/GetProducts?SupplierReference={SupplierReference}&BestGuess={BestGuess}&CheckLive={CheckLive}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SupplierReference

string

Required
BestGuess

boolean

Required
CheckLive

boolean

Required

Body Parameters

None.

Response Information

Resource Description

Collection of RelatedProductView
NameDescriptionTypeAdditional information
IsMasterProduct

boolean

None.
IsChildProduct

boolean

None.
DateAdded

date

None.
MasterProduct

globally unique identifier

None.
ChildProducts

Collection of globally unique identifier

None.
Barcode

string

String length: inclusive between 0 and 18
BrandID

integer

None.
BrandName

string

None.
CategoryID

integer

None.
CategoryName

string

None.
ParentCategoryID

integer

None.
ParentCategoryName

string

None.
DateAvailable

date

None.
Ethical

boolean

None.
FairTrade

boolean

None.
Name

string

Required

String length: inclusive between 0 and 128
Description

string

Required
Organic

boolean

None.
OuterBarcode

string

Required

String length: inclusive between 0 and 32
ProductID

globally unique identifier

None.
SKUCostPrice

decimal number

Data type: Currency
SKUID

integer

None.
SKUName

string

None.
SKUSellingPrice

decimal number

Data type: Currency
SKUSize

decimal number

None.
Status

eProductStatus

None.
SupplierID

integer

None.
SupplierName

string

None.
SupplierProductCode

string

Required

String length: inclusive between 0 and 64
TaxID

integer

None.
TaxRate

decimal number

None.
UnitCostPrice

decimal number

Data type: Currency
UnitSellingPrice

decimal number

Data type: Currency
CatalogueID

integer

None.
Temperature

Temperature

None.
Chilled

boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "IsMasterProduct": true,
    "IsChildProduct": true,
    "DateAdded": "2024-11-23T16:06:18.9699224+00:00",
    "MasterProduct": "10662ca5-4aa8-40e6-8542-f32a5de044b2",
    "ChildProducts": [
      "a0bc9e29-3902-4792-85c0-cca51f826832",
      "5e3db2e9-b8d1-45c1-8468-eaf46b2b0162"
    ],
    "Barcode": "sample string 4",
    "BrandID": 1,
    "BrandName": "sample string 5",
    "CategoryID": 6,
    "CategoryName": "sample string 7",
    "ParentCategoryID": 8,
    "ParentCategoryName": "sample string 9",
    "DateAvailable": "2024-11-23T16:06:18.9699224+00:00",
    "Ethical": true,
    "FairTrade": true,
    "Name": "sample string 10",
    "Description": "sample string 11",
    "Organic": true,
    "OuterBarcode": "sample string 12",
    "ProductID": "36792dfe-f236-48e6-8cf9-0e66ccbdebc6",
    "SKUCostPrice": 14.0,
    "SKUID": 15,
    "SKUName": "sample string 16",
    "SKUSellingPrice": 17.0,
    "SKUSize": 18.0,
    "Status": 0,
    "SupplierID": 19,
    "SupplierName": "sample string 20",
    "SupplierProductCode": "sample string 21",
    "TaxID": 22,
    "TaxRate": 23.1,
    "UnitCostPrice": 24.0,
    "UnitSellingPrice": 25.0,
    "CatalogueID": 26,
    "Temperature": 0,
    "Chilled": true
  },
  {
    "IsMasterProduct": true,
    "IsChildProduct": true,
    "DateAdded": "2024-11-23T16:06:18.9699224+00:00",
    "MasterProduct": "10662ca5-4aa8-40e6-8542-f32a5de044b2",
    "ChildProducts": [
      "a0bc9e29-3902-4792-85c0-cca51f826832",
      "5e3db2e9-b8d1-45c1-8468-eaf46b2b0162"
    ],
    "Barcode": "sample string 4",
    "BrandID": 1,
    "BrandName": "sample string 5",
    "CategoryID": 6,
    "CategoryName": "sample string 7",
    "ParentCategoryID": 8,
    "ParentCategoryName": "sample string 9",
    "DateAvailable": "2024-11-23T16:06:18.9699224+00:00",
    "Ethical": true,
    "FairTrade": true,
    "Name": "sample string 10",
    "Description": "sample string 11",
    "Organic": true,
    "OuterBarcode": "sample string 12",
    "ProductID": "36792dfe-f236-48e6-8cf9-0e66ccbdebc6",
    "SKUCostPrice": 14.0,
    "SKUID": 15,
    "SKUName": "sample string 16",
    "SKUSellingPrice": 17.0,
    "SKUSize": 18.0,
    "Status": 0,
    "SupplierID": 19,
    "SupplierName": "sample string 20",
    "SupplierProductCode": "sample string 21",
    "TaxID": 22,
    "TaxRate": 23.1,
    "UnitCostPrice": 24.0,
    "UnitSellingPrice": 25.0,
    "CatalogueID": 26,
    "Temperature": 0,
    "Chilled": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfRelatedProductView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fidelity.Fusion.Catalogue.Common.Models.TotalControlPremier">
  <RelatedProductView>
    <Barcode>sample string 4</Barcode>
    <BrandID>1</BrandID>
    <BrandName>sample string 5</BrandName>
    <CatalogueID>26</CatalogueID>
    <CategoryID>6</CategoryID>
    <CategoryName>sample string 7</CategoryName>
    <Chilled>true</Chilled>
    <DateAvailable>2024-11-23T16:06:18.9699224+00:00</DateAvailable>
    <Description>sample string 11</Description>
    <Ethical>true</Ethical>
    <FairTrade>true</FairTrade>
    <Name>sample string 10</Name>
    <Organic>true</Organic>
    <OuterBarcode>sample string 12</OuterBarcode>
    <ParentCategoryID>8</ParentCategoryID>
    <ParentCategoryName>sample string 9</ParentCategoryName>
    <ProductID>36792dfe-f236-48e6-8cf9-0e66ccbdebc6</ProductID>
    <SKUCostPrice>14</SKUCostPrice>
    <SKUID>15</SKUID>
    <SKUName>sample string 16</SKUName>
    <SKUSellingPrice>17</SKUSellingPrice>
    <SKUSize>18</SKUSize>
    <Status>Importing</Status>
    <SupplierID>19</SupplierID>
    <SupplierName>sample string 20</SupplierName>
    <SupplierProductCode>sample string 21</SupplierProductCode>
    <TaxID>22</TaxID>
    <TaxRate>23.1</TaxRate>
    <Temperature>Any</Temperature>
    <UnitCostPrice>24</UnitCostPrice>
    <UnitSellingPrice>25</UnitSellingPrice>
    <ChildProducts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>a0bc9e29-3902-4792-85c0-cca51f826832</d3p1:guid>
      <d3p1:guid>5e3db2e9-b8d1-45c1-8468-eaf46b2b0162</d3p1:guid>
    </ChildProducts>
    <DateAdded>2024-11-23T16:06:18.9699224+00:00</DateAdded>
    <IsChildProduct>true</IsChildProduct>
    <IsMasterProduct>true</IsMasterProduct>
    <MasterProduct>10662ca5-4aa8-40e6-8542-f32a5de044b2</MasterProduct>
  </RelatedProductView>
  <RelatedProductView>
    <Barcode>sample string 4</Barcode>
    <BrandID>1</BrandID>
    <BrandName>sample string 5</BrandName>
    <CatalogueID>26</CatalogueID>
    <CategoryID>6</CategoryID>
    <CategoryName>sample string 7</CategoryName>
    <Chilled>true</Chilled>
    <DateAvailable>2024-11-23T16:06:18.9699224+00:00</DateAvailable>
    <Description>sample string 11</Description>
    <Ethical>true</Ethical>
    <FairTrade>true</FairTrade>
    <Name>sample string 10</Name>
    <Organic>true</Organic>
    <OuterBarcode>sample string 12</OuterBarcode>
    <ParentCategoryID>8</ParentCategoryID>
    <ParentCategoryName>sample string 9</ParentCategoryName>
    <ProductID>36792dfe-f236-48e6-8cf9-0e66ccbdebc6</ProductID>
    <SKUCostPrice>14</SKUCostPrice>
    <SKUID>15</SKUID>
    <SKUName>sample string 16</SKUName>
    <SKUSellingPrice>17</SKUSellingPrice>
    <SKUSize>18</SKUSize>
    <Status>Importing</Status>
    <SupplierID>19</SupplierID>
    <SupplierName>sample string 20</SupplierName>
    <SupplierProductCode>sample string 21</SupplierProductCode>
    <TaxID>22</TaxID>
    <TaxRate>23.1</TaxRate>
    <Temperature>Any</Temperature>
    <UnitCostPrice>24</UnitCostPrice>
    <UnitSellingPrice>25</UnitSellingPrice>
    <ChildProducts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>a0bc9e29-3902-4792-85c0-cca51f826832</d3p1:guid>
      <d3p1:guid>5e3db2e9-b8d1-45c1-8468-eaf46b2b0162</d3p1:guid>
    </ChildProducts>
    <DateAdded>2024-11-23T16:06:18.9699224+00:00</DateAdded>
    <IsChildProduct>true</IsChildProduct>
    <IsMasterProduct>true</IsMasterProduct>
    <MasterProduct>10662ca5-4aa8-40e6-8542-f32a5de044b2</MasterProduct>
  </RelatedProductView>
</ArrayOfRelatedProductView>