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.

Important: if you operate in the European Union, the General Data Protection Regulation (GDPR) requires all processing done with customers' personal information to be logged. If the retrieved dataset contains any information that could be considered personally identifiable data of natural persons (vehicle registration numbers and VINs, for example), you are responsible for logging everything you do with the data. If it is not possible to keep the logs in the system that processes the data, you may consider writing the log entries into Erply, with the logProcessingOfCustomerData call.

Input parameters

Parameter name	Description	Possible value
applianceID	Appliance ID.	integer
invoiceID	Invoice ID.	integer
customerID	Customer ID.	integer
productID	Product ID.	integer
serialNumber	Appliance serial number.	string
vehicleVin	Vehicle vin number.	string
searchAttributeName	Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array.	string
searchAttributeValue	Attribute value to search for. Error 1030 will be returned if value is an array.	string
changedSince	Retrieve 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)
recordsOnPage	Number of records API should return. By default 20, at most 100.	integer
pageNo	API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".	integer

Response

Field name

Type

Description

applianceID

integer

Appliance ID.

applianceName

string

Name of appliance. Appliance-specific attribute. Available only if your account is configured for appliance repair.

productID

integer

Product ID. Appliance-specific attribute.Available only if your account is configured for appliance repair.

productName

string

Product name. Appliance-specific attribute .Available only if your account is configured for appliance repair.

productCode

string

First 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.

productCode2

string

Second 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.

invoiceID

integer

Invoice ID the appliance/vehicle was sold with.

invoiceNo

string

Invoice number.

customerID

integer

Customer ID (appliance/vehicle buyer).

customerName

string

Customer name.

customerEmail

string

Customer e-mail address.

salesDate

ISO date (yyyy-mm-dd)

Sales date.

startDateOfWarranty

ISO date (yyyy-mm-dd)

Start date of warranty.

endDateOfWarranty

ISO date (yyyy-mm-dd)

End date of warranty.

serialNumber

string

Serial number.

vehicleVIN

string