Models
The Models resource is used to retrieve an existing model record from EPASS. Examples of a model would be a stove or a dishwasher.
Categories:
Tip
To add a model to an invoice, use the /invoicing/invoice/model/add endpoint.Model Table Fields
ViewRetrieve a Model Record
GET /models/model
This endpoint returns the attributes of a specific model.
Parameters
| Name | Description |
|---|---|
ModelCode |
Required. The model code. In EPASS, this is entered in the MODEL field of a model’s record and has a maximum of 20 characters. |
Sample: Retrieving a model record
GET /models/model?ModelCode=4KSB5WH
{
"Result": {
"Success": true,
"Warning": false,
"HttpStatusCode": 0,
"GeneralMessage": "Returned 1 record",
"ExceptionMessage": null,
"Keys": [],
"Messages": [],
"Warnings": []
},
"Values": [
{
"Fields": {
"ID": 24,
"MfgBarcode": "66",
"UPCBarcode": "44",
"RootModelCode": "4KSB5WH",
"PackageCode": "",
"Link": "TEST",
"Identifier": "7Y9Q",
"BarcodeSchema": "",
"AllowSpecialOrder": false,
"UpdateImportPricing": true,
"WarrantyTypeCode": "ALL",
"AllowPackageWty": true,
"ShippingMethodCode": "",
"Volume": 0.0,
"UnloadTime": 0.0,
"AutoNumber": false,
"ShipAnySerial": false,
"SalePrice": 0.0,
"SaleStartDate": null,
"SaleEndDate": null,
"Feature1": "",
"Feature2": "",
"Feature3": "",
"Feature4": "",
"Feature5": "",
"Feature6": "",
"Feature7": "",
"Feature8": "",
"Feature9": "",
"Feature10": "",
"Dimension1": "",
"Dimension2": "",
"Warranty1": "",
"Warranty2": "",
"PTDesc": "",
"InstallationEstimate": 0.0,
"UpdateImportCost": true,
"Dimension3": "",
"Misc2Code": "",
"Misc3Code": "",
"Misc4Code": "",
"Misc5Code": "",
"MiscPrompt": false,
"Misc2Prompt": false,
"Misc3Prompt": false,
"Misc4Prompt": false,
"Misc5Prompt": false,
"ExtWarrantyPrompt": false,
"ExtWarranty2Prompt": false,
"ExtWarranty3Prompt": false,
"ExtWarranty4Prompt": false,
"ExtWarranty5Prompt": false,
"ExtWarranty2Code": "",
"ExtWarranty3Code": "",
"ExtWarranty4Code": "",
"ExtWarranty5Code": "",
"Item1Prompt": false,
"Item2Prompt": false,
"Item3Prompt": false,
"Item4Prompt": false,
"Item5Prompt": false,
"Item1Code": "",
"Item2Code": "",
"Item3Code": "",
"Item4Code": "",
"Item5Code": "",
"Model1Prompt": false,
"Model2Prompt": false,
"Model3Prompt": false,
"Model4Prompt": false,
"Model5Prompt": false,
"Model1Code": "",
"Model2Code": "",
"Model3Code": "",
"Model4Code": "",
"Model5Code": "",
"ImmediateReservedDays": 0,
"Spiff2": 0.0,
"Spiff2EndDate": null,
"Spiff2StartDate": null,
"CommentPrompt": false,
"Comment2Prompt": false,
"Comment3Prompt": false,
"Comment4Prompt": false,
"Comment5Prompt": false,
"Comment2Code": "",
"Comment3Code": "",
"Comment4Code": "",
"Comment5Code": "",
"Discount1": 0.0,
"Discount2": 0.0,
"Discount3": 0.0,
"Discount4": 0.0,
"Discount5": 0.0,
"Discount6": 0.0,
"Discount7": 0.0,
"Discount8": 0.0,
"Discount9": 0.0,
"Discount10": 0.0,
"NotUMRP": false,
"Flooring": false,
"MasterPackQty": 1,
"ABCRating": "",
"ActualSpiff": 0.0,
"SalePrice2": 0.0,
"SaleStartDate2": null,
"SaleEndDate2": null,
"Weight": 0.0,
"LinqProductId": "",
"BeingDiscontinued": false,
"FeaturesCode": "",
"Active": true,
"AverageCost": 307.49,
"Barcode": "55",
"BeginYearQty": 33,
"BinLocationCode": "",
"BrandCode": "GEH",
"Code": "4KSB5WH",
"Color": "White",
"CommentCode": "",
"DateCreated": null,
"DateModified": "2004-03-01T00:00:00",
"Description": "5 Speed Blender",
"EOQ": 0,
"Equivalent": "",
"ExtWarrantyCode": "",
"Field1": "ddd",
"Field2": "",
"Field3": "",
"Field4": "",
"Field5": "",
"InventoryTypeCode": "",
"LandedCost": 0.0,
"LandingFactor": 0.0,
"LastCost": 110.49,
"LastDateOrdered": "2011-09-15T00:00:00",
"LastDateReceived": "2007-03-22T00:00:00",
"LastDateSold": "2006-05-01T00:00:00",
"ListPrice": 479.99,
"LocQOH": 9,
"LocYTD": 9,
"MainStockQOH": 7,
"MainStockYTD": 34,
"ManufacturersWarranty": 0,
"MfgReturned": 0,
"MiscCode": "",
"NewUsed": "New",
"Note": "",
"Obsolete": false,
"OriginalCost": 398.25,
"PicturePath": "",
"Points": 0.0,
"PriceTag": "",
"ProductCode": "ACC",
"ReplacementCost": 401.0,
"ReplacementCostEffectiveDate": null,
"ResizePicture": true,
"SKU": "",
"Spiff": 0.0,
"SpiffEndDate": null,
"SpiffStartDate": null,
"StandardCost": 403.0,
"Stock": true,
"Substituted": false,
"SupplierCode": "KEY",
"Tax1": false,
"Tax1CostList": "Cost",
"Tax1Included": false,
"Tax1Percentage": 0.0,
"Tax2": false,
"Tax3": false,
"TotalBooked": 19,
"TotalLastYear": 0,
"TotalMax": 0,
"TotalMin": 0,
"TotalNotAvailable": 0,
"TotalPrevLastYear": 0,
"TotalQOO": 10,
"TotalReserved": 28,
"UserCreated": "",
"UserModified": "z"
}
}
]
}
Model not found.
Search for a Model
POST /models/search
This endpoint searches and returns the attributes of a model. You can search for a model by any of its attributes.
Note
See Searching, Paging, and Extended Info for instructions on building search queries.Sample: Searching for a Model
POST /models/search {
"query": {
"fieldName": "Code",
"eval": "EQUAL",
"value": "1901A"
}
}
POST /models/search {
"query": {
"fieldName": "Code123",
"eval": "EQUAL",
"value": "123"
},
"subquery":[
{
"logic": "AND",
"query": {
"fieldName": "CITY",
"eval": "IN",
"value": "a@b.com",
"valueList": ["vancouver", "burnaby", "richmond"]
}
},
{
"logic": "OR",
"query": {
"fieldName": "PHONE",
"eval":"EQUAL",
"value": "a@b.com"
}
}
]
}
POST /models/search {
"query": {
"fieldName": "Code",
"eval": "EQUAL",
"value": "4KSB5WH"
},
"tables": {},
"extendedInfo": {
"ModelListPrice": [ "ID",
"ProjectCost",
"ListPrice",
"ListPriceCode",
"ListPriceSequence",
"ModelCode"
],
"Serial": ["Code",
"LocationCode",
"Status"]
}
}
{
"Results": {
"Success": true,
"Warning": false,
"HttpStatusCode": 200,
"GeneralMessage": "Returned 1 records",
"ExceptionMessage": null,
"Keys": [],
"Messages": [],
"Warnings": []
},
"Paging": {
"PageSize": 100,
"LargestID": 0,
"PagesRemaining": false
},
"Query": {
"fieldName": "CODE",
"eval": "EQUAL",
"value": "1901A",
"valueList": null,
"start": null,
"end": null
},
"SubQuery": [],
"Model": [
{
"Fields": {
"ID": 14837,
"MfgBarcode": "",
"UPCBarcode": "883049267951",
"RootModelCode": "1901A",
"PackageCode": "",
"Link": "",
"Identifier": "74SP",
"BarcodeSchema": "",
"AllowSpecialOrder": true,
"UpdateImportPricing": true,
"WarrantyTypeCode": "ALL",
"AllowPackageWty": true,
"ShippingMethodCode": "",
"Volume": 0.0,
"UnloadTime": 0.0,
"AutoNumber": true,
"ShipAnySerial": true,
"SalePrice": 0.0,
"SaleStartDate": null,
"SaleEndDate": null,
"Feature1": "",
"Feature2": "",
"Feature3": "",
"Feature4": "",
"Feature5": "",
"Feature6": "",
"Feature7": "",
"Feature8": "",
"Feature9": "",
"Feature10": "",
"Dimension1": "",
"Dimension2": "",
"Warranty1": "",
"Warranty2": "",
"PTDesc": "ICEMAKER WATER PUMP",
"InstallationEstimate": 0.0,
"UpdateImportCost": true,
"Dimension3": "",
"Misc2Code": "",
"Misc3Code": "",
"Misc4Code": "",
"Misc5Code": "",
"MiscPrompt": false,
"Misc2Prompt": false,
"Misc3Prompt": false,
"Misc4Prompt": false,
"Misc5Prompt": false,
"ExtWarrantyPrompt": false,
"ExtWarranty2Prompt": false,
"ExtWarranty3Prompt": false,
"ExtWarranty4Prompt": false,
"ExtWarranty5Prompt": false,
"ExtWarranty2Code": "",
"ExtWarranty3Code": "",
"ExtWarranty4Code": "",
"ExtWarranty5Code": "",
"Item1Prompt": false,
"Item2Prompt": false,
"Item3Prompt": false,
"Item4Prompt": false,
"Item5Prompt": false,
"Item1Code": "",
"Item2Code": "",
"Item3Code": "",
"Item4Code": "",
"Item5Code": "",
"Model1Prompt": false,
"Model2Prompt": false,
"Model3Prompt": false,
"Model4Prompt": false,
"Model5Prompt": false,
"Model1Code": "",
"Model2Code": "",
"Model3Code": "",
"Model4Code": "",
"Model5Code": "",
"ImmediateReservedDays": 0,
"Spiff2": 0.0,
"Spiff2EndDate": null,
"Spiff2StartDate": null,
"CommentPrompt": false,
"Comment2Prompt": false,
"Comment3Prompt": false,
"Comment4Prompt": false,
"Comment5Prompt": false,
"Comment2Code": "",
"Comment3Code": "",
"Comment4Code": "",
"Comment5Code": "",
"Discount1": 0.0,
"Discount2": 0.0,
"Discount3": 0.0,
"Discount4": 0.0,
"Discount5": 0.0,
"Discount6": 0.0,
"Discount7": 0.0,
"Discount8": 0.0,
"Discount9": 0.0,
"Discount10": 0.0,
"NotUMRP": false,
"Flooring": false,
"MasterPackQty": 1,
"ABCRating": "",
"ActualSpiff": 0.0,
"SalePrice2": 0.0,
"SaleStartDate2": null,
"SaleEndDate2": null,
"Weight": 0.0,
"LinqProductId": "",
"BeingDiscontinued": false,
"FeaturesCode": "",
"Active": true,
"AverageCost": 316.51,
"Barcode": "",
"BeginYearQty": 0,
"BinLocationCode": "",
"BrandCode": "WHIRL",
"Code": "1901A",
"Color": "",
"CommentCode": "SO",
"DateCreated": "2018-01-27T00:00:00",
"DateModified": "2021-10-15T00:00:00",
"Description": "ICEMAKER WATER PUMP",
"EOQ": 1,
"Equivalent": "",
"ExtWarrantyCode": "",
"Field1": "",
"Field2": "",
"Field3": "",
"Field4": "",
"Field5": "",
"InventoryTypeCode": "APPL",
"LandedCost": 0.0,
"LandingFactor": 1.0,
"LastCost": 316.51,
"LastDateOrdered": "2021-09-13T00:00:00",
"LastDateReceived": "2020-02-13T00:00:00",
"LastDateSold": "2020-03-11T00:00:00",
"ListPrice": 0.0,
"LocQOH": 0,
"LocYTD": 6,
"MainStockQOH": 0,
"MainStockYTD": 0,
"ManufacturersWarranty": 12,
"MfgReturned": 0,
"MiscCode": "",
"NewUsed": "New",
"Note": "Icemaker Water Pump",
"Obsolete": false,
"OriginalCost": 314.99,
"PicturePath": "",
"Points": 0.0,
"PriceTag": "",
"ProductCode": "81001",
"ReplacementCost": 314.99,
"ReplacementCostEffectiveDate": null,
"ResizePicture": false,
"SKU": "",
"Spiff": 0.0,
"SpiffEndDate": null,
"SpiffStartDate": null,
"StandardCost": 314.99,
"Stock": false,
"Substituted": false,
"SupplierCode": "00984",
"Tax1": false,
"Tax1CostList": "List",
"Tax1Included": false,
"Tax1Percentage": 0.0,
"Tax2": true,
"Tax3": true,
"TotalBooked": 0,
"TotalLastYear": 0,
"TotalMax": 0,
"TotalMin": 0,
"TotalNotAvailable": 0,
"TotalPrevLastYear": 0,
"TotalQOO": 0,
"TotalReserved": 0,
"UserCreated": "Conv",
"UserModified": "02950"
}
}
]
}
{
"Results": {
"Success": false,
"Warning": false,
"HttpStatusCode": 400,
"GeneralMessage": "One or more of the fields has an invalid or missing value.",
"ExceptionMessage": null,
"Keys": [],
"Messages": [
{
"Code": "SYS-10001",
"Message": "ZIP - invalid field name."
}
],
"Warnings": []
},
"Paging": {
"PageSize": 100,
"LargestID": 0,
"PagesRemaining": false
},
"Query": {
"fieldName": null,
"eval": "EQUAL",
"value": "",
"valueList": null,
"start": null,
"end": null
},
"SubQuery": [],
"Model": []
}
Feedback
Was this page helpful?
Thank you! Have additional feedback? We would love to hear from you!
Sorry to hear that. Please tell us how we can improve.