Application Services

• v1/application/getapplicationsbyinternalentityreference

  This method returns a list of applications/products/entities for a given internal entity reference. This is the main method for getting all application details for a given selected vehicle.

• v2/application/getapplicationsbyinternalentityreference

  This method returns a list of applications/products/entities for a given internal entity reference. This is the main method for getting all application details for a given selected vehicle. It differs from v1 in allowing multiple 'productSearchRequest' filters.

• v3/application/getapplicationsbyinternalentityreference

  This version of the method includes improved application and product criteria as well as product tags

• v1/application/getapplicationsbyproductpartnumber

  This method returns a list of applications/products/entities for a given part number.

• v1/application/getapplicationsbyproductinternalreference

  This method returns a list of applications/products/entities for a given part number.

• v1/application/getapplicationsbyproductexternalreference

  This method returns a list of applications/products/entities for a given external reference. This needs to be configured within XChecker.

• v1/application/getapplicationsbyproductbarcode

  This method returns a list of applications/products/entities for a given barcode. This needs to be configured within XChecker.

• v1/application/getapplicationsbyproductsku

  This method returns a list of applications/products/entities for a given sku. This needs to be configured within XChecker.

• v1/application/getapplicationsbyproductcriteria

  This method returns a list of applications/products/entities for a given product primary entity, product type and list of criteria with values.

• v1/application/getbundlesbyinternalentityreference

  Under construction

---

getApplicationsByInternalEntityReference

Method URL

/v1/application/getapplicationsbyinternalentityreference

Type

POST

Consumes

application/json

Produces

application/json

Body Structure

public class applicationRequest
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long internalEntityReference { get; set; }
    public productSearchRequest searchProducts { get; set; } 

}

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; } 
    public string system { get; set; }
}

public class productSearchRequest
{
    public string partNumber { get; set; } = string.Empty;
    public string barcode { get; set; } = string.Empty;
    public string externalReference { get; set; } = string.Empty;
    public string sku { get; set; } = string.Empty;
    public string brand { get; set; } = string.Empty;
    public string crossReference { get; set; } = string.Empty;
    public long productReference { get; set; } = 0;
    public long productTypeReference { get; set; } = 0;
    public string searchOption { get; set; } = "exact";
}

Body Fields

Field	Optional	Description
baseRequest.requestReference	no	You must provide a unique string identifier for this request
baseRequest.requestPostedTime	no	Enter the time of the request
baseRequest.system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	The index reference that identifies the index to search
internalEntityReference	no	The internal entity reference to search on.
searchProducts
- partNumber
- barcode
- externalReference
- sku
- brand
- productReference
- productTypeReference	no	The product type reference to use. '0' for all.
- searchOption

Body Example

{
    "baseRequest":{
        "requestReference":123456,
        "requestPostedTime":"2012-04-23T18:25:43.511Z",
        "system":"ecat"
    },
    "indexReference": 1,
    "internalEntityReference": 8779,
    "productSearchRequest": {
        "partNumber": "",
        "barcode": "",
        "externalReference": "",
        "sku": "",
        "brand": "",
        "productReference": 0,
        "productTypeReference": 18,
        "searchOption": "exact"

    }
} 

Response Structure

public class applicationResponse
{
    public baseResponse baseResponse { get; set; } 
    public HashSet<application> applications { get; set; } 
    public HashSet<product> products { get; set; } 
    public HashSet<indexEntity> entities { get; set; } 
}

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

public class application
{
    public long applicationReference { get; set; }
    public long internalEntityReference { get; set; }
    public long productReference { get; set; }
    public string productBrand { get; set; }
    public bool productIsParent { get; set; }
    public DateTime from { get; set; }
    public DateTime to { get; set; }
    public long axSort { get; set; }
    public bool publishable { get; set; }
    public DateTime publishFrom { get; set; }
    public Dictionary<string, string> criteria { get; set; } 
}

public class product
{
    public long productReference { get; set; }
    public long categoryReference { get; set; }
    public string categoryName { get; set; }
    public long productTypeReference { get; set; }
    public string productTypeName { get; set; }
    public string partNumber { get; set; }
    public string externalReference { get; set; }
    public string barcode { get; set; }
    public string sku { get; set; }
    public string description { get; set; }
    public string status { get; set; }
    public Dictionary<string, bool> visibility { get; set; }
    public bool isKitOrAccessory { get; set; }
    public string kitOrAccessory { get; set; }
    public long quantity { get; set; }
    public string brand { get; set; }
    public bool isParent { get; set; }
    public bool isChild { get; set; }
    public bool isClone { get; set; }
    public long parentProductReference { get; set; }
    public HashSet<childProduct> childProducts { get; set; }
    public Dictionary<string, string> criteria { get; set; }
    public HashSet<kitItem> kitContents { get; set; }
    public HashSet<xReference> xReferences { get; set; }
    public HashSet<supercession> supercedes { get; set; }
    public HashSet<supercession> supercededBy { get; set; }
    public long sortOrder { get; set; }
}

public class childProduct
{
    public string brand { get; set; }
    public long productReference { get; set; }
    public string partNumber { get; set; }
    public string relationship { get; set; }
    public long parentProductReference { get; set; }
}

public class xReference
{
    public string xRef { get; set; }
    public string company { get; set; }
    public string price { get; set; }
    public string info { get; set; }
    public string xRefSearch { get; set; }
    public string xRefType { get; set; }
}

public class supercession
{
    public long categoryReference { get; set; }
    public long productTypeReference { get; set; }
    public string oldPartNumber { get; set; }
    public long oldProductFileReference { get; set; }
    public string newPartNumber { get; set; }
    public long newProductFileReference { get; set; }
    public bool searchedOnOldPartNumber { get; set; }
}

Application Response Example

{
    "baseResponse": {
        "baseRequest": {
            "requestReference": 123456,
            "requestPostedTime": "2012-04-23T18:25:43.511Z",
            "system": "ecat"
        },
        "responseTime": "00:00:00.1843821",
        "resultCode": 0,
        "resultText": "success"
    },
    "applications": [
        {
            "applicationReference": 1290000066503,
            "internalEntityReference": 8779,
            "productReference": 21913,
            "productBrand": "MyBrand",
            "productIsParent": false,
            "from": "2000-11-01T00:00:00",
            "to": "2004-12-01T00:00:00",
            "axSort": 1,
            "publishable": true,
            "publishFrom": "0001-01-01T00:00:00",
            "criteria": {}
        },
        {
            "applicationReference": 1290000066504,
            "internalEntityReference": 8779,
            "productReference": 58205,
            "productBrand": "MyBrand",
            "productIsParent": false,
            "from": "2000-11-01T00:00:00",
            "to": "2004-12-01T00:00:00",
            "axSort": 1,
            "publishable": true,
            "publishFrom": "0001-01-01T00:00:00",
            "criteria": {}
        }
    ],
    "products": [
        {
            "productReference": 21913,
            "categoryReference": 29,
            "categoryName": "Cabin Filters",
            "productTypeReference": 18,
            "productTypeName": "FILI",
            "partNumber": "FILTER1",
            "description": "Filter, interior air",
            "status": "Yes",
            "visibility": {
                "automate": true,
                "ecat": true
            },
            "isKitOrAccessory": false,
            "kitOrAccessory": null,
            "quantity": 1,
            "brand": "MyBrand",
            "isParent": false,
            "isChild": false,
            "isClone": false,
            "parentProductReference": 0,
            "childProducts": [],
            "criteria": {
                "Length (mm)": "300",
                "Height (mm)": "30",
                "Width (mm)": "204",
                "Filter Type": "Activated Carbon Filter",
                "MOQ customer": "5",
                "MAM Prodcode": "CBNF",
                "MAM Section": "Filters & Ignition",
                "Zolltarifnummer": "123465798",
                "EAN Barcode 1 piece": "123465798",
                "XC_Country of Origin": "",
                "Indication Reman Part": "New",
                "Net Weight (g)": "366",
                "Length Incl Packaging (mm)": "304",
                "Width Incl Packaging (mm)": "210",
                "Height Incl Packaging (mm)": "33",
                "Type of Packing": "Carton box",
                "Packing Weight (g)": "71",
                "Tecdoc ID": "0066",
                "Alternative Partnumber": "-",
                "Supersession Partnumber": "-",
                "OE Number_P": "4 B0 819 439 C",
                "Packaging Units": "1",
                "Partnumber 12 Digit": "123465798",
                "Brand": "MyBrand"
            },
            "kitContents": [],
            "xReferences": [],
            "supercedes": [],
            "supercededBy": [],
            "sortOrder": 1
        },
        {
            "productReference": 58205,
            "categoryReference": 29,
            "categoryName": "Cabin Filters",
            "productTypeReference": 18,
            "productTypeName": "FILI",
            "partNumber": "FILTER1",
            "description": "Filter, interior air",
            "status": "Yes",
            "visibility": {
                "automate": true,
                "ecat": true
            },
            "isKitOrAccessory": false,
            "kitOrAccessory": null,
            "quantity": 1,
            "brand": "MyBrand",
            "isParent": false,
            "isChild": false,
            "isClone": false,
            "parentProductReference": 0,
            "childProducts": [],
            "criteria": {
                "Length (mm)": "297",
                "Height (mm)": "31",
                "Width (mm)": "205",
                "Filter Type": "Particle Filter",
                "MOQ customer": "5",
                "MAM Prodcode": "CBNF",
                "MAM Section": "Filters & Ignition",
                "Zolltarifnummer": "123465798",
                "EAN Barcode 1 piece": "123465798",
                "XC_Country of Origin": "",
                "Indication Reman Part": "New",
                "Net Weight (g)": "120",
                "Length Incl Packaging (mm)": "310",
                "Width Incl Packaging (mm)": "210",
                "Height Incl Packaging (mm)": "35",
                "Type of Packing": "Carton box",
                "Packing Weight (g)": "1352",
                "Tecdoc ID": "0066",
                "Alternative Partnumber": "-",
                "Supersession Partnumber": "123465798",
                "OE Number_P": "8E0819439",
                "Packaging Units": "1",
                "Partnumber 12 Digit": "123465798",
                "Brand": "MyBrand"
            },
            "kitContents": [],
            "xReferences": [],
            "supercedes": [],
            "supercededBy": [],
            "sortOrder": 1
        }
    ],
    "entities": [
        {
            "indexReference ": 1,
            "provider": "TecDoc",
            "internalReference": 8779,
            "externalReference": "15510",
            "attributes": {
                "make": "AUDI",
                "model": "A4 (8E, B6) (00-04)",
                "enginesize": "3.0",
                "datefrom": "11/2000 -> 12/2004",
                "enginecode": "ASN; AVK",
                "submodel": "A4",
                "vehicletype": "TecDoc PC",
                "originalmodel": "A4 (8E2, B6)",
                "vehicleid": "15510",
                "mark": "3.0 quattro",
                "kw": "162",
                "ps": "220",
                "dateto": "12/2004",
                "enginenumberofcylinders": "6",
                "drivetype": "All-wheel Drive",
                "braketype": null,
                "brakesystem": null,
                "fueltype": "Petrol",
                "enginetype": "Petrol Engine",
                "fuelmix": "Intake Manifold Injection/ Carburettor",
                "catalyticconvertertype": "with 3 way catalyst",
                "transmissiontype": null,
                "bodytype": "Saloon",
                "exactenginesize": "2976",
                "enginenumberofvalves": "5",
                "modelgeneration": null,
                "typedesc": null,
                "note": null,
                "exclude": "0",
                "door": null,
                "fuelcap": null,
                "mainv": null,
                "abs": null,
                "asr": null,
                "parc": "3755",
                "kmodnr": "4731",
                "kbanr": "0588750",
                "parc(uk)": "912",
                "parc(ger)": "1024",
                "parc(aut)": null,
                "parc(ch)": "766",
                "parc(rus)": ""
            }
        }
    ]
}

---

getApplicationsByProductPartNumber

Method URL

/v1/application/getapplicationsbyproductpartnumber

Type

POST

Consumes

application/json

Produces

application/json

Body Fields

Field	Optional	Description
requestReference	no	You must provide a unique string identifier for this request
requestPostedTime	no	Enter the time of the request
system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	The index reference that identifies the index to search
internalEntityReference
searchProducts
- partNumber	no	full or partial part number or empty string
- barcode
- externalReference
- sku
- brand	yes	full brand name or empty string
- productReference
- productTypeReference	yes	The product type reference or '0'
- searchOption	no	one of "exact" or "startswith" or "contains"

Body Structure

public class applicationRequest
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long internalEntityReference { get; set; }
    public productSearchRequest searchProducts { get; set; } 

}

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; } 
    public string system { get; set; }
}

public class productSearchRequest
{
    public string partNumber { get; set; } = string.Empty;
    public string barcode { get; set; } = string.Empty;
    public string externalReference { get; set; } = string.Empty;
    public string sku { get; set; } = string.Empty;
    public string brand { get; set; } = string.Empty;
    public string crossReference { get; set; } = string.Empty;
    public long productReference { get; set; } = 0;
    public long productTypeReference { get; set; } = 0;
    public string searchOption { get; set; } = "exact";
}

Body Example

{
    "baseRequest":{
        "requestReference":123456,
        "requestPostedTime":"2012-04-23T18:25:43.511Z",
        "system":"ecat"
    },
    "indexReference": 1,
    "internalEntityReference": 8779,
    "productSearchRequest": {
        "partNumber": "LAMBDA1",
        "barcode": "",
"externalReference": "",
        "sku": "",
        "brand": "",
        "productReference": 0,
        "productTypeReference": 0,
        "searchOption": "exact"

    }
} 

Response Structure

public class applicationResponse
{
    public baseResponse baseResponse { get; set; } 
    public HashSet<application> applications { get; set; } 
    public HashSet<product> products { get; set; } 
    public HashSet<indexEntity> entities { get; set; } 
}

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

public class application
{
    public long applicationReference { get; set; }
    public long internalEntityReference { get; set; }
    public long productReference { get; set; }
    public string productBrand { get; set; }
    public bool productIsParent { get; set; }
    public DateTime from { get; set; }
    public DateTime to { get; set; }
    public long axSort { get; set; }
    public bool publishable { get; set; }
    public DateTime publishFrom { get; set; }
    public Dictionary<string, string> criteria { get; set; } 
}

public class product
{
    public long productReference { get; set; }
    public long categoryReference { get; set; }
    public string categoryName { get; set; }
    public long productTypeReference { get; set; }
    public string productTypeName { get; set; }
    public string partNumber { get; set; }
    public string externalReference { get; set; }
    public string barcode { get; set; }
    public string sku { get; set; }
    public string description { get; set; }
    public string status { get; set; }
    public Dictionary<string, bool> visibility { get; set; }
    public bool isKitOrAccessory { get; set; }
    public string kitOrAccessory { get; set; }
    public long quantity { get; set; }
    public string brand { get; set; }
    public bool isParent { get; set; }
    public bool isChild { get; set; }
    public bool isClone { get; set; }
    public long parentProductReference { get; set; }
    public HashSet<childProduct> childProducts { get; set; }
    public Dictionary<string, string> criteria { get; set; }
    public HashSet<kitItem> kitContents { get; set; }
    public HashSet<xReference> xReferences { get; set; }
    public HashSet<supercession> supercedes { get; set; }
    public HashSet<supercession> supercededBy { get; set; }
    public long sortOrder { get; set; }
}

public class childProduct
{
    public string brand { get; set; }
    public long productReference { get; set; }
    public string partNumber { get; set; }
    public string relationship { get; set; }
    public long parentProductReference { get; set; }
}

public class xReference
{
    public string xRef { get; set; }
    public string company { get; set; }
    public string price { get; set; }
    public string info { get; set; }
    public string xRefSearch { get; set; }
    public string xRefType { get; set; }
}

public class supercession
{
    public long categoryReference { get; set; }
    public long productTypeReference { get; set; }
    public string oldPartNumber { get; set; }
    public long oldProductFileReference { get; set; }
    public string newPartNumber { get; set; }
    public long newProductFileReference { get; set; }
    public bool searchedOnOldPartNumber { get; set; }
}

Response Example

See Application Response Example

---

getApplicationsByProductInternalReference

Method URL

/v1/application/getapplicationsbyproductinternalreference

Type

POST

Consumes

application/json

Produces

application/json

Body Fields

Field	Optional	Description
requestReference	no	You must provide a unique string identifier for this request
requestPostedTime	no	Enter the time of the request
system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	The index reference that identifies the index to search
internalEntityReference
searchProducts
- partNumber
- barcode
- externalReference
- sku
- brand	yes	full brand name or empty string
- productReference	no	Required
- productTypeReference	yes	The product type reference or '0'
- searchOption	no	one of "exact" or "startswith" or "contains"

Body Structure

public class applicationRequest
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long internalEntityReference { get; set; }
    public productSearchRequest searchProducts { get; set; } 

}

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; } 
    public string system { get; set; }
}

public class productSearchRequest
{
    public string partNumber { get; set; } = string.Empty;
    public string barcode { get; set; } = string.Empty;
    public string externalReference { get; set; } = string.Empty;
    public string sku { get; set; } = string.Empty;
    public string brand { get; set; } = string.Empty;
    public string crossReference { get; set; } = string.Empty;
    public long productReference { get; set; } = 0;
    public long productTypeReference { get; set; } = 0;
    public string searchOption { get; set; } = "exact";
}

Body Example

{
    "baseRequest":{
        "requestReference":123456,
        "requestPostedTime":"2012-04-23T18:25:43.511Z",
        "system":"ecat"
    },
    "indexReference": 1,
    "internalEntityReference": 8779,
    "productSearchRequest": {
        "partNumber": "",
        "barcode": "",
"externalReference": "",
        "sku": "",
        "brand": "",
        "productReference": 11230,
        "productTypeReference": 0,
        "searchOption": "exact"

    }
} 

Response Structure

public class applicationResponse
{
    public baseResponse baseResponse { get; set; } 
    public HashSet<application> applications { get; set; } 
    public HashSet<product> products { get; set; } 
    public HashSet<indexEntity> entities { get; set; } 
}

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

public class application
{
    public long applicationReference { get; set; }
    public long internalEntityReference { get; set; }
    public long productReference { get; set; }
    public string productBrand { get; set; }
    public bool productIsParent { get; set; }
    public DateTime from { get; set; }
    public DateTime to { get; set; }
    public long axSort { get; set; }
    public bool publishable { get; set; }
    public DateTime publishFrom { get; set; }
    public Dictionary<string, string> criteria { get; set; } 
}

public class product
{
    public long productReference { get; set; }
    public long categoryReference { get; set; }
    public string categoryName { get; set; }
    public long productTypeReference { get; set; }
    public string productTypeName { get; set; }
    public string partNumber { get; set; }
    public string externalReference { get; set; }
    public string barcode { get; set; }
    public string sku { get; set; }
    public string description { get; set; }
    public string status { get; set; }
    public Dictionary<string, bool> visibility { get; set; }
    public bool isKitOrAccessory { get; set; }
    public string kitOrAccessory { get; set; }
    public long quantity { get; set; }
    public string brand { get; set; }
    public bool isParent { get; set; }
    public bool isChild { get; set; }
    public bool isClone { get; set; }
    public long parentProductReference { get; set; }
    public HashSet<childProduct> childProducts { get; set; }
    public Dictionary<string, string> criteria { get; set; }
    public HashSet<kitItem> kitContents { get; set; }
    public HashSet<xReference> xReferences { get; set; }
    public HashSet<supercession> supercedes { get; set; }
    public HashSet<supercession> supercededBy { get; set; }
    public long sortOrder { get; set; }
}

public class childProduct
{
    public string brand { get; set; }
    public long productReference { get; set; }
    public string partNumber { get; set; }
    public string relationship { get; set; }
    public long parentProductReference { get; set; }
}

public class xReference
{
    public string xRef { get; set; }
    public string company { get; set; }
    public string price { get; set; }
    public string info { get; set; }
    public string xRefSearch { get; set; }
    public string xRefType { get; set; }
}

public class supercession
{
    public long categoryReference { get; set; }
    public long productTypeReference { get; set; }
    public string oldPartNumber { get; set; }
    public long oldProductFileReference { get; set; }
    public string newPartNumber { get; set; }
    public long newProductFileReference { get; set; }
    public bool searchedOnOldPartNumber { get; set; }
}

Response Example

See Application Response Example

---

getApplicationsByProductExternalReference

Method URL

/v1/application/getapplicationsbyproductexternalreference

Type

POST

Consumes

application/json

Produces

application/json

Body Fields

Field	Optional	Description
requestReference	no	You must provide a unique string identifier for this request
requestPostedTime	no	Enter the time of the request
system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	The index reference that identifies the index to search
internalEntityReference
searchProducts
- partNumber
- barcode
- externalReference	Required
- sku
- brand	yes	full brand name or empty string
- productReference
- productTypeReference	yes	The product type reference or '0'
- searchOption	no	one of "exact" or "startswith" or "contains"

Body Structure

public class applicationRequest
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long internalEntityReference { get; set; }
    public productSearchRequest searchProducts { get; set; } 

}

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; } 
    public string system { get; set; }
}

public class productSearchRequest
{
    public string partNumber { get; set; } = string.Empty;
    public string barcode { get; set; } = string.Empty;
    public string externalReference { get; set; } = string.Empty;
    public string sku { get; set; } = string.Empty;
    public string brand { get; set; } = string.Empty;
    public string crossReference { get; set; } = string.Empty;
    public long productReference { get; set; } = 0;
    public long productTypeReference { get; set; } = 0;
    public string searchOption { get; set; } = "exact";
}

Body Example

{
    "baseRequest":{
        "requestReference":123456,
        "requestPostedTime":"2012-04-23T18:25:43.511Z",
        "system":"ecat"
    },
    "indexReference": 1,
    "internalEntityReference": 8779,
    "productSearchRequest": {
        "partNumber": "",
        "barcode": "",
"externalReference": "E12345",
        "sku": "",
        "brand": "",
        "productReference": 0,
        "productTypeReference": 0,
        "searchOption": "exact"

    }
} 

Response Structure

public class applicationResponse
{
    public baseResponse baseResponse { get; set; } 
    public HashSet<application> applications { get; set; } 
    public HashSet<product> products { get; set; } 
    public HashSet<indexEntity> entities { get; set; } 
}

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

public class application
{
    public long applicationReference { get; set; }
    public long internalEntityReference { get; set; }
    public long productReference { get; set; }
    public string productBrand { get; set; }
    public bool productIsParent { get; set; }
    public DateTime from { get; set; }
    public DateTime to { get; set; }
    public long axSort { get; set; }
    public bool publishable { get; set; }
    public DateTime publishFrom { get; set; }
    public Dictionary<string, string> criteria { get; set; } 
}

public class product
{
    public long productReference { get; set; }
    public long categoryReference { get; set; }
    public string categoryName { get; set; }
    public long productTypeReference { get; set; }
    public string productTypeName { get; set; }
    public string partNumber { get; set; }
    public string externalReference { get; set; }
    public string barcode { get; set; }
    public string sku { get; set; }
    public string description { get; set; }
    public string status { get; set; }
    public Dictionary<string, bool> visibility { get; set; }
    public bool isKitOrAccessory { get; set; }
    public string kitOrAccessory { get; set; }
    public long quantity { get; set; }
    public string brand { get; set; }
    public bool isParent { get; set; }
    public bool isChild { get; set; }
    public bool isClone { get; set; }
    public long parentProductReference { get; set; }
    public HashSet<childProduct> childProducts { get; set; }
    public Dictionary<string, string> criteria { get; set; }
    public HashSet<kitItem> kitContents { get; set; }
    public HashSet<xReference> xReferences { get; set; }
    public HashSet<supercession> supercedes { get; set; }
    public HashSet<supercession> supercededBy { get; set; }
    public long sortOrder { get; set; }
}

public class childProduct
{
    public string brand { get; set; }
    public long productReference { get; set; }
    public string partNumber { get; set; }
    public string relationship { get; set; }
    public long parentProductReference { get; set; }
}

public class xReference
{
    public string xRef { get; set; }
    public string company { get; set; }
    public string price { get; set; }
    public string info { get; set; }
    public string xRefSearch { get; set; }
    public string xRefType { get; set; }
}

public class supercession
{
    public long categoryReference { get; set; }
    public long productTypeReference { get; set; }
    public string oldPartNumber { get; set; }
    public long oldProductFileReference { get; set; }
    public string newPartNumber { get; set; }
    public long newProductFileReference { get; set; }
    public bool searchedOnOldPartNumber { get; set; }
}

Response Example

See Application Response Example

---

getApplicationsByProductBarcode

Method URL

/v1/application/getapplicationsbyproductbarcode

Type

POST

Consumes

application/json

Produces

application/json

Body Fields

Field	Optional	Description
requestReference	no	You must provide a unique string identifier for this request
requestPostedTime	no	Enter the time of the request
system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	The index reference that identifies the index to search
internalEntityReference
- partNumber
- barcode	yes	full or partial barcode or empty string
- externalReference
- sku
- brand	yes	full brand name or empty string
- productReference
- productTypeReference	yes	The product type reference or '0'
- searchOption	no	one of "exact" or "startswith" or "contains"

Body Structure

public class applicationRequest
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long internalEntityReference { get; set; }
    public productSearchRequest searchProducts { get; set; } 

}

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; } 
    public string system { get; set; }
}

public class productSearchRequest
{
    public string partNumber { get; set; } = string.Empty;
    public string barcode { get; set; } = string.Empty;
    public string externalReference { get; set; } = string.Empty;
    public string sku { get; set; } = string.Empty;
    public string brand { get; set; } = string.Empty;
    public string crossReference { get; set; } = string.Empty;
    public long productReference { get; set; } = 0;
    public long productTypeReference { get; set; } = 0;
    public string searchOption { get; set; } = "exact";
}

Body Example

{
    "baseRequest":{
        "requestReference":123456,
        "requestPostedTime":"2012-04-23T18:25:43.511Z",
        "system":"ecat"
    },
    "indexReference": 1,
    "internalEntityReference": 8779,
    "productSearchRequest": {
        "partNumber": "",
        "barcode": "AABBCC",
"externalReference": "",
        "sku": "",
        "brand": "",
        "productReference": 0,
        "productTypeReference": 0,
        "searchOption": "exact"

    }
}

Response Structure

public class applicationResponse
{
    public baseResponse baseResponse { get; set; } 
    public HashSet<application> applications { get; set; } 
    public HashSet<product> products { get; set; } 
    public HashSet<indexEntity> entities { get; set; } 
}

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

public class application
{
    public long applicationReference { get; set; }
    public long internalEntityReference { get; set; }
    public long productReference { get; set; }
    public string productBrand { get; set; }
    public bool productIsParent { get; set; }
    public DateTime from { get; set; }
    public DateTime to { get; set; }
    public long axSort { get; set; }
    public bool publishable { get; set; }
    public DateTime publishFrom { get; set; }
    public Dictionary<string, string> criteria { get; set; } 
}

public class product
{
    public long productReference { get; set; }
    public long categoryReference { get; set; }
    public string categoryName { get; set; }
    public long productTypeReference { get; set; }
    public string productTypeName { get; set; }
    public string partNumber { get; set; }
    public string externalReference { get; set; }
    public string barcode { get; set; }
    public string sku { get; set; }
    public string description { get; set; }
    public string status { get; set; }
    public Dictionary<string, bool> visibility { get; set; }
    public bool isKitOrAccessory { get; set; }
    public string kitOrAccessory { get; set; }
    public long quantity { get; set; }
    public string brand { get; set; }
    public bool isParent { get; set; }
    public bool isChild { get; set; }
    public bool isClone { get; set; }
    public long parentProductReference { get; set; }
    public HashSet<childProduct> childProducts { get; set; }
    public Dictionary<string, string> criteria { get; set; }
    public HashSet<kitItem> kitContents { get; set; }
    public HashSet<xReference> xReferences { get; set; }
    public HashSet<supercession> supercedes { get; set; }
    public HashSet<supercession> supercededBy { get; set; }
    public long sortOrder { get; set; }
}

public class childProduct
{
    public string brand { get; set; }
    public long productReference { get; set; }
    public string partNumber { get; set; }
    public string relationship { get; set; }
    public long parentProductReference { get; set; }
}

public class xReference
{
    public string xRef { get; set; }
    public string company { get; set; }
    public string price { get; set; }
    public string info { get; set; }
    public string xRefSearch { get; set; }
    public string xRefType { get; set; }
}

public class supercession
{
    public long categoryReference { get; set; }
    public long productTypeReference { get; set; }
    public string oldPartNumber { get; set; }
    public long oldProductFileReference { get; set; }
    public string newPartNumber { get; set; }
    public long newProductFileReference { get; set; }
    public bool searchedOnOldPartNumber { get; set; }
}

Response Example

See Application Response Example

---

getApplicationsByProductSku

Method URL

/v1/application/getapplicationsbyproductsku

Type

POST

Consumes

application/json

Produces

application/json

Body Fields

Field	Optional	Description
requestReference	no	You must provide a unique string identifier for this request
requestPostedTime	no	Enter the time of the request
system	no	"ecat" must be used to correctly filter allowable products
indexReference	no	The index reference that identifies the index to search
internalEntityReference
searchProducts
- partNumber
- barcode
- externalReference
- sku	Required
- brand	yes	full brand name or empty string
- productReference
- productTypeReference	yes	The product type reference or '0'
- searchOption	no	one of "exact" or "startswith" or "contains"

Body Structure

public class applicationRequest
{
    public baseRequest baseRequest { get; set; }
    public long indexReference { get; set; }
    public long internalEntityReference { get; set; }
    public productSearchRequest searchProducts { get; set; } 

}

public class baseRequest
{
    public long requestReference { get; set; }
    public DateTime requestPostedTime { get; set; } 
    public string system { get; set; }
}

public class productSearchRequest
{
    public string partNumber { get; set; } = string.Empty;
    public string barcode { get; set; } = string.Empty;
    public string externalReference { get; set; } = string.Empty;
    public string sku { get; set; } = string.Empty;
    public string brand { get; set; } = string.Empty;
    public string crossReference { get; set; } = string.Empty;
    public long productReference { get; set; } = 0;
    public long productTypeReference { get; set; } = 0;
    public string searchOption { get; set; } = "exact";
}

Body Example

{
    "baseRequest":{
        "requestReference":123456,
        "requestPostedTime":"2012-04-23T18:25:43.511Z",
        "system":"ecat"
    },
    "indexReference": 1,
    "internalEntityReference": 8779,
    "productSearchRequest": {
        "partNumber": "",
        "barcode": "",
"externalReference": "",
        "sku": "ABC12345",
        "brand": "",
        "productReference": 0,
        "productTypeReference": 0,
        "searchOption": "exact"

    }
}

Response Structure

public class applicationResponse
{
    public baseResponse baseResponse { get; set; } 
    public HashSet<application> applications { get; set; } 
    public HashSet<product> products { get; set; } 
    public HashSet<indexEntity> entities { get; set; } 
}

public class baseResponse
{
    public baseRequest baseRequest { get; set; }
    public TimeSpan responseTime { get; set; }
    public long resultCode { get; set; }
    public string resultText { get; set; }
}

public class application
{
    public long applicationReference { get; set; }
    public long internalEntityReference { get; set; }
    public long productReference { get; set; }
    public string productBrand { get; set; }
    public bool productIsParent { get; set; }
    public DateTime from { get; set; }
    public DateTime to { get; set; }
    public long axSort { get; set; }
    public bool publishable { get; set; }
    public DateTime publishFrom { get; set; }
    public Dictionary<string, string> criteria { get; set; } 
}

public class product
{
    public long productReference { get; set; }
    public long categoryReference { get; set; }
    public string categoryName { get; set; }
    public long productTypeReference { get; set; }
    public string productTypeName { get; set; }
    public string partNumber { get; set; }
    public string externalReference { get; set; }
    public string barcode { get; set; }
    public string sku { get; set; }
    public string description { get; set; }
    public string status { get; set; }
    public Dictionary<string, bool> visibility { get; set; }
    public bool isKitOrAccessory { get; set; }
    public string kitOrAccessory { get; set; }
    public long quantity { get; set; }
    public string brand { get; set; }
    public bool isParent { get; set; }
    public bool isChild { get; set; }
    public bool isClone { get; set; }
    public long parentProductReference { get; set; }
    public HashSet<childProduct> childProducts { get; set; }
    public Dictionary<string, string> criteria { get; set; }
    public HashSet<kitItem> kitContents { get; set; }
    public HashSet<xReference> xReferences { get; set; }
    public HashSet<supercession> supercedes { get; set; }
    public HashSet<supercession> supercededBy { get; set; }
    public long sortOrder { get; set; }
}

public class childProduct
{
    public string brand { get; set; }
    public long productReference { get; set; }
    public string partNumber { get; set; }
    public string relationship { get; set; }
    public long parentProductReference { get; set; }
}

public class xReference
{
    public string xRef { get; set; }
    public string company { get; set; }
    public string price { get; set; }
    public string info { get; set; }
    public string xRefSearch { get; set; }
    public string xRefType { get; set; }
}

public class supercession
{
    public long categoryReference { get; set; }
    public long productTypeReference { get; set; }
    public string oldPartNumber { get; set; }
    public long oldProductFileReference { get; set; }
    public string newPartNumber { get; set; }
    public long newProductFileReference { get; set; }
    public bool searchedOnOldPartNumber { get; set; }
}

Response Example

See Application Response Example