GET api/ProductCatalogueView/GetProduct?Barcode={Barcode}&SupplierReference={SupplierReference}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Barcode | string |
Required |
|
SupplierReference | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ProductViewName | Description | Type | Additional information |
---|---|---|---|
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:
{ "Barcode": "sample string 1", "BrandID": 1, "BrandName": "sample string 2", "CategoryID": 3, "CategoryName": "sample string 4", "ParentCategoryID": 5, "ParentCategoryName": "sample string 6", "DateAvailable": "2024-11-23T16:03:16.0163487+00:00", "Ethical": true, "FairTrade": true, "Name": "sample string 7", "Description": "sample string 8", "Organic": true, "OuterBarcode": "sample string 9", "ProductID": "973f0d52-3ab6-4710-8164-e4fc8468bc4f", "SKUCostPrice": 11.0, "SKUID": 12, "SKUName": "sample string 13", "SKUSellingPrice": 14.0, "SKUSize": 15.0, "Status": 0, "SupplierID": 16, "SupplierName": "sample string 17", "SupplierProductCode": "sample string 18", "TaxID": 19, "TaxRate": 20.1, "UnitCostPrice": 21.0, "UnitSellingPrice": 22.0, "CatalogueID": 23, "Temperature": 0, "Chilled": true }
application/xml, text/xml
Sample:
<ProductView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fidelity.Fusion.Catalogue.Common.Models.TotalControlPremier"> <Barcode>sample string 1</Barcode> <BrandID>1</BrandID> <BrandName>sample string 2</BrandName> <CatalogueID>23</CatalogueID> <CategoryID>3</CategoryID> <CategoryName>sample string 4</CategoryName> <Chilled>true</Chilled> <DateAvailable>2024-11-23T16:03:16.0163487+00:00</DateAvailable> <Description>sample string 8</Description> <Ethical>true</Ethical> <FairTrade>true</FairTrade> <Name>sample string 7</Name> <Organic>true</Organic> <OuterBarcode>sample string 9</OuterBarcode> <ParentCategoryID>5</ParentCategoryID> <ParentCategoryName>sample string 6</ParentCategoryName> <ProductID>973f0d52-3ab6-4710-8164-e4fc8468bc4f</ProductID> <SKUCostPrice>11</SKUCostPrice> <SKUID>12</SKUID> <SKUName>sample string 13</SKUName> <SKUSellingPrice>14</SKUSellingPrice> <SKUSize>15</SKUSize> <Status>Importing</Status> <SupplierID>16</SupplierID> <SupplierName>sample string 17</SupplierName> <SupplierProductCode>sample string 18</SupplierProductCode> <TaxID>19</TaxID> <TaxRate>20.1</TaxRate> <Temperature>Any</Temperature> <UnitCostPrice>21</UnitCostPrice> <UnitSellingPrice>22</UnitSellingPrice> </ProductView>