PDF Export
ParameterDescription
client client ID
sp service provider. (mandatory if the user account can use different service provider values)
so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client)
readProductsales Read product sales orders. PS orders must be read in a separate request than standard subscriptions.
publication Filter for publication (optional)
returnAddressType Define which role will be available in the response (AG, WE, VM, RE). Default: WE
returnAddressTimepointDefine wich address should be returned (mandatory)
'L' = Address at last shipment date
'A' = active address
'Z' = Address at future shipment date
returnExtendedCommunicationDatareturn extended communication data (true/false) Default: false
returnRenewalPaymentDataReturn additional renewal payment data
true = Yes
false = No (Default)
returnRenewalIssueRemainingtrue = Yes return remaining issues regarding the whole subscription
Otherwise Return remaining isssues regarding the current cycle (Default)
returnCurrentSuspencionDataReturn additional data of the current suspension. If there is no current suspension the next in time is returned.
true = Yes
false = No (Default)
returnExtendedPremiumDataReturn extended premium data
true = Yes
false = No (Default)
returnHolidayAddresses BETA BETA Returns holiday addresses
true = Yes
false = No (Default)
filter comma seperated list of filters

Filters are sent as request parameter with a comma seperated list of key-value-pairs.

Example:

  &filter=filter1,filter2[key1=value1;key2=value2],filter2

List of available filters

This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information