Found 365 results
in 9.4888 ms
/getting-started/bulk-api-calls
...requestID to each of the sub-requests; the same value will be returned in response header.
Some usage notes and tips:
Processing bulk calls will take considerably longer that processing a single call. Use a longer request timeout.
The following input parameters must be sent as top-level...
/new-apis/wms-api
...API for implementing warehouse management on top of Erply inventory.
As a user, you might rather be interested in the end-user apps and the workflow we offer — instead of the raw API. The processes are documented here:
Warehouse Management Software
Warehouse Management Software WMS2...
/requests/calculateshoppingcart
...parameters
Parameter name
Description
Possible value
Required
documentID
Sales document ID.
integer
type
Possible values: INVWAYBILL, CASHINVOICE, WAYBILL, PREPAYMENT, OFFER, EXPORTINVOICE, RESERVATION, ORDER, INVOICE, CREDITINVOICE.Default value is CASHINVOICE.
string
date
If omitted, current...
/requests/changepassword
...omit the parameter, or specify 0 or a negative value, a session with a default length of 3600 will be created. If you specify a value larger than 86400 seconds, session length will be set to 86400 seconds.
integer
doNotGenerateIdentityToken
If set to 1, then API will NOT return parameter...
/requests/verifyuser
...omit the parameter, or specify 0 or a negative value, a session with a default length of 3600 will be created. If you specify a value larger than 86400 seconds, session length will be set to 86400 seconds.
integer
doNotGenerateIdentityToken
If set to 1, then API will NOT return parameter...
/requests/switchuser
...omit the parameter, or specify 0 or a negative value, a session with a default length of 3600 will be created. If you specify a value larger than 86400 seconds, session length will be set to 86400 seconds.
integer
doNotGenerateIdentityToken
If set to 1, then API will NOT return parameter...
/getting-started/curl
..."sessionLength":3600,
"loginUrl":"https:\/\/s3.erply.com\/eng\/"
}
]
}
Sessions have a default lifetime of 3600 seconds. If session expires, all subsequent API calls will be responded with an error code 1054 or 1055 (see the list of error codes). A new session can be started by...
/new-apis/cdn-api
...endpoint for all other accounts:
Endpoint: https://cdn.erply.com/
Documentation: https://cdn.erply.com/documentation/index.html
Authentication
Make a verifyUser call to Erply API. From the response, obtain field "token". It is a JSON Web Token.
Pass the token to CDN API to obtain a CDN...
/requests/getsessionkeyuser
...of the service endpoint (with "https://" protocol in the beginning and "/" in the end). Append the names of API calls to this URL.tokenIntegerAuthentication token for the service.priorityInteger (0..65535)Priority of this host. A client must attempt to contact the target host...
/requests/verifyoauthtoken
...of the service endpoint (with "https://" protocol in the beginning and "/" in the end). Append the names of API calls to this URL.tokenIntegerAuthentication token for the service.priorityInteger (0..65535)Priority of this host. A client must attempt to contact the target host...
/requests/getserviceendpointsforpos
...of the service endpoint (with "https://" protocol in the beginning and "/" in the end). Append the names of API calls to this URL.tokenIntegerAuthentication token for the service.priorityInteger (0..65535)Priority of this host. A client must attempt to contact the target host...
/requests/getconfparameters
...are supposed to have a decimal/integer value, or a value of 1 or 0 (true/false, enabled/disabled). However API returns almost all fields as strings. If your programming environment requires that, please cast the parameters to the correct type. In the table below, the types are marked...
/getting-started/php
...= [password];
$api->url = "https://".$api->clientCode.".erply.com/api/";
// Create a new customer group
$inputParameters = array(
"name" => "Possible leads",
);
$result = $api->sendRequest("saveCustomerGroup", $inputParameters);
// Default output format is JSON, so...
/requests/editstoreregionpricelist
...Location (store) price lists will be applied on top of region price lists.If you specify a negative or zero value, error 1016 will be returned.
integer
yes
This API call returns error code 1006 if "Store regions" module has not been enabled on your account, or error code 1077 if this price list...
/requests/addstoreregionpricelist
...Location (store) price lists will be applied on top of region price lists.If you specify a negative or zero value, error 1016 will be returned.
integer
This API call returns error code 1006 if "Store regions" module has not been enabled on your account, or error code 1026 if this price list has...
/requests/saveproductfile
...flag you can use for classification purposes (value: 0 or 1).
integer
name
A descriptive name for the file
string
file
Contents of the binary file, base64-encoded.If file content is missing, API returns error 1090. If it cannot be base64-decoded, API returns error 1091.
Data
filename
File...
/concepts/languages
...is between scripts, not languages.
Sources:
https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
https://stackoverflow.com/questions/4892372/language-codes-for-simplified-chinese-and-traditional-chinese
Example: if configuration parameters are "langs" = "eng,gre" and "country" = "NL", the...
/requests/saveproductpicture
...parameters
Parameter name
Description
Possible value
Required
productPictureID
Use productPictureID to edit or replace an existing image. You may edit general information of the file (productID, pictureName) or replace/update the file as well, as needed.
integer
productID
Product ID. For new...
/new-apis
...-d request=getServiceEndpoints https://<accountnumber>.erply.com/api/ | jq .
The response looks as follows:
If you do not have the "jq" tool installed, just omit the vertical bar and everything after that ("| jq .") — you will get a plain, not pretty-printed, JSON...
/getting-started
...is a HTTP POST request in traditional parameter1=value1¶meter2=value2 format. Server responds by sending an XML or JSON document that contains response metadata and requested records.
Request – HTTP POST
Response – JSON / XML document (you get to choose which). JSON is the default...