article.get
Request of details of one ore more products. If no filter is set, 10 products will be shown.
FILTER
| Tags | Description |
| ARTICLE_NUMBER |
Article number |
| TAGS |
Article tags |
RESPONSE
| Tags | Description |
| ARTICLE_NUMBER |
Article number |
| TITLE |
Product title |
| DESCRIPTION |
Description |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| UNIT_PRICE |
Unit price |
| SETUP_FEE |
Setup fee |
| ALLOW_MULTIPLE |
Allow Multiple |
| IS_ADDON |
Article is Addon |
| IS_DIGITAL |
Article is a digital product |
| TRANSLATION |
|
| CURRENCY_CODE |
Currency Code |
| VAT_PERCENT |
Vat Percentage |
| SUBSCRIPTION_INTERVAL |
Subscription Interval |
| SUBSCRIPTION_NUMBER_EVENTS |
Subscription number billing events |
| SUBSCRIPTION_TRIAL |
Subscription trial period |
| SUBSCRIPTION_DURATION |
Subscription first contract period |
| SUBSCRIPTION_DURATION_FOLLOW |
Subscription following contract period |
| SUBSCRIPTION_CANCELLATION |
Subscription cancellation period |
| RETURN_URL_SUCCESS |
Success URL |
| RETURN_URL_CANCEL |
Cancel URL |
| CHECKOUT_URL |
Checkout-URL |
| FEATURES |
Product features |
article.create
Create a new product
DATA
| Tags | Description |
| ARTICLE_NUMBER Required |
Article number |
| TITLE Required |
Product title |
| UNIT_PRICE Required |
Unit price |
| CURRENCY_CODE Required |
Currency Code |
| DESCRIPTION Required |
Description |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| IS_DIGITAL |
Article is a digital product |
| SETUP_FEE |
Setup fee |
| ALLOW_MULTIPLE |
Allow Multiple |
| TRANSLATION |
|
| VAT_PERCENT |
Vat Percentage |
| SUBSCRIPTION_INTERVAL |
Subscription Interval |
| SUBSCRIPTION_NUMBER_EVENTS |
Subscription number billing events |
| SUBSCRIPTION_TRIAL |
Subscription trial period |
| SUBSCRIPTION_DURATION |
Subscription first contract period |
| SUBSCRIPTION_DURATION_FOLLOW |
Subscription following contract period |
| SUBSCRIPTION_CANCELLATION |
Subscription cancellation period |
| RETURN_URL_SUCCESS |
Success URL |
| RETURN_URL_CANCEL |
Cancel URL |
| FEATURES |
Product features |
RESPONSE
| Tags | Description |
| STATUS |
Status of API-Call |
| ARTICLE_NUMBER |
Article number |
| TITLE |
Product title |
| DESCRIPTION |
Description |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| UNIT_PRICE |
Unit price |
| SETUP_FEE |
Setup fee |
| ALLOW_MULTIPLE |
Allow Multiple |
| TRANSLATION |
|
| CURRENCY_CODE |
Currency Code |
| VAT_PERCENT |
Vat Percentage |
| SUBSCRIPTION_INTERVAL |
Subscription Interval |
| SUBSCRIPTION_NUMBER_EVENTS |
Subscription number billing events |
| SUBSCRIPTION_TRIAL |
Subscription trial period |
| SUBSCRIPTION_DURATION |
Subscription first contract period |
| SUBSCRIPTION_DURATION_FOLLOW |
Subscription following contract period |
| SUBSCRIPTION_CANCELLATION |
Subscription cancellation period |
| RETURN_URL_SUCCESS |
Success URL |
| RETURN_URL_CANCEL |
Cancel URL |
| CHECKOUT_URL |
Checkout-URL |
| FEATURES |
Product features |
article.update
Changing an existing product
DATA
| Tags | Description |
| ARTICLE_ID Required |
|
| ARTICLE_NUMBER |
Article number |
| TITLE |
Product title |
| DESCRIPTION |
Description |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| IS_DIGITAL |
Article is a digital product |
| UNIT_PRICE |
Unit price |
| SETUP_FEE |
Setup fee |
| ALLOW_MULTIPLE |
Allow Multiple |
| TRANSLATION |
|
| CURRENCY_CODE |
Currency Code |
| VAT_PERCENT |
Vat Percentage |
| SUBSCRIPTION_INTERVAL |
Subscription Interval |
| SUBSCRIPTION_NUMBER_EVENTS |
Subscription number billing events |
| SUBSCRIPTION_TRIAL |
Subscription trial period |
| SUBSCRIPTION_DURATION |
Subscription first contract period |
| SUBSCRIPTION_DURATION_FOLLOW |
Subscription following contract period |
| SUBSCRIPTION_CANCELLATION |
Subscription cancellation period |
| RETURN_URL_SUCCESS |
Success URL |
| RETURN_URL_CANCEL |
Cancel URL |
| FEATURES |
Product features |
RESPONSE
| Tags | Description |
| STATUS |
Status of API-Call |
| ARTICLE_NUMBER |
Article number |
| TITLE |
Product title |
| DESCRIPTION |
Description |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| UNIT_PRICE |
Unit price |
| SETUP_FEE |
Setup fee |
| ALLOW_MULTIPLE |
Allow Multiple |
| TRANSLATION |
|
| CURRENCY_CODE |
Currency Code |
| VAT_PERCENT |
Vat Percentage |
| SUBSCRIPTION_INTERVAL |
Subscription Interval |
| SUBSCRIPTION_NUMBER_EVENTS |
Subscription number billing events |
| SUBSCRIPTION_TRIAL |
Subscription trial period |
| SUBSCRIPTION_DURATION |
Subscription first contract period |
| SUBSCRIPTION_DURATION_FOLLOW |
Subscription following contract period |
| SUBSCRIPTION_CANCELLATION |
Subscription cancellation period |
| RETURN_URL_SUCCESS |
Success URL |
| RETURN_URL_CANCEL |
Cancel URL |
| CHECKOUT_URL |
Checkout-URL |
| FEATURES |
Product features |
article.createsecurelink
Creates a secure purchase URL, which is valid for 10 minutes
DATA
| Tags | Description |
| ARTICLE_NUMBER Required |
Article number |
RESPONSE
| Tags | Description |
| CHECKOUT_URL |
Checkout-URL |
article.transitions
Request of transitions between the different products, that have been configurated.
FILTER
| Tags | Description |
| ARTICLE_NUMBER Required |
Article number |
| TRANSITION |
Product transition |
RESPONSE
| Tags | Description |
| ARTICLE_NUMBER |
Article number |
| TRANSITION |
Product transition |
article.delete
Deletion of an existing article.
DATA
| Tags | Description |
| ARTICLE_ID Required |
|
RESPONSE
| Tags | Description |
| STATUS |
Status of API-Call |
addon.get
Request of details of one ore more add-ons. If no filter is set, 10 add-ons will be shown.
FILTER
| Tags | Description |
| ARTICLE_NUMBER |
Article number |
| TAGS |
Article tags |
RESPONSE
| Tags | Description |
| ARTICLE_NUMBER |
Article number |
| TITLE |
Product title |
| DESCRIPTION |
Description |
| TRANSLATIONS |
Product translation |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| ADDON_ID |
Internal product-ID |
| UNIT_PRICE |
Unit price |
| SETUP_FEE |
Setup fee |
| VAT_PERCENT |
Vat Percentage |
| ALLOW_MULTIPLE |
Allow Multiple |
| CURRENCY_CODE |
Currency Code |
| IS_DIGITAL |
Article is a digital product |
| CONNECTED_ARTICLES |
Connectable main-products |
addon.create
Creation of a new add-on.
DATA
| Tags | Description |
| ARTICLE_NUMBER Required |
Article number |
| TITLE Required |
Product title |
| UNIT_PRICE Required |
Unit price |
| VAT_PERCENT Required |
Vat Percentage |
| DESCRIPTION Required |
Description |
| TRANSLATIONS |
Product translation |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| SETUP_FEE |
Setup fee |
| ALLOW_MULTIPLE |
Allow Multiple |
| CURRENCY_CODE |
Currency Code |
| IS_DIGITAL |
Article is a digital product |
| CONNECTED_ARTICLES |
Connectable main-products |
RESPONSE
| Tags | Description |
| STATUS |
Status of API-Call |
| ARTICLE_NUMBER |
Article number |
| TITLE |
Product title |
| DESCRIPTION |
Description |
| TRANSLATIONS |
Product translation |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| ADDON_ID |
Internal product-ID |
| UNIT_PRICE |
Unit price |
| SETUP_FEE |
Setup fee |
| VAT_PERCENT |
Vat Percentage |
| ALLOW_MULTIPLE |
Allow Multiple |
| CURRENCY_CODE |
Currency Code |
| IS_DIGITAL |
Article is a digital product |
| CONNECTED_ARTICLES |
Connectable main-products |
addon.update
Changing the details of an existing add-on.
DATA
| Tags | Description |
| ADDON_ID Required |
Internal product-ID |
| TITLE |
Product title |
| DESCRIPTION |
Description |
| TRANSLATIONS |
Product translation |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| UNIT_PRICE |
Unit price |
| SETUP_FEE |
Setup fee |
| VAT_PERCENT |
Vat Percentage |
| ALLOW_MULTIPLE |
Allow Multiple |
| CURRENCY_CODE |
Currency Code |
| IS_DIGITAL |
Article is a digital product |
| CONNECTED_ARTICLES |
Connectable main-products |
RESPONSE
| Tags | Description |
| STATUS |
Status of API-Call |
| ARTICLE_NUMBER |
Article number |
| TITLE |
Product title |
| DESCRIPTION |
Description |
| TRANSLATIONS |
Product translation |
| TAGS |
Article tags |
| IS_GROSS |
Article Price is gross |
| ADDON_ID |
Internal product-ID |
| UNIT_PRICE |
Unit price |
| SETUP_FEE |
Setup fee |
| VAT_PERCENT |
Vat Percentage |
| ALLOW_MULTIPLE |
Allow Multiple |
| CURRENCY_CODE |
Currency Code |
| IS_DIGITAL |
Article is a digital product |
| CONNECTED_ARTICLES |
Connectable main-products |
addon.delete
Deletion of an existing add-on.
DATA
| Tags | Description |
| ADDON_ID Required |
Internal product-ID |
RESPONSE
| Tags | Description |
| STATUS |
Status of API-Call |