fbpx

Get product list

Description

This function gives you our product price list with your commission rates.

URL

/cdrdefinitions/getList

Parameters

None

Return

This function returns a JSON string in the form of
{"return":{"code":XXX,"message":"...","data":[product1,product2,...]}}
code is a HTTP status code and message is a descriptive text about the returned code.
If code is 200, there’ll be a key called data in the return which is a JSON encoded array of records which themselves are arrays with these keys:

Key Description
id Product’s unique ID.
name Product’s name.
type Product’s type. Available types:
CALLIN, CALLOUT, SMS, PAY, DOCUMENTATION, FAXIN, FAXOUT, SERVICE, SETUP, HARDWARE, TRAVEL, DELIVERY, MCALL, MDATA, MSMS
recurring Whether or not the product is sold as recurring.
amountbuy Your per unit price in € if sold as one-shot. If you get commissions on this product, they are automatically calculated in this field.
0€ = no price defined.
amount A recommended one-shot price in € to bill your customer. 0€ = no price defined.
amountmonthlybuy Your per unit price in € if sold as recurring. If you get commissions on this product, they are automatically calculated in this field.
0€ = no price defined.
amountmonthly A recommended recurring price in € to bill your customer. 0€ = no price defined.
commissioncat The commission category to which the product is linked.
commission Your commission rate in % for this product.