Helpers and constants
Definition
Helpers are a set of endpoints used to retrieve constants expected and returned by the merchant API. They each are a list of values for a specific field or type of data.
The content of the call may be expended over time, especially currencies or languages. However, existing values will never be altered.
Helper endpoints are not meant to be called programatically: there rarely ever change and are there to provide an easy access-point to retrieve Neteven constants.
Endpoints
Get the list of available languages
GET | /languages |
|---|---|
Description | returns the list of language codes that the API accepts and returns. |
Required scope | basic authentication (no additional scope) |
Returns | a list of Language objects with the code and its corresponding human readable label. |
Example:
curl --request GET \
--url https://api.neteven.com/v1/languages \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $MYTOKEN' \
--header 'Content-Type: application/json'
Get the list of available currencies
GET | /currencies |
|---|---|
Description | returns the list of currencies codes that the API accepts and returns. |
Required scope | basic authentication (no additional scope) |
Returns | a list of currency objects with the code and its corresponding human readable label. |
Example:
curl --request GET \
--url https://api.neteven.com/v1/currencies \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $MYTOKEN' \
--header 'Content-Type: application/json'
Get the list of available price fields
GET | /price-fields |
|---|---|
Description | returns the list of price fields that the API accepts and returns. |
Required scope | basic authentication (no additional scope) |
Returns | a list of PriceField objects to use in price update endpoints. |
Example:
curl --request GET \
--url https://api.neteven.com/v1/price-fields \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $MYTOKEN' \
--header 'Content-Type: application/json'