Search

getAppliances

Retrieve appliances or vehicles.

This API call is related to the Assignments module. Depending on configuration, your Assignments module may be set up either for appliance repair (in which case it returns the list of appliances), or vehicle/car repair (it returns the list of vehicles). Vehicles have a few extra fields, compared to appliances.

This API call returns error 1006 if assignment module is not enabled on your account.

Input parameters

Parameter nameDescriptionPossible valueRequired
applianceIDAppliance ID.Integer
invoiceIDInvoice ID.Integer
customerIDCustomer ID.Integer
productIDProduct ID.Integer
searchAttributeNameSearch from attribute name. searchAttributeName and searchAttributeValue have to be specified bothString
searchAttributeValueSearch from attribute valueString
changedSinceRetrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with ERPLY.Integer (Unix timestamp)
recordsOnPageNumber of records API should return. By default 20, at most 100.Integer
pageNoAPI returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".Integer

Response

Field nameTypeDescription
applianceIDIntegerAppliance ID.
applianceNameStringName of appliance. Appliance-specific attribute. Available only if your account is configured for appliance repair.
productIDIntegerProduct ID. Appliance-specific attribute.Available only if your account is configured for appliance repair.
productNameStringProduct name. Appliance-specific attribute .Available only if your account is configured for appliance repair.
productCodeStringFirst code of the product (by convention, this is used for company's internal code). Appliance-specific attribute. Available only if your account is configured for appliance repair.
productCode2StringSecond code of the product (by convention, this is used for EAN/UPC barcode). Appliance-specific attribute. Available only if your account is configured for appliance repair.
invoiceIDIntegerInvoice ID the appliance/vehicle was sold with.
invoiceNoStringInvoice number.
customerIDIntegerCustomer ID (appliance/vehicle buyer).
customerNameStringCustomer name.
customerEmailStringCustomer e-mail address.
salesDateISO date (yyyy-mm-dd)Sales date.
startDateOfWarrantyISO date (yyyy-mm-dd)Start date of warranty.
endDateOfWarrantyISO date (yyyy-mm-dd)End date of warranty.
serialNumberStringSerial number.
vehicleVINStringVehicle-specific attribute. Available only if your account is configured for vehicle repair.
vehicleMakeStringVehicle-specific attribute. Available only if your account is configured for vehicle repair.
vehicleModelStringVehicle-specific attribute. Available only if your account is configured for vehicle repair.
vehicleVersionStringVehicle-specific attribute. Available only if your account is configured for vehicle repair.
vehicleYearOfManufactureStringVehicle-specific attribute. Available only if your account is configured for vehicle repair.
vehicleMileageIntegerVehicle-specific attribute. Available only if your account is configured for vehicle repair.
vehicleUserStringVehicle-specific attribute. Available only if your account is configured for vehicle repair.
notesStringAdditional information.
lastModifiedUnix timestamp.
attributesArrayAdditional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value