Subscriptions

This page describes the subscriptions rest web services.

There are several services to read a subscription. You can select a subscription either by order number, by order attribute or by reference doc. All these services have common request parameters to select what subscription details are returned.

Examples

Example get subscription requests

Get By Order Number

Get a subscription by order number.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getByOrderNumber-3.0.0
Fuba: /DSB/_ISM_E_SEL_VBELN

URL

GET: /rest/{client}/subscriptions/{orderNumber}

Parameter	Description
orderNumber	subscription order number

Additional common parameters

Parameter	Description
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
returnAddressTimepoint	Define wich address should be returned (mandatory) 'L' = Address at last shipment date 'A' = active address 'Z' = Address at future shipment date
returnExtendedCommunicationData	return extended communication data (true/false) Default: false
returnRenewalPaymentData	Return additional renewal payment data true = Yes false = No (Default)
returnRenewalIssueRemaining	true = Yes return remaining issues regarding the whole subscription Otherwise Return remaining isssues regarding the current cycle (Default)
returnCurrentSuspencionData	Return additional data of the current suspension. If there is no current suspension the next in time is returned. true = Yes false = No (Default)
returnExtendedPremiumData	Return 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

Corresponding SOAP Service: getByOrderNumber.

Response

The response is a JSON document containing a subscription.

JSON Subscription Order

Example

{
   "orderNumber": "4807309861",
   "dsbUrposLief": "000001",
   "publication": "00000310",
   "publicationName": "Publication",
   "edition": "00000310",
   "mixType": "01",
   "purchaseFrequency": "VA",
   "deliveryType": "DM",
   "orderStatus": "I",
   "isRenewal" : true,
   "isTimebased" : true,
   "orderCurrency": "GBP",
   "issueNrFrom": "000000265",
   "issueNrTo": "000000277",
   "issueNrFirstBill": "",
   "validFrom": "2014-03-08",
   "validTo": "2015-02-24",
   "endReason": "900",
   "promotionSource": "MP2123",
   "prSourceVar": "",
   "referenceDoc": "10995ABC123456789",
   "custOrderNumber": "",
   "custOrderDate": "2014-01-24",
   "subscrPhase": "IF1",
   "priceGroup": "",
   "priceKey": "CP02",
   "paymentMethod": "",
   "subOProcessedPMD": {
     "subPaymentMethod": "660",
     "subPaymentMethodText": "Method"
   },
   "billingFrequency": "Y1",
   "billingFrequencyShortDescription": "",
   "quantity": "1",
   "salesOrganization": "0100",
   "dsbMedia1": "",
   "dsbMedia2": "",
   "dsbMedia3": "",
   "dsbMedia4": "",
   "dsbMedia2b": "",
   "dsbMedia7": "",
   "agentNumber": "",
   "materialNumber": "",
   "premiumDescription": "",
   "premiumDispatchDate": null,
   "billingPayedTo": "",
   "issueNumberNextBill": "",
   "issueNumberFromLastBill": "",
   "issueNumberToLastBill": "",
   "currentDunningLevel": "00",
   "conditionTermCommitmentPeriod": "1",
   "conditionTermCancelationPeriod": "1",
   "conditionTermRenewal": "1",
   "salesSource": "REN1",
   "advertisingMedium": "MP2ED02",
   "salesDocumentType": "REN",
   "validFromEvt": "2014-02-25",
   "validToEvt": "2015-01-28",
   "validFromOnSaleDate": "2014-03-15",
   "validToOnSaleDate": "2015-02-15",
   "dispatchType": "",
   "dispatchText": "",
   "contractAccountBalance": "0.00",
   "postageKey": "DM",
   "productType": "ON",
   "isCombiSubscription": false,
   "renewal":    {
      "expiryDate": "2015-02-15",
      "expiryIssueNr": "000000277",
      "currentCycleNumberOfIssues": 13,
      "currentCycleExpiryDate": "2015-02-15",
      "currentCycleExpiryIssueNr": "000000277",
      "currentCycleStartDate": "2014-03-15",
      "currentCycleStartIssueNr": "000000265",
      "currentCycleAcceptanceDate": "2014-02-04",
      "currentCycleOffer": "ED1C2",
      "currentCycleOfferType": "RN",
      "currentCycleOfferDescription": "",
      "currentCycleOfferMarketingText": "",
      "currentCyclePaidAmount": "20.00",
      "currentCycleBundlePaidAmount": "0.00",
      "offerClassification": "",
      "offerClassificationDefinition": "",
      "orderCurrency": "GBP",
      "renewalDueDate": "2014-02-04",
      "numberIssuesRemaining": 0,
      "renewalBundleComponent" : "M",
      "autoRenewal": false,
      "autoRenewalNextPaymentAmount": 0,
      "autoRenewalNextPaymentFrequencyCode": "",
      "autoRenewalNextPaymentFrequencyText": "",
      "autoRenewalNextPaymentDate": null,
      "autoRenewalLastPaymentAmount": 0,
      "autoRenewalLastPaymentFrequencyCode": "",
      "autoRenewalLastPaymentFrequencyText": "",
      "autoRenewalLastPaymentDate": null,
      "autoRenewalActualClaimCounter": 2,
      "autoRenewalIncreaseClaimCounter": 0
   },
   "currentSuspension":    {
      "suspendedFromDate": null,
      "suspendedToDate": null,
      "suspendedFromIssueNr": "",
      "suspendedFromIssueDesc": "Description",
      "suspendedToIssueNr": "",
      "suspendedToIssueDesc": "Description",
      "suspendedReasonCode": ""
   },
   "currentChangeInfo":    {
      "futureMixType": null,
      "futureMixTypeFromIssueNr": null,
      "futureMixTypeToIssueNr": null,
      "formerMixType": null,
      "formerMixTypeToIssueNr": null,
      "futureDeliveryQuantity": null,
      "futureDeliveryQuantityFromIssueNr": null,
      "formerDeliveryQuantity": null,
      "formerDeliveryQuantityToIssueNr": null,
      "futureDeliveryType": null,
      "futureDeliveryTypeFromIssueNr": null,
      "formerDeliveryType": null,
      "formerDeliveryTypeToIssueNr": null,
      "futureDispatchType": null,
      "futureDispatchTypeFromIssueNr": null,
      "formerDispatchType": null,
      "formerDispatchTypeToIssueNr": null,
      "futureDispatchText": null,
      "futureDispatchTextFromIssueNr": null,
      "formerDispatchText": null,
      "formerDispatchTextToIssueNr": null
   },
   "bundles": [],
   "businessPartners": [],
   "orderAttributes":    [],
   "productSalesOrder" : {
     "status" : "",
     "statusDescription" : "",
     "positions" : [ {
       "positionNumber" : 1,
       "articleNumber" : "ABC",
       "externalArticleNumber" : "AY-32",
       "status" : "",
       "statusDescription" : "",
       "textVariant" : "",
       "articleDescription" : "",
       "activity" : "",
       "articleGroup" : ""
     }
     ]
   }}

Element Definitions

Field name	Type	Description
orderNumber	C	Subscription no.
dsbUrposLief	C	Reference to the original delivery position
publication	C	publication
publication-name	C	name of publication
edition	C	edition
mixType	C	mix-type
purchaseFrequency	C	Purchase frequency
deliveryType	C	delivery type
orderStatus	C	the status of the order
isRenewal	B	is this a renewal sub ?
isTimebased	B	is this a timebased Renewal-Sub (true/false) ?
orderCurrency	C	currency code of the subscription
issueNrFrom	C	Copy no. of first delivered distribution edition.
issueNrTo	C	Copy no. of last delivered distribution edition.
issueNrFirstBill	C	Copy no. of 1. invoice.
validFrom	D	Start of the of delivery.
validTo	D	Date of end of delivery, filled only when a subscription has been cancelled.
validFromEvt	D
validToEvt	D	Valid until EVT, whereas EVT means “first shipment date”.
validFromOnSaleDate	D	Valid from date
validToOnSaleDate	D	Valid to date
endReason	C	Reason for delivery stop. The values are client dependent.
promotionSource	C	Source code
prSourceVar	C	Source code-Variation
referenceDoc	C	Reference evidence. Comprises order number of the old system. Apart from that it is identical with the field order-number.
custOrderNumber	C	customer order number
custorderDate	D	The date where the customer order was entered into the system.
subscrPhase	C	phase where the subscription is at the moment
priceGroup	C	Price group of customer stipulates possible reductions on basic price.
priceKey	C	Price-key of customer Stipulates the basic price.
paymentMethod	C	Payment-method: E → payment per direct debit. K→ payment per credit card. R → payment per invoice. For foreign customers are probably further payment methods provided.
subOProcessedPMD
* subPaymentMethod	C	Subtype of Payment-method
* subPaymentMethodText	C	Subtype text of Payment-method
billingFrequency	C	billing frequency
billingFrequencyShortDescription	C	billing frequency short description
quantity	C	quantity
salesOrganization	C	Sales-organization
dsbMedia1	C	Field for free disposal. Is stored with the order.
dsbMedia2	C	Field for free disposal. Is stored with the order.
dsbMedia3	C	Field for free disposal. Is stored with the order.
dsbMedia4	C	Field for free disposal. Is stored with the order.
dsbMedia2b	C	Field for free disposal. Is stored with the order.
dsbMedia7	C	Field for free disposal. Is stored with the order.
agentNumber	C	Agent-number
materialNumber	C	Premium number (Material-number of goods premium)
premiumDescription	C	Premium description
premiumDispatchDate	C	Premium dispatch date
billingPayedTo	C	Billing-payed-to copy no.
issueNumberNextBill	C	Issue no. of next invoice
issueNumberFromLastBill	C	Issue no. from last bill
issueNumberToLastBill	C	Issue no. to last bill
currentDunningLevel	C	Current-dunning-level
conditionTermCommitmentPeriod	C	duration of commitment-period (regular cancellation after x months possible)
conditionTermCancelationPeriod	C	Terms of contract: cancellation-period
conditionTermRenewal	N	Terms of contract: extension of commitment-period
salesSource	C	Sales source
advertisingMedium	C	Advertising medium
salesDocumentType	C	Sales document type
dispatchType	C	Dispatch type
dispatchText	C	Dispatch text
contractAccountBalance	C	contract account balance \\Note! This value is only updated daily. In case of collective billing, the value could be added up from more than one contracts. negative leading sign = customer credit balance positive leading sign = bills receivable
postageKey	C
productType	C	BETA Kind of Medium (ON,….) Mapping should be requested with service MasterData.getMasterData
isCombiSubscription	B	BETA Is it a combi subscription true/false(default)
renewal
expiryDate	C	The date at the which the subscription as a whole, will expire.
expiryIssueNr	C	The last Issue number that the subscriber will receive.
renewalDueDate	C	Due date for next payment
numberIssuesRemaining	N	The number of issues, still to deliver. If the requestflag `returnRenewalIssueRemaining` is set to 'Y', the number of issues over the whole Subscription period is returned, otherwise, only the number of issues in the current cycle is returned.
currentCycleNumberOfIssues	N	The number of issues that are in the renewal cycle
currentCycleStartIssueNr	C	Issue number at the start of the renewal cycle.
currentCycleStartDate	C	Start date of the renewal cycle
currentCycleExpiryIssueNr	C	Issue number at the end of the renewal cycle.
currentCycleExpiryDate	C	End date of the renewal cycle
currentCycleAcceptanceDate	C	The date at which the subscriber accepted the renewal of their subscription.
currentCycleOffer	C	Offer from current cycle
currentCycleOfferType	C	Offer type of the offer from current cycle (RN, DD or BU)
currentCycleOfferDescription	C	Offer description of the offer from current cycle (if filled)
currentCycleOfferMarketingText	C	Marketingtext of the offer from current cycle (if filled)
offerClassification	C	Classification(Bundle, Membership, Normal etc.) B = bundle N = normal M = membership
offerClassificationDefinition	C	Offer classification definition
currentCyclePaidAmount	C	Amount of the current order cycle
currentCycleBundlePaidAmount	C	Amount of the whole bundle. Only relevant if it’s a valid bundled subscription
orderCurrency	C	Order currency
renewalBundleComponent	C	M = Master, S = Slave
autoRenewal	B	subscription is auto renewal (true/false)
autoRenewalNextPaymentAmount	C	Amount of the next collection in the regarding subscription currency
autoRenewalNextPaymentFrequencyCode	C	Frequency code of the next payment collection
autoRenewalNextPaymentFrequencyText	C	Frequency text/description of the next payment collection
autoRenewalNextPaymentDate	C	Date of the next payment collection
autoRenewalLastPaymentAmount	C	Amount of the last collection in the regarding subscription currency
autoRenewalLastPaymentFrequencyCode	C	Frequency code of the last payment collection
autoRenewalLastPaymentFrequencyText	C	Frequency text/description of the last payment collection
autoRenewalLastPaymentDate	C	Date of the last payment collection
autoRenewalActualClaimCounter	N	actual claim counter
autoRenewalIncreaseClaimCounter	N	increase claim counter
bundles
bundleOrderNumber	C	Order number of this bundled Element
publication	C	publication
edition	C	edition
quantity	N	quantity
currentSuspension
suspendedFromDate	C	Suspension from date
suspendedToDate	C	Suspension to date
suspendedFromIssueNr	C	Suspension from issue number
suspendedFromIssueDesc	C	Suspension from issue number description
suspendedToIssueNr	C	Suspension to issue number
suspendedToIssueDesc	C	Suspension to issue number description
suspendedReasonCode	C	Suspension reason code
currentChangeInfo		(to obtain this data, please contact your customer consultant. The customizing flag x_change_info must be set.)
futureMixType	C	Future mix type
futureMixTypeFromIssueNr	C	Issue nr. from
futureMixTypeToIssueNr	C	Issue nr. to
formerMixType	C	Former mix type
formerMixTypeToIssueNr	C	Issue nr. to
futureDeliveryQuantity	N	Future delivery quantity
futureDeliveryQuantityFromIssueNr	C	From issue nr
formerDeliveryQuantity	N	Former delivery quantity
formerDeliveryQuantityToIssueNr	C	To issue nr
futureDeliveryType	C	Future delivery type
futureDeliveryTypeFromIssueNr	C	From issue nr
formerDeliveryType	C	Former delivery type
formerDeliveryTypeToIssueNr	C	To issue nr.
futureDispatchType	C	Future dispatch type
futureDispatchTypeFromIssueNr	C	From issue nr.
formerDispatchType	C	Former dispatch type
formerDispatchTypeToIssueNr	C	To issue nr.
futureDispatchText	C	Future dispatch text
futureDispatchTextFromIssueNr	C	From issue nr.
formerDispatchText	C	Former dispatch text
formerDispatchTextToIssueNr	C	To issue nr.
productSalesOrder		productsales order data of orders that are read with the readProductSales option.
status	C
statusDescription	C
positions		productsales order positions
positionNumber	N
articleNumber	C
externalArticleNumber	C
status	C
statusDescription	C
textVariant	C
articleDescription	C
activity	C
articleGroup	C

businessPartners

JSON Business Partner

Example

{
      "role": "WE",
      "bpNumber": "1006346741",
      "fullSalutation": "Dear Mrs Customer",
      "lastName1": "Customer",
      "lastName2": "",
      "firstName": "Anne",
      "dateOfBirth": "",
      "fullLastName": "Customer",
      "nameAddition": "",
      "jobTitle": "",
      "title": "",
      "salutationCode": "02",
      "salutation": "Mrs",
      "company1": "",
      "company2": "",
      "company3": "",
      "department": "",
      "zipcode": "NN4 7BF",
      "street": "",
      "streetSuffix": "",
      "streetNumber": "",
      "streetNumberSuffix": "",
      "addressLine1": "1 Main Road",
      "addressLine2": "",
      "addressLine3": "",
      "regionCode": "NH",
      "regionText": "Northamptonshire",
      "fullStreet": "",
      "poBoxZipcode": "",
      "poBox": "",
      "poBoxCity": "",
      "majorCustZip": "",
      "city": "NORTHAMPTON",
      "district": "",
      "countryCode": "GB",
      "country": "United Kingdom",
      "advertisement": "Y",
      "blockTag": "N",
      "euSalesTaxNumber": "",
      "bicMasterNumber": "",
      "sector": "",
      "mobilePhoneNumber": "",
      "phoneNumber": "",
      "faxNumber": "",
      "emailAddress": "customer@example.com",
      "bpExtCommunication": [],
      "bpAttributes": [],
      "bpHolidayAddress": []
   }

Element Definitions

Field name	Description
role	C	Type of business partner. AG = orderer WE = consignee RE = invoice recipient
bpNumber	C	Business partner no.
fullSalutation	C	Mounted personal salutation
lastName1	C	Lastname 1
lastName2	C	Lastname 2
firstName	C	First-name
fullLastName	C	Mounted last-name
nameAddition	C	Name-addition, for example profession
jobTitle	C	Job title
title	C	Academic Title
salutationCode	C	Salutation-Code in AVS/3, For example 01 = Mr. 02 = Ms.
salutation	C	Salutation
company1	C	1. line of company address. If this field is filled is the above name the contact person of the firm.
company2	C	2. line of company address. Contains for example section or continuation of firm address.
company3	C	3. line of company address
department	C	department
zipcode	C	zipcode
street	C	Street with house no. and addition to house no.
streetSuffix	C	Addition to street
streetName	C	Street Name
streetNumber	C	Street Number
streetNumberSuffix	C	Street Number Suffix
addressLine1	C	Address line 1 for UK addresses
addressLine2	C	Address line 2 for UK addresses
addressLine3	C	Address line 3 for UK addresses
poBoxZipcode	C	Po-box-zipcode
poBox	C	Po-box
poBoxCity	C	Po-box-city
majorCustZip	C	Major-cust-zip
city	C	City
district	C	Addition of city
regionCode	C	Region-Code (federal state, province, county)
regionText	C	Region as cleartext (e.g. County…)
countryCode	C	Two letter ISO 3166-1 alpha-2 country-code
country	C	country
advertisement	C	Advertisement permitted; Y / N
blockTag	C	General block-tag ( X = put block-tag )
euSalesTaxNumber	C	EU sales tax id
dateOfBirth	D	Birthdate (YYYY-MM-DD)
bicMasterNumber	C	Partner-ID of master (for example company of contact person)
sector	C	branch
mobilePhoneNumber	C	Mobile Telephone-No.: pre code + termination
phoneNumber	C	Telephone no..: pre code + termination
faxNumber	C	Fax-No.: pre code + termination
emailAddress	C	IS-M: e-mail number
bpExtCommunication		Extended communication data (only with request parameter returnExtendedCommunicationData=true)
communicationType	C	Communication Types; Values
communicationValue	C	Communication value
communicationDefault	C	Default value Y / N

bpAttributes

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

bpHolidayAddress

Redirect addresses

JSON Attributes

Example

 "bpHolidayAddress": [
  {
	"validFrom": "2009-11-08",
	"validTo": "2009-12-08",
	"street": "",
	"streetNumber": "",
	"streetNumberSuffix": "",
	"zipcode": "",
	"zipcodeExtension": "",
	"city": "",
	"district": "",
	"poBox": "",
	"poBoxExtension": "",
	"poBoxZipcode": "",
	"poBoxCity": "",
	"majorCustZip": "",
	"majorCustZipExtension": "",
	"countryCode": ""
  },
  ...
]

Element Definition

Parameter	Type	Length	Description
validFrom	C	10	validity of the redirection
validTo	C	10	validity of the redirection
street	C	35	Street
streetNumber	C	10	Street number
streetNumberSuffix	C	8	Street number extension
zipcode	C	10	Zipcode
zipcodeExtension	C	4	Zipcode extension
city	C	35	City
district	C	35	District
poBox	C	35	Po box
poBoxExtension	C	4	Po box extension
poBoxZipcode	C	10	Po box zipcode
poBoxCity	C	35	Po box city
majorCustZip	C	10	Zipcode of company
majorCustZipExtension	C	4	Zipcode extension of company
countryCode	C	3	Country code

orderAttributes

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

Get By Reference Doc

Get a subscription by the reference doc number.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getByReferenceDoc-3.0.0
Fuba: /DSB/_ISM_E_SEL_REFDO

URL

GET: /rest/{client}/subscriptions

Parameter	Description
refdoc	Subscription reference-doc number

Additional common parameters

Parameter	Description
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
returnAddressTimepoint	Define wich address should be returned (mandatory) 'L' = Address at last shipment date 'A' = active address 'Z' = Address at future shipment date
returnExtendedCommunicationData	return extended communication data (true/false) Default: false
returnRenewalPaymentData	Return additional renewal payment data true = Yes false = No (Default)
returnRenewalIssueRemaining	true = Yes return remaining issues regarding the whole subscription Otherwise Return remaining isssues regarding the current cycle (Default)
returnCurrentSuspencionData	Return additional data of the current suspension. If there is no current suspension the next in time is returned. true = Yes false = No (Default)
returnExtendedPremiumData	Return 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

Corresponding SOAP Service: getByReferenceDoc.

Response

The response is a JSON document containing an array of subscriptions.

JSON Subscription Order

Example

{
   "orderNumber": "4807309861",
   "dsbUrposLief": "000001",
   "publication": "00000310",
   "publicationName": "Publication",
   "edition": "00000310",
   "mixType": "01",
   "purchaseFrequency": "VA",
   "deliveryType": "DM",
   "orderStatus": "I",
   "isRenewal" : true,
   "isTimebased" : true,
   "orderCurrency": "GBP",
   "issueNrFrom": "000000265",
   "issueNrTo": "000000277",
   "issueNrFirstBill": "",
   "validFrom": "2014-03-08",
   "validTo": "2015-02-24",
   "endReason": "900",
   "promotionSource": "MP2123",
   "prSourceVar": "",
   "referenceDoc": "10995ABC123456789",
   "custOrderNumber": "",
   "custOrderDate": "2014-01-24",
   "subscrPhase": "IF1",
   "priceGroup": "",
   "priceKey": "CP02",
   "paymentMethod": "",
   "subOProcessedPMD": {
     "subPaymentMethod": "660",
     "subPaymentMethodText": "Method"
   },
   "billingFrequency": "Y1",
   "billingFrequencyShortDescription": "",
   "quantity": "1",
   "salesOrganization": "0100",
   "dsbMedia1": "",
   "dsbMedia2": "",
   "dsbMedia3": "",
   "dsbMedia4": "",
   "dsbMedia2b": "",
   "dsbMedia7": "",
   "agentNumber": "",
   "materialNumber": "",
   "premiumDescription": "",
   "premiumDispatchDate": null,
   "billingPayedTo": "",
   "issueNumberNextBill": "",
   "issueNumberFromLastBill": "",
   "issueNumberToLastBill": "",
   "currentDunningLevel": "00",
   "conditionTermCommitmentPeriod": "1",
   "conditionTermCancelationPeriod": "1",
   "conditionTermRenewal": "1",
   "salesSource": "REN1",
   "advertisingMedium": "MP2ED02",
   "salesDocumentType": "REN",
   "validFromEvt": "2014-02-25",
   "validToEvt": "2015-01-28",
   "validFromOnSaleDate": "2014-03-15",
   "validToOnSaleDate": "2015-02-15",
   "dispatchType": "",
   "dispatchText": "",
   "contractAccountBalance": "0.00",
   "postageKey": "DM",
   "productType": "ON",
   "isCombiSubscription": false,
   "renewal":    {
      "expiryDate": "2015-02-15",
      "expiryIssueNr": "000000277",
      "currentCycleNumberOfIssues": 13,
      "currentCycleExpiryDate": "2015-02-15",
      "currentCycleExpiryIssueNr": "000000277",
      "currentCycleStartDate": "2014-03-15",
      "currentCycleStartIssueNr": "000000265",
      "currentCycleAcceptanceDate": "2014-02-04",
      "currentCycleOffer": "ED1C2",
      "currentCycleOfferType": "RN",
      "currentCycleOfferDescription": "",
      "currentCycleOfferMarketingText": "",
      "currentCyclePaidAmount": "20.00",
      "currentCycleBundlePaidAmount": "0.00",
      "offerClassification": "",
      "offerClassificationDefinition": "",
      "orderCurrency": "GBP",
      "renewalDueDate": "2014-02-04",
      "numberIssuesRemaining": 0,
      "renewalBundleComponent" : "M",
      "autoRenewal": false,
      "autoRenewalNextPaymentAmount": 0,
      "autoRenewalNextPaymentFrequencyCode": "",
      "autoRenewalNextPaymentFrequencyText": "",
      "autoRenewalNextPaymentDate": null,
      "autoRenewalLastPaymentAmount": 0,
      "autoRenewalLastPaymentFrequencyCode": "",
      "autoRenewalLastPaymentFrequencyText": "",
      "autoRenewalLastPaymentDate": null,
      "autoRenewalActualClaimCounter": 2,
      "autoRenewalIncreaseClaimCounter": 0
   },
   "currentSuspension":    {
      "suspendedFromDate": null,
      "suspendedToDate": null,
      "suspendedFromIssueNr": "",
      "suspendedFromIssueDesc": "Description",
      "suspendedToIssueNr": "",
      "suspendedToIssueDesc": "Description",
      "suspendedReasonCode": ""
   },
   "currentChangeInfo":    {
      "futureMixType": null,
      "futureMixTypeFromIssueNr": null,
      "futureMixTypeToIssueNr": null,
      "formerMixType": null,
      "formerMixTypeToIssueNr": null,
      "futureDeliveryQuantity": null,
      "futureDeliveryQuantityFromIssueNr": null,
      "formerDeliveryQuantity": null,
      "formerDeliveryQuantityToIssueNr": null,
      "futureDeliveryType": null,
      "futureDeliveryTypeFromIssueNr": null,
      "formerDeliveryType": null,
      "formerDeliveryTypeToIssueNr": null,
      "futureDispatchType": null,
      "futureDispatchTypeFromIssueNr": null,
      "formerDispatchType": null,
      "formerDispatchTypeToIssueNr": null,
      "futureDispatchText": null,
      "futureDispatchTextFromIssueNr": null,
      "formerDispatchText": null,
      "formerDispatchTextToIssueNr": null
   },
   "bundles": [],
   "businessPartners": [],
   "orderAttributes":    [],
   "productSalesOrder" : {
     "status" : "",
     "statusDescription" : "",
     "positions" : [ {
       "positionNumber" : 1,
       "articleNumber" : "ABC",
       "externalArticleNumber" : "AY-32",
       "status" : "",
       "statusDescription" : "",
       "textVariant" : "",
       "articleDescription" : "",
       "activity" : "",
       "articleGroup" : ""
     }
     ]
   }}

Element Definitions

Field name	Type	Description
orderNumber	C	Subscription no.
dsbUrposLief	C	Reference to the original delivery position
publication	C	publication
publication-name	C	name of publication
edition	C	edition
mixType	C	mix-type
purchaseFrequency	C	Purchase frequency
deliveryType	C	delivery type
orderStatus	C	the status of the order
isRenewal	B	is this a renewal sub ?
isTimebased	B	is this a timebased Renewal-Sub (true/false) ?
orderCurrency	C	currency code of the subscription
issueNrFrom	C	Copy no. of first delivered distribution edition.
issueNrTo	C	Copy no. of last delivered distribution edition.
issueNrFirstBill	C	Copy no. of 1. invoice.
validFrom	D	Start of the of delivery.
validTo	D	Date of end of delivery, filled only when a subscription has been cancelled.
validFromEvt	D
validToEvt	D	Valid until EVT, whereas EVT means “first shipment date”.
validFromOnSaleDate	D	Valid from date
validToOnSaleDate	D	Valid to date
endReason	C	Reason for delivery stop. The values are client dependent.
promotionSource	C	Source code
prSourceVar	C	Source code-Variation
referenceDoc	C	Reference evidence. Comprises order number of the old system. Apart from that it is identical with the field order-number.
custOrderNumber	C	customer order number
custorderDate	D	The date where the customer order was entered into the system.
subscrPhase	C	phase where the subscription is at the moment
priceGroup	C	Price group of customer stipulates possible reductions on basic price.
priceKey	C	Price-key of customer Stipulates the basic price.
paymentMethod	C	Payment-method: E → payment per direct debit. K→ payment per credit card. R → payment per invoice. For foreign customers are probably further payment methods provided.
subOProcessedPMD
* subPaymentMethod	C	Subtype of Payment-method
* subPaymentMethodText	C	Subtype text of Payment-method
billingFrequency	C	billing frequency
billingFrequencyShortDescription	C	billing frequency short description
quantity	C	quantity
salesOrganization	C	Sales-organization
dsbMedia1	C	Field for free disposal. Is stored with the order.
dsbMedia2	C	Field for free disposal. Is stored with the order.
dsbMedia3	C	Field for free disposal. Is stored with the order.
dsbMedia4	C	Field for free disposal. Is stored with the order.
dsbMedia2b	C	Field for free disposal. Is stored with the order.
dsbMedia7	C	Field for free disposal. Is stored with the order.
agentNumber	C	Agent-number
materialNumber	C	Premium number (Material-number of goods premium)
premiumDescription	C	Premium description
premiumDispatchDate	C	Premium dispatch date
billingPayedTo	C	Billing-payed-to copy no.
issueNumberNextBill	C	Issue no. of next invoice
issueNumberFromLastBill	C	Issue no. from last bill
issueNumberToLastBill	C	Issue no. to last bill
currentDunningLevel	C	Current-dunning-level
conditionTermCommitmentPeriod	C	duration of commitment-period (regular cancellation after x months possible)
conditionTermCancelationPeriod	C	Terms of contract: cancellation-period
conditionTermRenewal	N	Terms of contract: extension of commitment-period
salesSource	C	Sales source
advertisingMedium	C	Advertising medium
salesDocumentType	C	Sales document type
dispatchType	C	Dispatch type
dispatchText	C	Dispatch text
contractAccountBalance	C	contract account balance \\Note! This value is only updated daily. In case of collective billing, the value could be added up from more than one contracts. negative leading sign = customer credit balance positive leading sign = bills receivable
postageKey	C
productType	C	BETA Kind of Medium (ON,….) Mapping should be requested with service MasterData.getMasterData
isCombiSubscription	B	BETA Is it a combi subscription true/false(default)
renewal
expiryDate	C	The date at the which the subscription as a whole, will expire.
expiryIssueNr	C	The last Issue number that the subscriber will receive.
renewalDueDate	C	Due date for next payment
numberIssuesRemaining	N	The number of issues, still to deliver. If the requestflag `returnRenewalIssueRemaining` is set to 'Y', the number of issues over the whole Subscription period is returned, otherwise, only the number of issues in the current cycle is returned.
currentCycleNumberOfIssues	N	The number of issues that are in the renewal cycle
currentCycleStartIssueNr	C	Issue number at the start of the renewal cycle.
currentCycleStartDate	C	Start date of the renewal cycle
currentCycleExpiryIssueNr	C	Issue number at the end of the renewal cycle.
currentCycleExpiryDate	C	End date of the renewal cycle
currentCycleAcceptanceDate	C	The date at which the subscriber accepted the renewal of their subscription.
currentCycleOffer	C	Offer from current cycle
currentCycleOfferType	C	Offer type of the offer from current cycle (RN, DD or BU)
currentCycleOfferDescription	C	Offer description of the offer from current cycle (if filled)
currentCycleOfferMarketingText	C	Marketingtext of the offer from current cycle (if filled)
offerClassification	C	Classification(Bundle, Membership, Normal etc.) B = bundle N = normal M = membership
offerClassificationDefinition	C	Offer classification definition
currentCyclePaidAmount	C	Amount of the current order cycle
currentCycleBundlePaidAmount	C	Amount of the whole bundle. Only relevant if it’s a valid bundled subscription
orderCurrency	C	Order currency
renewalBundleComponent	C	M = Master, S = Slave
autoRenewal	B	subscription is auto renewal (true/false)
autoRenewalNextPaymentAmount	C	Amount of the next collection in the regarding subscription currency
autoRenewalNextPaymentFrequencyCode	C	Frequency code of the next payment collection
autoRenewalNextPaymentFrequencyText	C	Frequency text/description of the next payment collection
autoRenewalNextPaymentDate	C	Date of the next payment collection
autoRenewalLastPaymentAmount	C	Amount of the last collection in the regarding subscription currency
autoRenewalLastPaymentFrequencyCode	C	Frequency code of the last payment collection
autoRenewalLastPaymentFrequencyText	C	Frequency text/description of the last payment collection
autoRenewalLastPaymentDate	C	Date of the last payment collection
autoRenewalActualClaimCounter	N	actual claim counter
autoRenewalIncreaseClaimCounter	N	increase claim counter
bundles
bundleOrderNumber	C	Order number of this bundled Element
publication	C	publication
edition	C	edition
quantity	N	quantity
currentSuspension
suspendedFromDate	C	Suspension from date
suspendedToDate	C	Suspension to date
suspendedFromIssueNr	C	Suspension from issue number
suspendedFromIssueDesc	C	Suspension from issue number description
suspendedToIssueNr	C	Suspension to issue number
suspendedToIssueDesc	C	Suspension to issue number description
suspendedReasonCode	C	Suspension reason code
currentChangeInfo		(to obtain this data, please contact your customer consultant. The customizing flag x_change_info must be set.)
futureMixType	C	Future mix type
futureMixTypeFromIssueNr	C	Issue nr. from
futureMixTypeToIssueNr	C	Issue nr. to
formerMixType	C	Former mix type
formerMixTypeToIssueNr	C	Issue nr. to
futureDeliveryQuantity	N	Future delivery quantity
futureDeliveryQuantityFromIssueNr	C	From issue nr
formerDeliveryQuantity	N	Former delivery quantity
formerDeliveryQuantityToIssueNr	C	To issue nr
futureDeliveryType	C	Future delivery type
futureDeliveryTypeFromIssueNr	C	From issue nr
formerDeliveryType	C	Former delivery type
formerDeliveryTypeToIssueNr	C	To issue nr.
futureDispatchType	C	Future dispatch type
futureDispatchTypeFromIssueNr	C	From issue nr.
formerDispatchType	C	Former dispatch type
formerDispatchTypeToIssueNr	C	To issue nr.
futureDispatchText	C	Future dispatch text
futureDispatchTextFromIssueNr	C	From issue nr.
formerDispatchText	C	Former dispatch text
formerDispatchTextToIssueNr	C	To issue nr.
productSalesOrder		productsales order data of orders that are read with the readProductSales option.
status	C
statusDescription	C
positions		productsales order positions
positionNumber	N
articleNumber	C
externalArticleNumber	C
status	C
statusDescription	C
textVariant	C
articleDescription	C
activity	C
articleGroup	C

businessPartners

JSON Business Partner

Example

{
      "role": "WE",
      "bpNumber": "1006346741",
      "fullSalutation": "Dear Mrs Customer",
      "lastName1": "Customer",
      "lastName2": "",
      "firstName": "Anne",
      "dateOfBirth": "",
      "fullLastName": "Customer",
      "nameAddition": "",
      "jobTitle": "",
      "title": "",
      "salutationCode": "02",
      "salutation": "Mrs",
      "company1": "",
      "company2": "",
      "company3": "",
      "department": "",
      "zipcode": "NN4 7BF",
      "street": "",
      "streetSuffix": "",
      "streetNumber": "",
      "streetNumberSuffix": "",
      "addressLine1": "1 Main Road",
      "addressLine2": "",
      "addressLine3": "",
      "regionCode": "NH",
      "regionText": "Northamptonshire",
      "fullStreet": "",
      "poBoxZipcode": "",
      "poBox": "",
      "poBoxCity": "",
      "majorCustZip": "",
      "city": "NORTHAMPTON",
      "district": "",
      "countryCode": "GB",
      "country": "United Kingdom",
      "advertisement": "Y",
      "blockTag": "N",
      "euSalesTaxNumber": "",
      "bicMasterNumber": "",
      "sector": "",
      "mobilePhoneNumber": "",
      "phoneNumber": "",
      "faxNumber": "",
      "emailAddress": "customer@example.com",
      "bpExtCommunication": [],
      "bpAttributes": [],
      "bpHolidayAddress": []
   }

Element Definitions

Field name	Description
role	C	Type of business partner. AG = orderer WE = consignee RE = invoice recipient
bpNumber	C	Business partner no.
fullSalutation	C	Mounted personal salutation
lastName1	C	Lastname 1
lastName2	C	Lastname 2
firstName	C	First-name
fullLastName	C	Mounted last-name
nameAddition	C	Name-addition, for example profession
jobTitle	C	Job title
title	C	Academic Title
salutationCode	C	Salutation-Code in AVS/3, For example 01 = Mr. 02 = Ms.
salutation	C	Salutation
company1	C	1. line of company address. If this field is filled is the above name the contact person of the firm.
company2	C	2. line of company address. Contains for example section or continuation of firm address.
company3	C	3. line of company address
department	C	department
zipcode	C	zipcode
street	C	Street with house no. and addition to house no.
streetSuffix	C	Addition to street
streetName	C	Street Name
streetNumber	C	Street Number
streetNumberSuffix	C	Street Number Suffix
addressLine1	C	Address line 1 for UK addresses
addressLine2	C	Address line 2 for UK addresses
addressLine3	C	Address line 3 for UK addresses
poBoxZipcode	C	Po-box-zipcode
poBox	C	Po-box
poBoxCity	C	Po-box-city
majorCustZip	C	Major-cust-zip
city	C	City
district	C	Addition of city
regionCode	C	Region-Code (federal state, province, county)
regionText	C	Region as cleartext (e.g. County…)
countryCode	C	Two letter ISO 3166-1 alpha-2 country-code
country	C	country
advertisement	C	Advertisement permitted; Y / N
blockTag	C	General block-tag ( X = put block-tag )
euSalesTaxNumber	C	EU sales tax id
dateOfBirth	D	Birthdate (YYYY-MM-DD)
bicMasterNumber	C	Partner-ID of master (for example company of contact person)
sector	C	branch
mobilePhoneNumber	C	Mobile Telephone-No.: pre code + termination
phoneNumber	C	Telephone no..: pre code + termination
faxNumber	C	Fax-No.: pre code + termination
emailAddress	C	IS-M: e-mail number
bpExtCommunication		Extended communication data (only with request parameter returnExtendedCommunicationData=true)
communicationType	C	Communication Types; Values
communicationValue	C	Communication value
communicationDefault	C	Default value Y / N

bpAttributes

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

bpHolidayAddress

Redirect addresses

JSON Attributes

Example

 "bpHolidayAddress": [
  {
	"validFrom": "2009-11-08",
	"validTo": "2009-12-08",
	"street": "",
	"streetNumber": "",
	"streetNumberSuffix": "",
	"zipcode": "",
	"zipcodeExtension": "",
	"city": "",
	"district": "",
	"poBox": "",
	"poBoxExtension": "",
	"poBoxZipcode": "",
	"poBoxCity": "",
	"majorCustZip": "",
	"majorCustZipExtension": "",
	"countryCode": ""
  },
  ...
]

Element Definition

Parameter	Type	Length	Description
validFrom	C	10	validity of the redirection
validTo	C	10	validity of the redirection
street	C	35	Street
streetNumber	C	10	Street number
streetNumberSuffix	C	8	Street number extension
zipcode	C	10	Zipcode
zipcodeExtension	C	4	Zipcode extension
city	C	35	City
district	C	35	District
poBox	C	35	Po box
poBoxExtension	C	4	Po box extension
poBoxZipcode	C	10	Po box zipcode
poBoxCity	C	35	Po box city
majorCustZip	C	10	Zipcode of company
majorCustZipExtension	C	4	Zipcode extension of company
countryCode	C	3	Country code

orderAttributes

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

Get By Order Attribute

Get subscriptions by an order attribute.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getByOrderAttribute-3.0.0
Fuba: /DSB/_ISM_E_SEL_MERKM

URL

GET: /rest/{client}/subscriptions/attributes

Parameter	Description
type	Type of the attribute
value	Value of the attribute

Additional common parameters

Parameter	Description
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
returnAddressTimepoint	Define wich address should be returned (mandatory) 'L' = Address at last shipment date 'A' = active address 'Z' = Address at future shipment date
returnExtendedCommunicationData	return extended communication data (true/false) Default: false
returnRenewalPaymentData	Return additional renewal payment data true = Yes false = No (Default)
returnRenewalIssueRemaining	true = Yes return remaining issues regarding the whole subscription Otherwise Return remaining isssues regarding the current cycle (Default)
returnCurrentSuspencionData	Return additional data of the current suspension. If there is no current suspension the next in time is returned. true = Yes false = No (Default)
returnExtendedPremiumData	Return 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

Corresponding SOAP Service: getByOrderAttribute.

Response

The response is a JSON document containing an array of subscriptions.

JSON Subscription Order

Example

{
   "orderNumber": "4807309861",
   "dsbUrposLief": "000001",
   "publication": "00000310",
   "publicationName": "Publication",
   "edition": "00000310",
   "mixType": "01",
   "purchaseFrequency": "VA",
   "deliveryType": "DM",
   "orderStatus": "I",
   "isRenewal" : true,
   "isTimebased" : true,
   "orderCurrency": "GBP",
   "issueNrFrom": "000000265",
   "issueNrTo": "000000277",
   "issueNrFirstBill": "",
   "validFrom": "2014-03-08",
   "validTo": "2015-02-24",
   "endReason": "900",
   "promotionSource": "MP2123",
   "prSourceVar": "",
   "referenceDoc": "10995ABC123456789",
   "custOrderNumber": "",
   "custOrderDate": "2014-01-24",
   "subscrPhase": "IF1",
   "priceGroup": "",
   "priceKey": "CP02",
   "paymentMethod": "",
   "subOProcessedPMD": {
     "subPaymentMethod": "660",
     "subPaymentMethodText": "Method"
   },
   "billingFrequency": "Y1",
   "billingFrequencyShortDescription": "",
   "quantity": "1",
   "salesOrganization": "0100",
   "dsbMedia1": "",
   "dsbMedia2": "",
   "dsbMedia3": "",
   "dsbMedia4": "",
   "dsbMedia2b": "",
   "dsbMedia7": "",
   "agentNumber": "",
   "materialNumber": "",
   "premiumDescription": "",
   "premiumDispatchDate": null,
   "billingPayedTo": "",
   "issueNumberNextBill": "",
   "issueNumberFromLastBill": "",
   "issueNumberToLastBill": "",
   "currentDunningLevel": "00",
   "conditionTermCommitmentPeriod": "1",
   "conditionTermCancelationPeriod": "1",
   "conditionTermRenewal": "1",
   "salesSource": "REN1",
   "advertisingMedium": "MP2ED02",
   "salesDocumentType": "REN",
   "validFromEvt": "2014-02-25",
   "validToEvt": "2015-01-28",
   "validFromOnSaleDate": "2014-03-15",
   "validToOnSaleDate": "2015-02-15",
   "dispatchType": "",
   "dispatchText": "",
   "contractAccountBalance": "0.00",
   "postageKey": "DM",
   "productType": "ON",
   "isCombiSubscription": false,
   "renewal":    {
      "expiryDate": "2015-02-15",
      "expiryIssueNr": "000000277",
      "currentCycleNumberOfIssues": 13,
      "currentCycleExpiryDate": "2015-02-15",
      "currentCycleExpiryIssueNr": "000000277",
      "currentCycleStartDate": "2014-03-15",
      "currentCycleStartIssueNr": "000000265",
      "currentCycleAcceptanceDate": "2014-02-04",
      "currentCycleOffer": "ED1C2",
      "currentCycleOfferType": "RN",
      "currentCycleOfferDescription": "",
      "currentCycleOfferMarketingText": "",
      "currentCyclePaidAmount": "20.00",
      "currentCycleBundlePaidAmount": "0.00",
      "offerClassification": "",
      "offerClassificationDefinition": "",
      "orderCurrency": "GBP",
      "renewalDueDate": "2014-02-04",
      "numberIssuesRemaining": 0,
      "renewalBundleComponent" : "M",
      "autoRenewal": false,
      "autoRenewalNextPaymentAmount": 0,
      "autoRenewalNextPaymentFrequencyCode": "",
      "autoRenewalNextPaymentFrequencyText": "",
      "autoRenewalNextPaymentDate": null,
      "autoRenewalLastPaymentAmount": 0,
      "autoRenewalLastPaymentFrequencyCode": "",
      "autoRenewalLastPaymentFrequencyText": "",
      "autoRenewalLastPaymentDate": null,
      "autoRenewalActualClaimCounter": 2,
      "autoRenewalIncreaseClaimCounter": 0
   },
   "currentSuspension":    {
      "suspendedFromDate": null,
      "suspendedToDate": null,
      "suspendedFromIssueNr": "",
      "suspendedFromIssueDesc": "Description",
      "suspendedToIssueNr": "",
      "suspendedToIssueDesc": "Description",
      "suspendedReasonCode": ""
   },
   "currentChangeInfo":    {
      "futureMixType": null,
      "futureMixTypeFromIssueNr": null,
      "futureMixTypeToIssueNr": null,
      "formerMixType": null,
      "formerMixTypeToIssueNr": null,
      "futureDeliveryQuantity": null,
      "futureDeliveryQuantityFromIssueNr": null,
      "formerDeliveryQuantity": null,
      "formerDeliveryQuantityToIssueNr": null,
      "futureDeliveryType": null,
      "futureDeliveryTypeFromIssueNr": null,
      "formerDeliveryType": null,
      "formerDeliveryTypeToIssueNr": null,
      "futureDispatchType": null,
      "futureDispatchTypeFromIssueNr": null,
      "formerDispatchType": null,
      "formerDispatchTypeToIssueNr": null,
      "futureDispatchText": null,
      "futureDispatchTextFromIssueNr": null,
      "formerDispatchText": null,
      "formerDispatchTextToIssueNr": null
   },
   "bundles": [],
   "businessPartners": [],
   "orderAttributes":    [],
   "productSalesOrder" : {
     "status" : "",
     "statusDescription" : "",
     "positions" : [ {
       "positionNumber" : 1,
       "articleNumber" : "ABC",
       "externalArticleNumber" : "AY-32",
       "status" : "",
       "statusDescription" : "",
       "textVariant" : "",
       "articleDescription" : "",
       "activity" : "",
       "articleGroup" : ""
     }
     ]
   }}

Element Definitions

Field name	Type	Description
orderNumber	C	Subscription no.
dsbUrposLief	C	Reference to the original delivery position
publication	C	publication
publication-name	C	name of publication
edition	C	edition
mixType	C	mix-type
purchaseFrequency	C	Purchase frequency
deliveryType	C	delivery type
orderStatus	C	the status of the order
isRenewal	B	is this a renewal sub ?
isTimebased	B	is this a timebased Renewal-Sub (true/false) ?
orderCurrency	C	currency code of the subscription
issueNrFrom	C	Copy no. of first delivered distribution edition.
issueNrTo	C	Copy no. of last delivered distribution edition.
issueNrFirstBill	C	Copy no. of 1. invoice.
validFrom	D	Start of the of delivery.
validTo	D	Date of end of delivery, filled only when a subscription has been cancelled.
validFromEvt	D
validToEvt	D	Valid until EVT, whereas EVT means “first shipment date”.
validFromOnSaleDate	D	Valid from date
validToOnSaleDate	D	Valid to date
endReason	C	Reason for delivery stop. The values are client dependent.
promotionSource	C	Source code
prSourceVar	C	Source code-Variation
referenceDoc	C	Reference evidence. Comprises order number of the old system. Apart from that it is identical with the field order-number.
custOrderNumber	C	customer order number
custorderDate	D	The date where the customer order was entered into the system.
subscrPhase	C	phase where the subscription is at the moment
priceGroup	C	Price group of customer stipulates possible reductions on basic price.
priceKey	C	Price-key of customer Stipulates the basic price.
paymentMethod	C	Payment-method: E → payment per direct debit. K→ payment per credit card. R → payment per invoice. For foreign customers are probably further payment methods provided.
subOProcessedPMD
* subPaymentMethod	C	Subtype of Payment-method
* subPaymentMethodText	C	Subtype text of Payment-method
billingFrequency	C	billing frequency
billingFrequencyShortDescription	C	billing frequency short description
quantity	C	quantity
salesOrganization	C	Sales-organization
dsbMedia1	C	Field for free disposal. Is stored with the order.
dsbMedia2	C	Field for free disposal. Is stored with the order.
dsbMedia3	C	Field for free disposal. Is stored with the order.
dsbMedia4	C	Field for free disposal. Is stored with the order.
dsbMedia2b	C	Field for free disposal. Is stored with the order.
dsbMedia7	C	Field for free disposal. Is stored with the order.
agentNumber	C	Agent-number
materialNumber	C	Premium number (Material-number of goods premium)
premiumDescription	C	Premium description
premiumDispatchDate	C	Premium dispatch date
billingPayedTo	C	Billing-payed-to copy no.
issueNumberNextBill	C	Issue no. of next invoice
issueNumberFromLastBill	C	Issue no. from last bill
issueNumberToLastBill	C	Issue no. to last bill
currentDunningLevel	C	Current-dunning-level
conditionTermCommitmentPeriod	C	duration of commitment-period (regular cancellation after x months possible)
conditionTermCancelationPeriod	C	Terms of contract: cancellation-period
conditionTermRenewal	N	Terms of contract: extension of commitment-period
salesSource	C	Sales source
advertisingMedium	C	Advertising medium
salesDocumentType	C	Sales document type
dispatchType	C	Dispatch type
dispatchText	C	Dispatch text
contractAccountBalance	C	contract account balance \\Note! This value is only updated daily. In case of collective billing, the value could be added up from more than one contracts. negative leading sign = customer credit balance positive leading sign = bills receivable
postageKey	C
productType	C	BETA Kind of Medium (ON,….) Mapping should be requested with service MasterData.getMasterData
isCombiSubscription	B	BETA Is it a combi subscription true/false(default)
renewal
expiryDate	C	The date at the which the subscription as a whole, will expire.
expiryIssueNr	C	The last Issue number that the subscriber will receive.
renewalDueDate	C	Due date for next payment
numberIssuesRemaining	N	The number of issues, still to deliver. If the requestflag `returnRenewalIssueRemaining` is set to 'Y', the number of issues over the whole Subscription period is returned, otherwise, only the number of issues in the current cycle is returned.
currentCycleNumberOfIssues	N	The number of issues that are in the renewal cycle
currentCycleStartIssueNr	C	Issue number at the start of the renewal cycle.
currentCycleStartDate	C	Start date of the renewal cycle
currentCycleExpiryIssueNr	C	Issue number at the end of the renewal cycle.
currentCycleExpiryDate	C	End date of the renewal cycle
currentCycleAcceptanceDate	C	The date at which the subscriber accepted the renewal of their subscription.
currentCycleOffer	C	Offer from current cycle
currentCycleOfferType	C	Offer type of the offer from current cycle (RN, DD or BU)
currentCycleOfferDescription	C	Offer description of the offer from current cycle (if filled)
currentCycleOfferMarketingText	C	Marketingtext of the offer from current cycle (if filled)
offerClassification	C	Classification(Bundle, Membership, Normal etc.) B = bundle N = normal M = membership
offerClassificationDefinition	C	Offer classification definition
currentCyclePaidAmount	C	Amount of the current order cycle
currentCycleBundlePaidAmount	C	Amount of the whole bundle. Only relevant if it’s a valid bundled subscription
orderCurrency	C	Order currency
renewalBundleComponent	C	M = Master, S = Slave
autoRenewal	B	subscription is auto renewal (true/false)
autoRenewalNextPaymentAmount	C	Amount of the next collection in the regarding subscription currency
autoRenewalNextPaymentFrequencyCode	C	Frequency code of the next payment collection
autoRenewalNextPaymentFrequencyText	C	Frequency text/description of the next payment collection
autoRenewalNextPaymentDate	C	Date of the next payment collection
autoRenewalLastPaymentAmount	C	Amount of the last collection in the regarding subscription currency
autoRenewalLastPaymentFrequencyCode	C	Frequency code of the last payment collection
autoRenewalLastPaymentFrequencyText	C	Frequency text/description of the last payment collection
autoRenewalLastPaymentDate	C	Date of the last payment collection
autoRenewalActualClaimCounter	N	actual claim counter
autoRenewalIncreaseClaimCounter	N	increase claim counter
bundles
bundleOrderNumber	C	Order number of this bundled Element
publication	C	publication
edition	C	edition
quantity	N	quantity
currentSuspension
suspendedFromDate	C	Suspension from date
suspendedToDate	C	Suspension to date
suspendedFromIssueNr	C	Suspension from issue number
suspendedFromIssueDesc	C	Suspension from issue number description
suspendedToIssueNr	C	Suspension to issue number
suspendedToIssueDesc	C	Suspension to issue number description
suspendedReasonCode	C	Suspension reason code
currentChangeInfo		(to obtain this data, please contact your customer consultant. The customizing flag x_change_info must be set.)
futureMixType	C	Future mix type
futureMixTypeFromIssueNr	C	Issue nr. from
futureMixTypeToIssueNr	C	Issue nr. to
formerMixType	C	Former mix type
formerMixTypeToIssueNr	C	Issue nr. to
futureDeliveryQuantity	N	Future delivery quantity
futureDeliveryQuantityFromIssueNr	C	From issue nr
formerDeliveryQuantity	N	Former delivery quantity
formerDeliveryQuantityToIssueNr	C	To issue nr
futureDeliveryType	C	Future delivery type
futureDeliveryTypeFromIssueNr	C	From issue nr
formerDeliveryType	C	Former delivery type
formerDeliveryTypeToIssueNr	C	To issue nr.
futureDispatchType	C	Future dispatch type
futureDispatchTypeFromIssueNr	C	From issue nr.
formerDispatchType	C	Former dispatch type
formerDispatchTypeToIssueNr	C	To issue nr.
futureDispatchText	C	Future dispatch text
futureDispatchTextFromIssueNr	C	From issue nr.
formerDispatchText	C	Former dispatch text
formerDispatchTextToIssueNr	C	To issue nr.
productSalesOrder		productsales order data of orders that are read with the readProductSales option.
status	C
statusDescription	C
positions		productsales order positions
positionNumber	N
articleNumber	C
externalArticleNumber	C
status	C
statusDescription	C
textVariant	C
articleDescription	C
activity	C
articleGroup	C

businessPartners

JSON Business Partner

Example

{
      "role": "WE",
      "bpNumber": "1006346741",
      "fullSalutation": "Dear Mrs Customer",
      "lastName1": "Customer",
      "lastName2": "",
      "firstName": "Anne",
      "dateOfBirth": "",
      "fullLastName": "Customer",
      "nameAddition": "",
      "jobTitle": "",
      "title": "",
      "salutationCode": "02",
      "salutation": "Mrs",
      "company1": "",
      "company2": "",
      "company3": "",
      "department": "",
      "zipcode": "NN4 7BF",
      "street": "",
      "streetSuffix": "",
      "streetNumber": "",
      "streetNumberSuffix": "",
      "addressLine1": "1 Main Road",
      "addressLine2": "",
      "addressLine3": "",
      "regionCode": "NH",
      "regionText": "Northamptonshire",
      "fullStreet": "",
      "poBoxZipcode": "",
      "poBox": "",
      "poBoxCity": "",
      "majorCustZip": "",
      "city": "NORTHAMPTON",
      "district": "",
      "countryCode": "GB",
      "country": "United Kingdom",
      "advertisement": "Y",
      "blockTag": "N",
      "euSalesTaxNumber": "",
      "bicMasterNumber": "",
      "sector": "",
      "mobilePhoneNumber": "",
      "phoneNumber": "",
      "faxNumber": "",
      "emailAddress": "customer@example.com",
      "bpExtCommunication": [],
      "bpAttributes": [],
      "bpHolidayAddress": []
   }

Element Definitions

Field name	Description
role	C	Type of business partner. AG = orderer WE = consignee RE = invoice recipient
bpNumber	C	Business partner no.
fullSalutation	C	Mounted personal salutation
lastName1	C	Lastname 1
lastName2	C	Lastname 2
firstName	C	First-name
fullLastName	C	Mounted last-name
nameAddition	C	Name-addition, for example profession
jobTitle	C	Job title
title	C	Academic Title
salutationCode	C	Salutation-Code in AVS/3, For example 01 = Mr. 02 = Ms.
salutation	C	Salutation
company1	C	1. line of company address. If this field is filled is the above name the contact person of the firm.
company2	C	2. line of company address. Contains for example section or continuation of firm address.
company3	C	3. line of company address
department	C	department
zipcode	C	zipcode
street	C	Street with house no. and addition to house no.
streetSuffix	C	Addition to street
streetName	C	Street Name
streetNumber	C	Street Number
streetNumberSuffix	C	Street Number Suffix
addressLine1	C	Address line 1 for UK addresses
addressLine2	C	Address line 2 for UK addresses
addressLine3	C	Address line 3 for UK addresses
poBoxZipcode	C	Po-box-zipcode
poBox	C	Po-box
poBoxCity	C	Po-box-city
majorCustZip	C	Major-cust-zip
city	C	City
district	C	Addition of city
regionCode	C	Region-Code (federal state, province, county)
regionText	C	Region as cleartext (e.g. County…)
countryCode	C	Two letter ISO 3166-1 alpha-2 country-code
country	C	country
advertisement	C	Advertisement permitted; Y / N
blockTag	C	General block-tag ( X = put block-tag )
euSalesTaxNumber	C	EU sales tax id
dateOfBirth	D	Birthdate (YYYY-MM-DD)
bicMasterNumber	C	Partner-ID of master (for example company of contact person)
sector	C	branch
mobilePhoneNumber	C	Mobile Telephone-No.: pre code + termination
phoneNumber	C	Telephone no..: pre code + termination
faxNumber	C	Fax-No.: pre code + termination
emailAddress	C	IS-M: e-mail number
bpExtCommunication		Extended communication data (only with request parameter returnExtendedCommunicationData=true)
communicationType	C	Communication Types; Values
communicationValue	C	Communication value
communicationDefault	C	Default value Y / N

bpAttributes

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

bpHolidayAddress

Redirect addresses

JSON Attributes

Example

 "bpHolidayAddress": [
  {
	"validFrom": "2009-11-08",
	"validTo": "2009-12-08",
	"street": "",
	"streetNumber": "",
	"streetNumberSuffix": "",
	"zipcode": "",
	"zipcodeExtension": "",
	"city": "",
	"district": "",
	"poBox": "",
	"poBoxExtension": "",
	"poBoxZipcode": "",
	"poBoxCity": "",
	"majorCustZip": "",
	"majorCustZipExtension": "",
	"countryCode": ""
  },
  ...
]

Element Definition

Parameter	Type	Length	Description
validFrom	C	10	validity of the redirection
validTo	C	10	validity of the redirection
street	C	35	Street
streetNumber	C	10	Street number
streetNumberSuffix	C	8	Street number extension
zipcode	C	10	Zipcode
zipcodeExtension	C	4	Zipcode extension
city	C	35	City
district	C	35	District
poBox	C	35	Po box
poBoxExtension	C	4	Po box extension
poBoxZipcode	C	10	Po box zipcode
poBoxCity	C	35	Po box city
majorCustZip	C	10	Zipcode of company
majorCustZipExtension	C	4	Zipcode extension of company
countryCode	C	3	Country code

orderAttributes

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

Get Issues By Order Number

Get the future issues of a subscription until the given end date.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getIssuesByOrderNumber-2.0.0
Fuba: /DSB/_ISM_E_GET_VA_AUFTR

URL

GET: /rest/{client}/subscriptions/{orderNumber}/issues

Parameter	Description
orderNumber	subscription order number
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)
filter	see below (mandatory)
date-from	Start date Format YYYY-MM-DD (default ist today)
date-to	End date Format YYYY-MM-DD (mandatory)
date-type	Type of both date values: 1: On Sale Date 2: Issue Label Run Date (not yet implemented!) 3: Technical Issue Date (default)
entitlementType	type of entitlement
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

Filter	Rule
A	All issues will be returned till the optional 'date-to'(mandatory)
E	If the subscription is a renewal(REN), it only returns, if X_IN_EXPIRY_PERIOD = true(X). Otherwise if the subscription is a „normal“ one(ABO/ABOS), it only returns if X_IN_DELIVERY_PERIOD = true(X). Optional till the provided ‚date-to‘ value.(mandatory)
C	Only the issues will be returned, that matches the “calculated” filter till the optional 'date-to'(mandatory)
P	Only the issues will be returned, that matches the “pa” filter till the optional 'date-to' (mandatory)
NO_DOUBLE_ISSUE[DOUBLE_ISSUE=XX]	Filter Double Issue - all Double Issues with DOUBLE_ISSUE=XX will not be displayed. Example: filter=NO_DOUBLE_ISSUE[DOUBLE_ISSUE=2](optional)

Corresponding SOAP Service: getIssuesByOrderNumber.

Response

The response is a JSON document containing the issue data.

JSON Extended Issue

Example

{
   "orderType": "REN",
   "productType": "ON",
   "isCombiSubscription": false,
   "listOfIssueExt": []
}

Element Definitions

Field name	Type	Description
orderType	C	Type of order (REN, ABO, ABOS)
productType	C	BETA Kind of Medium (ON,….) Mapping should be requested with service MasterData.getMasterData
isCombiSubscription	B	BETA Is it a combi subscription true/false(default)
listOfIssueExt
see below

JSON Issue

Example

[{
      "issue": "0000028758",
      "publication": "00000310",
      "edition": "00000310",
      "dateOfPublication": "2014-03-08",
      "yearOfIssue": 2014,
      "issueNumberInYear": "0003",
      "issueNumber": "000000265",
      "ean": "",
      "dateOfFirstSale": "2014-03-15",
      "description": "APRIL 2014",
      "entitlementId": "1234",
      "mixType": "",
      "distributionArticleNumber": null,
      "dateOfFirstShipping": "2014-02-25"
 }]

Element Definitions

Field name	Type	Description
issue	C	issue
publication	C	publication
edition	C	edition
dateOfPublication	D	date of publication im Format YYYY-MM-DD
yearOfIssue	C	year of issue Format YYYY
issueNumberInYear	C	issue number in year
issueNumber	C	Issue-number of edition in format HHHH/YYYY.
distribution-article-number	C	article number
mixType	C	mixtype
ean	D	Issues european article number
dateOfFirstSale	D	Date-of-first-sale- in format YYYY-MM-DD
dateOfFirstShipping	D	Date-of-first-shipping- in format YYYY-MM-DD
description	C	Description
entitlementId	C	entitlement id
isPayed	B	issue is payed
isCalculated	B	issue is calculated
isInExpiryPeriod	B	issue is in expiry period

Get Delivered Issues

Get the delivered issues of a subscription.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getDeliveredIssuesByOrderNumber-2.0.0
Fuba: /DSB/_ISM_E_GET_GELIEF_HEFTE

URL

GET: /rest/{client}/subscriptions/{orderNumber}/delivered-issues

Parameter	Description
orderNumber	subscription order number
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)
date-from	Start date Format YYYY-MM-DD
date-type	Type of the date value: 1: On Sale Date 2: Issue Label Run Date 3: Technical Issue Date (default)
show-grace-issues	“Grace-issues”
entitlementType	entitlement type

Corresponing SOAP Service: getDeliveredIssuesByOrderNumber.

Response

The response is a JSON document containing an array of issue data.

JSON Delivered Issue

Example

[{
      "issue": "0000028758",
      "publication": "00000310",
      "edition": "00000310",
      "dateOfPublication": "2014-03-08",
      "yearOfIssue": 2014,
      "issueNumberInYear": "0003",
      "issueNumber": "000000265",
      "ean": "",
      "dateOfFirstSale": "2014-03-15",
      "description": "APRIL 2014",
      "entitlementId": "1234"
      "mixType": "",
      "dateOfFirstShipping": "2014-02-25"
      "plannedVariantType" : "",
      "actualVariantType" : "",
      "dateOfProgramStart" : "",
      "specialIssue" : "",
      "doubleIssue" : "",
      "invoiceAttached" : "",
      "premiumAddressVariant" : "",
      "statisticalYearMonth" ; ""
 }]

Element Definitions

Field name	Type	Description
issue	C	issue
publication	C	publication
edition	C	edition
dateOfPublication	D	date of publication im Format YYYY-MM-DD
yearOfIssue	C	year of issue Format YYYY
issueNumberInYear	C	issue number in year
issueNumber	C	Issue-number of edition in format HHHH/YYYY.
mixType	C	mixtype
ean	D	Issues european article number
dateOfFirstSale	D	Date-of-first-sale- in format YYYY-MM-DD
dateOfFirstShipping	D	Date-of-first-shipping- in format YYYY-MM-DD
description	C	Description
entitlementId	C	entitlement id
plannedVariantType	C	Standard issue variant type (planned)
actualVariantType	C	Actual issue variant type
dateOfProgramStart	C	Progrm start of for example TV Magazines
specialIssue	C	Special issue
doubleIssue	C	DoubleCopy ID
invoiceAttached	C	Flag for invoice attachement to this issue
premiumAddressVariant	C	Premium Address Variant for Press Mailing
statisticalYearMonth	C	Statistical year month

Get the payment details of a subscription.

Path mapping(intern): /net/dsb/avs3/PaymentDetails/getBySubscriptionOrderNumber-1.0.0
Fuba: /DSB/ISM_E_GET_ZAHLWEG

URL

GET: /rest/{client}/subscriptions/{orderNumber}/payment-details

Parameter	Description
orderNumber	subscription order number
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)
returnInvalidCC	return invalid credi card data? (true/false= default)

Corresponding SOAP Service: PaymentDetails::getBySubscriptionOrderNumber.

Response

Cancel a subscription.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/cancel-1.0.0
Fuba: /DSB/_ISM_E_REN_CANCEL

URL

POST: /rest/{client}/subscriptions/{orderNumber}

Parameter	Description
client	client id
orderNumber	subscription order number
sp	service provider. (mandatory if the user account can use different service provider values)
cancel-reason	reason code of cancellation (mandatory)
cancel-type	type of cancellation (mandatory): V (cancel at the end of the current period) or A (cancel immediately)
trigger-message	if true, ccb Suite will send out cancellation ack email / letter (default: false)
refund	if true, the remaining amount will be refunded automatically.

Corresponding SOAP Service: cancel.

Response

The response is a JSON document containing the result.

Element	Description
expiry-date	date of expiry
expiry-description	description of expiry
cancellation-pending	If true, the cancellation can't be processed immediately. It will be triggered in and processed automatically within the next 7 days.
message	response message
success	true/false

Replaces an issue.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/replaceIssue-2.0.0
Fuba: /DSB/ISM_E_BATCHSCHNITTSTELLE

URL

POST: /rest/{client}/subscriptions/{orderNumber}/replaceIssue

Parameter	Description
client	client id
orderNumber	subscription order number
sp	service provider. (mandatory if the user account can use different service provider values)

Request

The Body of the Post Request contains a JSON document with this elements:

{
  "simulation": "Y",
  "issue-number": "0004/2020",
  "publication": "00069822",
  "edition": "00069822"
}

Element	Description
publication	Publication of the issue.
edition	Edition of the issue.
issue-number	Issue number.
soft-check	Omit business rules? Y = Yes(Only Inventory/Stock check will be processed) N = No(default, all business rules will be processed)
primary-pos-delivery
change-user
simulation	Simulation of process only Y = Yes (run the program Programm, response gets created but no back issue is triggered) N = No (default, productive processing is executed)

Response

Corresponding SOAP Service: replaceIssue.

Create a new subscription. This service is buffered. To transfer the subscription into the backend system an additional transfer job must be provided. Please request this job from your dsb account manager.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/createOrderBuffered-2.0.0
Fuba: /DSB/ISM_E_KAPSELABOANLAGE

URL

POST: /rest/{client}/subscriptions

Parameter	Description
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 use some sales orgas of the client)

Request Body

The Body of the Post Request contains a JSON document with a subscription.

JSON New Subscription Order

Example

{
    "promotionSource" : "WEBSHOP",
    "offerCode" : "BAR1",
    "publication" : "00000100",
    "edition" : "00000100",
    "mixType" : "01",
    "quantity" : "1",
    "customerPurchaseOrderType" : "I",
    "issueNumberFrom" : "000006880",
    "paymentMethod" : "K",
    "totalPaidCurrencyCode" : "GBP",
    "totalPaidAmount" : 795.00,
    "walletPartPaymentAmount" : 0.00,
    "currencyCode" : "GBP",
    "priceListType" : "01",
    "fixedPriceListAndCurrencyCode" : true,
    "externalOrderNumber" : "93-2",
    "inputOffice" : "IMM-INPUT",
    "inputDate" : "2017-04-19",
    "inputUser" : "SYS-RFC",
    "saveInSystem" : true,
    "matriculatedTo" : "2019-01-20",
    "saveInSystem" : true,
    "postAtOnce" : false,
    "skipDoiProcess" : false,
    "dsbEPaymentGuid" : "ac5f2111-d2ff-402e-b760-5d4e67d19b6f",
    "extraPayVoucher" : {
        "bankClearingAccount" : "voucher2",
        "amount" : 12.45,
        "currencyCode" : "GBP",
        "payeeNote" : "Test Voucher 2"
    },
    "subscriptionRenewal" : {
        "automaticRenewal" : false
    },
    "utmParameters": {
	"source" : "Facebook",
	"medium" : "popup",
	"campaign" : "Test"
    },
    "bpRelations" : [ {
          "role" : "AG",
          "bp" : {...}
    }],
    "premium": [{
      "materialNumber": "TestGIFT",
      "role": "VM",
      "referral": true
    }],
    "orderAttribute" : [],
    "offerPhases" : [
        {
         "phase" : 1,
         "numberOfClaims" : 9999,
         "billingFrequency" : "M2",
         "priceKey" : "MIG1",
         "price" : 100,
         "currency" : "EUR",
         "numberFreeIssues" : 0,
         "priceBundleSlave1" : 0,
         "priceBundleSlave2" : 0,
         "priceBundleSlave3" : 0,
         "freeCycle" : false,
         "rightDefinition" : "TestRecht"
        }
    ]
}

More examples

Element Definitions

Field name	Type	Max. Length	Description
promotionSource	C	10	Source code (mandatory)
promotionSourceVariant	C	1	Promotion-source-variant
salesPromotion	C	8	Sales-promotion (Mandatory if several sales-promotions have been set up for a BQ so it must be told which one can be used)
advertisingLevel	N	2	Advertising level of the accepted offer(0-99 )
offerCode	C	5	(renewal-)offer code
publication	C	8	publication (if blank, publication is derived from source code)
edition	C	8	edition (if blank, edition is derived from publication)
mixType	C	2	mix-type. Value is dependent on client Values can be 01 = full sub, 10 = with CD, 11 = with DVD Please discuss this with customer service. If blank, then automatic determination from publication.
purchaseFrequency	C	2	Purchase-frequency. Mandatory, if it is not clear for the client. Possible values are: VA = full sub; Other values are client specific.
deliveryType	C	2	Delivery-type
quantity	N		Quantity of customer order-publisher-Position-division. Default is 1.
salesOrganization	C	4	Sales-organization. If not set it is derived from the source code or edition. Mandatory if it can't be derived.
salesSuborganization	C	5	sub organization of vkorg
salesBureau	C	4	Sales-bureau, based on the field „input-user“. otherwise: 0001. Other values are client specific.
distributionChannel	C	2	Distribution-channel. Mandatory, if the value can not be clearly derived out of the publication (field ‚publication‘).
division	C	2	Division. Mandatory, if the value can not be derived out of the publication (field ‚publication‘).
customerPurchaseOrderNumber	C	20	Customer-purchase-order no.
customerPurchaseOrderType	C	4	Order type of customer, e.g. ‚I‘ → Internet; ‚T‘ → by telephone
customerPurchaseOrderDate	D		Customer purchase order date
validFrom	D		Date of first delivery of issue. This field and “issueNumberFrom” are mutal exclusive.
validTo	D		Date of last delivery of issues. This field and “issue-number-to are mutal exclusive.
issueNumberFrom	C	9	Issue number of first delivered issue. Default Format: HHHH/YYYY or any other client specific format /free text. Default: next copy in dispatch. This field and “valid-from” are mutal exclusive.
issueNumberTo	C	9	Issue number of last delivered issue. Default Format: HHHH/YYYY or any other client specific format /free text. Default: unlimited respectively the registered period in BQ. This field and “valid-to” are mutal exclusive.
archiveReference	C	20	Reference Number
paymentMethod	C	1	Payment-method (mandatory) (Codes)
payMethodDetails
* cheque
* bankClearingAccount	C	10	Bank clearing account (mandatory)
* chequeNumber	C	13	Cheque number (mandatory)
* amount	N		Amount in transaction currency (mandatory)
* currencyCode	C	3	ISO Currency code (mandatory)
* bankCode	C	15	Bank code
* bankControlKey	C	2	Bank control key
* bankCountryCode	C	2	Bank country code
* bankAccountNumber	C	18	Bank account number
* other
* bankClearingAccount	C	10	Bank clearing account
* amount	N		Amount in transaction currency
* currencyCode	C	3	Currency code
* payeeNote	C	80	Payee note
totalPaidCurrencyCode	C	3	Currency code (only in use for renewal)
totalPaidAmount	N		Paid amount (only in use for renewal)
walletPartPaymentAmount	N		amount paid by voucher (only in use for renewal)
extraPayDiscount
* currencyCode	C	3	Currency code for discount/extra-pay (only in use for renewal)
* discount	N		discount
* extraPay	N		extra pay
extraPayVoucher `BETA`
* bankClearingAccount	C	10	`BETA` Bank clearing account,must, if structure 'extraPayVoucher' denoted
* amount	N	9,2	`BETA` Amount in transaction currency, must, if structure 'extraPayVoucher' denoted
* currencyCode	C	3	`BETA` Currency code, must, if structure 'extraPayVoucher' denoted Currency as ISO-Code EUR Euro CHF Schweizer Franken GBP Great British Pound etc.
* payeeNote	C	80	`BETA` Payee note, can, if structure 'extraPayVoucher' denoted
printInvoice	B		Mark print invoice
purchaseReason	C	3	Purchase reason
deliveryEndReason	C	3	Delivery end reason
billingFrom	D		Date of beginning of payment
issueBillingFrom	C	9	Copy no., from which it should be billed
currencyCode	C	3	Currency as ISO-Code
priceListType	C	2	Price-list-type
fixedPriceListAndCurrencyCode	B		don't change the submitted price and currency code (Default: false)
debitAccounts
* debitAccountId	C	4	debit account id
* debitBankCode	C	15	Debit-bank-code (debitBankCode or bic is mandatory)
* debitCountryCode	C	2	ISO-country code of bank
* debitAccountNumber	C	18	Debit account number (debitAccountNumber or iban is mandatory)
* debitAccountHolder	C	60	Name of account holder (mandatory)
* debitContinuous	B		Is there a direct debit mandate? (mandatory)
* debitDueDate	C	2	due day for direct-debit Day of month (0-31) (mandatory)
* iban	C	34	International bank account nummer (debitAccountNumber or iban is mandatory)
* bic	C	11	Bank identifier code (debitBankCode or bic is mandatory)
sepaMandate
* creationType	C	1	„ “ = no mandate created „N“ = Create new mandate „T“ l= Mandate change(currently not to use) „M“ = Mandate migration(currently not to use)
* transactionType	C	1	„1“ = 1x Mandate „N“ = Multiple Mandate (default)
* sepaDetails
* b2bMandante	B		B2B-Mandate (currently not supported)
* mandateRefPerCreditor	C	35	Unique reference to mandate per creditor / previous mandate id (only in conjunction with creationType „T“ and „M“)
* previousCreditorId	C	35	Creditor identifier(unique accross country) / previous creditor id (only in conjunction with creationType „T“ and „M“)
* previousBic	C	11	Previous BIC-Code ((only in conjunction with creationType „T“ and „M“)
* lastDueDate	C
priceKeyInTrialterm	C	4	Price-key-in-trialterm
billingFrequencyInTrialterm	C	2	Billing-frequency-in-trialterm billing frequency
priceGroupInTrialterm	C	2	Price-group-in-trialterm
durationInTrialterm	C	3	Duration-in-trialterm
unitInTrialterm	C	3	Unit-in-trialterm, For example.: MON months, WCH weeks, TAG days
priceKeyInNormalterm1	C	4	Price-key-in-normalterm 1
billingFrequencyInNormalterm1	C	2	Billing-frequency-in-normalterm 1 billing frequency
priceGroupInNormalterm1	C	2	Price-group-in-normalterm1
durationInNormalterm1	C	3	Duration-in-normalterm1
unitInNormalterm1	C	3	Unit-in-normalterm 1, For example.: MON months, WCH weeks, TAG days
priceKey	C	4	Price-key of normalterm
billingFrequency	C	2	billing frequency of normalterm
priceGroup	C	2	Price-group of normalterm
duration	C	3	Duration of normalterm
unit	C	3	Unit of duration of normalterm. For example.: MON months, WCH weeks, TAG days
postageKey	C	30	Postage-key (dispatch costs investigation) If a postage-key is available, it is transferred “fix” into the backend system, without any customization changes configured in the AVS/3 system. If you want to use the optimization from the backend, the postage-key can be easily transferred empty.
dsbMedia1	C	1	Field for free disposal. Is stored to the order.
dsbMedia2	C	2	Field for free disposal. Is stored to the order.
dsbMedia3	C	3	Field for free disposal. Is stored to the order.
dsbMedia4	C	4	Field for free disposal. Is stored to the order.
dsbMedia2b	C	2	Field for free disposal. Is stored to the order.
dsbMedia7	C	7	Field for free disposal. Is stored to the order.
ruleId	C	3	Unique Identification Number of a matching rule for order validation. empty field = Any existing rule ID is taken from the BQ. Field value is 999 = do not apply a rule (any existing rule ID from the BQ is not used)
externalOrderNumber	C	35	External-order-number. (mandatory) This field prevents duplicate recordings in the OAA. This field contains a unique external order no. The value is NOT stored in AVS/3 and cannot be used as a external reference. Please use a order-attribute for this purpose instead.
inputOffice	C	12	Input-office (mandatory)
inputDate	D		Input-date (mandatory)
inputUser	C	12	Input-user (mandatory)
stackName	C	17	Stack-name (only with createDirect requests)
saveInSystem	B		Commit data or is this just a transmission test. (mandatory)
postAtOnce	B		Should the data be registered immediately or manually by a consultant. (mandatory)
skipDoiProcess	B		Should the double opt in process be skipped? Default is false. Only relevant with client that use the doi process.
adjustUpperAndLowerCase	B		‚true‘ Address data is changed from only capital letters or only small letters into capital and small letters. (Default) ‚false‘ Spelling of the address remains.
orderRating	B		is order rating active (default: true)
stackLockCode	C	1	Stack lock code, W= webservice; F=file (only in createDirect requests)
agentNumber	C	10	External agent-number
agentOrganisation	C	5	external agent-organisation
costCenter	C	10	Cost-center
matriculated	B		Is matriculation certification available
matriculatedTo	D		Matriculated-to (mandatory if matriculated)
advanceBilling	B	bill in advance (default: false)
previouslyBilledTo	D		„billed to“ date in previous system
issuePreviouslyBilledTo	C	9	Copy no. “billed to” in pre-system
deliveryStartStatistical	D		Date for statistical delivery start
issueDeliveryStartStatistical	C	9	Copy no. for statistical delivery start
dispatchType	C	2	Dispatch-type. LP = air-mail
dispatchText	C	5	Dispatch-text
ivwGroup	C	2	Special group for ivw evaluation
statisticGroup	C	2	Token of statistic-group
conditionTermCommitmentPeriod	N	2	Duration of commitment-period (regular cancellation after x Months possible)
conditionTermCancellationPeriod	N	2	period of notice
conditionTermRenewal	N	2	renewal of bounded time limit
dsbEPaymentGuid	C	36	Authorisation-GUID in the dsb-Webservice environment. Contains the id from a previous notify request (for example notifyCardTransactionWithWirecard)
dsbTrxIdForSolvencyCheck	C	36	Solvency-GUID in the dsb-WSI
bpRelations
* role	C	2	business partner role
* bp			business partner (see below)
subscriptionRenewal
* renewalOrderNumber	C	10	renewal order-number
* automaticRenewal	B		automatic renewal
utmParameters
* source	C	30	UTM Parameter
* medium	C	30	UTM Parameter
* campaign	C	30	UTM Parameter
premium
* role	C	2	Partner role who gets the premium
* materialNumber	C	18	Material-number of premium
* referral	B		Receives gift because of referral - true/false(default)
premiumPayment
* paymentMethod	C	1
* debitAccount
* ccAccount
orderAttribute
coreWbzCondition
* wbzWkz	C	1	promotion charge benefit
* wbzWkzFix	B		WKZ-Key fixed
* wbzCondition	C	3	WBZ-Condition
offerPhases **			Angebots Phasen
* phase	N	1	Offer phase
* numberOfClaims	N	4	Number of claims in renewal phase
* billingFrequency	C	2	Billing frequency
* priceKey	C	2	Price key subscription
* price	N	8,2	Price
* currency	C	5	Currency
* numberFreeIssues	N	3	Number of free issues
* priceBundleSlave1	N	13,2
* priceBundleSlave2	N	13,2
* priceBundleSlave3	N	13,2
* freeCycle	C	1	Free cycle
* rightDefinition	C	255	Right definition

businessPartners

JSON Business Partner

Example

{
    "salutationCode" : "01",
    "lastName1"  : "Y",
    "firstName"  : "X",
    "addressLine1" : "Blitz Media Ltd, Unit 1, Torfaen Bu",
    "zipcode" : "N1C 4AP",
    "countryCode" : "GB",
    "city" : "LONDON",
    "bpCommunicationsList" : [
        {
            "communicationType" : "T",
            "communicationValue" : "123"
        }
    ],
    "bpAttributesList" : [],
    "avsAttributes" : {
	"salesOrganization" : "0100",
	"distributionChannel" : "01",
	"division" : "01"
    }
}

Element Definitions

Field name	Type	Length	Description
bpNumber	C	10	Business partner no.
lastName1	C	35	Lastname 1
lastName2	C	35	Lastname 2
firstName	C	35	First-name
nickName	C	35
jobTitle	C	35	Job title
salutationCode	C	2	Salutation-Code in AVS/3, For example 01 = Mr. 02 = Ms.
prefix	C	4
titleCodeAcademic	C	4	Academic title code, e.g. 0027 = Dr
titleAcademic	C	15	Academic Title, e.g. Dr.
titleCodeRoyal	C	4	Royal title code
titleRoyal	C	15	Royal title
company1	C	40	1. line of company address. If this field is filled is the above name the contact person of the firm.
company2	C	40	2. line of company address. Contains for example section or continuation of firm address.
company3	C	40	3. line of company address
department	C	30	department
zipcode	C	10	zipcode
street	C	50	Street with house no. and addition to house no.
streetSuffix	C	40	Addition to street
streetNumber	C	10	Street Number
streetNumberSuffix	C	10	Street Number Suffix
addressLine1	C	35	Address line 1 for UK addresses
addressLine2	C	35	Address line 2 for UK addresses
addressLine3	C	35	Address line 3 for UK addresses
poBoxZipcode	C	10	Po-box-zipcode
poBox	C	10	Po-box
poBoxCity	C	40	Po-box-city
poBoxCountryCode	C	2	Po-box-country-code
majorCustomerZipcode	C	10	Major-cust-zip
city	C	40	City
district	C	40	Addition of city
regionCode	C	3	Region-Code (federal state, province, county)
regionText	C	25	Region as cleartext (e.g. County…)
countryCode	C	2	Two letter ISO 3166-1 alpha-2 country-code
advertisement	C	1	Advertisement permitted; Y / N
block	B		General block-tag
blockReason	C	2	block reason
euSalesTaxNumber	C	14	EU sales tax id
addressSource	C	10	source of the address
dateOfBirth	D		Birthdate (YYYY-MM-DD)
masterNumber	C	10	Partner-ID of master (for example company of contact person)
sector	C	10	branch
bpCommunicationsList
communicationType	C	2	Communication Types; Values
communicationValue	C	50	Communication value
communicationDefault	C	1	Default value Y / N
avsAttributes
salesOrganization	C	4	(mandatory)
distributionChannel	C	2	(mandatory)
division	C	2	(mandatory)

bpAttributesList

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

orderAttributes

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

Response

The response is a JSON document containing the result.

Element	Description
resultCode	OK or NOTOK
resultMessage	list of messages in case of an error

Example error messages:

INVALID_VALUE: Publication: The string is too short. Expected min length of: 8	the publication does not have the required 8 characters
INVALID_VALUE: Offer code: The string is too long. Expected max length of: 5	the offer code is longer than 5 characters
INVALID_VALUE: Publication: The object given should NOT be null	publication is missing in the ubscription

Corresponding SOAP Service: createOrderBuffered.

Create or change an order attribute.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/createAttribute-2.0.0
Fuba: /DSB/ISM_E_BTC_AUFTR_MERKMAL

URL

POST: /rest/{client}/subscriptions/{orderNumber}/attributes

Parameter	Description
client	client id
sp	service provider. (mandatory if the user account can use different service provider values)
orderNumber	subscription order number
type	attribute type
value	attribute value

Corresponding SOAP Service: createAttribute.

Response

Set complementary issues of a subscription.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/complementaryIssues-1.0.0
SAP REST: /DO_COMP_ISSUES

URL

POST: /rest/{client}/subscriptions/{orderNumber}

Parameter	Description
client	client id
sp	service provider. (mandatory if the user account can use different service provider values)
orderNumber	subscription order number
compIssues	number of complementary issues (either compIssuesTerm or compIssues needs to be provided)
compIssuesTerm	number of complementary issues in term (either compIssuesTerm or compIssues needs to be provided)
extendedChecks	do some extended checks (optional, default: false)
simulation	check, if the request is possible, but don't execute it. (true/false default: false)
createLetter	if true SAP will send a confirmation letter to the customer (optional,true/false default: false)

Request Body

The request body contains the selected issues.

Example Request Body JSON:

{
"ISSUES": 
  [ 
    "001234",
    "012345"
  ],
  "contacts": [
    {
       "CLASS": "Class",
       "ACTIVITY": "Act",
       "TYPE": "T"
    }
 ]
}

Element Definitionen

Parameter	Typ/Länge	Beschreibung
Issues	List	List of issue number. (Optional, at most compIssues issues must be selected.)
contacts	List	contacts that should be triggered when the function is used (optional)
class		contact class (mandatory)
activity		contact activity (mandatory)
type		contact type (mandatory)

Response

The response is a JSON document containing the result from AVS.

Parameter	Description
ONSALEDATE	OnSaleDate of the added issue
NEXTDUEDATE	next claim date
ONSALEDATEDESCRIPTION	Issue description
ACTCLAIMPENDING	Pending DD cycle

(Use only with appropriate Backendintegration in the ccb Suite)
This service initiate the change payment process in the backend (ccb suit)

Path mapping(internal): /net/dsb/avs3/PaymentDetails/changePayment-1.0.0
Fuba: /DSB/_ISM_E_CHANGE_PAYMNT_VBEL

URL

POST: /rest/{client}/subscriptions/{orderNumber}/paymentdetails?sp={sp}&so={so}

Parameter	Type/Length	Description
client	C/3	Client number
orderNumber	C/10	Subscription Order Number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)

Request Body

Example Request Body JSON:

{
  "dsbPaymentId": "1234",
  "paymentMethod" : "K",
  "accountHolder" : "Tester Test"
}

or

{
  "paymentMethod" : "D",
  "accountHolder" : "Tester Test",
  "iban" : "DE0234802348028034",
  "bic" : "MBXXX",
  "creationType" : "N",
  "transactionType" : "N"
}

or

{
  "paymentMethod" : "E",
  "accountHolder": "Test Muster",
  "debitAccount" : {
    "debitBankCode": "070116",
    "debitAccountNumber": "10203040",
    "debitContinuous": true
  }
}

Element Definitions

Parameter	Type/Length	Description
dsbPaymentId	C/36	dsb-transaction-id from notify response (for KK/Paypal)
paymentMethod	C/1	Paymentmethod: K → Payment per Creditcard P → Payment per Paypal D → Payment per bank collection(SEPA DirectDebit german customer) E → Payment per bank collection(uk customer) For foreign customers are possibly further ways of payment provided. (mandatory)
accountHolder	C/50	Name of Accountholder(mandatory)
iban	C/34	International Bank Account Number (mandatory, if paymentMethod=D)
bic	C/11	Bank Identifier Code (mandatory, if paymentMethod=D)
creationType	C/1	„ “ = no mandate created „N“ = Create new mandate „T“ = Mandate change(currently not to use) „M“ = Mandate migration(currently not to use) (for SEPA mandatory)
transactionType	C/1	„1“ = 1x Mandate „N“ = Multiple Mandate (default) (for SEPA optional)
debitAccount	JSON Object	(mandatory if paymentMethod=E)
debitBankCode	C	Bank code
debitAccountNumber	C	Account number
debitContinuous	B	continous payment?
surcharge	N/9,2	Surcharge for subscription upgrade (optional)
offerCode	C/5	Offer code subscription upgrade (optional)

Response

The Response is a JSON structure

Element	Description
message	Additional message
success	true/false

{
"message": "",
"success" : true
}

(Use only with appropriate Backendintegration in the ccb Suite)
This service initiate the book payment process in the backend (ccb suit)

Path mapping(internal): /net/dsb/avs3/PaymentDetails/bookPayment-1.0.0
Fuba: /DSB/_ISM_E_BOOK_PAYMENT

URL

POST: /rest/{client}/subscriptions/{orderNumber}/bookPayment?sp={sp}&so={so}

Parameter	Type/Length	Description
client	C/3	Client number
orderNumber	C/10	Subscription Order Number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)

Request Body

Example Request Body JSON:

{
"dsbPaymentId": "1234",
"paymentMethod" : "K",
"accountHolder" : "Tester Test"
"invoiceNumber" : "3522"
}

Element Definitions

Parameter	Type/Length	Description
dsbPaymentId	C/36	„dsb-transaction-id“ from notify response (for KK/Paypal)
paymentMethod	C/1	Paymentmethod: K → Payment per Creditcard P → Payment per Paypal For foreign customers are possibly further ways of payment provided. (mandatory)
accountHolder	C/50	Name of Accountholder(mandatory)

@invoiceNumber | C ||

surcharge	N/9,2	Surcharge for subscription upgrade (optional)
offerCode	C/5	offer code subscription upgrade (optional)

Response

The Response is a JSON structure

Element	Description
message	Additional message
success	true/false

{
"message": "",
"success" : true
}

This service creates a holiday break.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/createHolidayBreak-2.0.0
Fuba: /DSB/_ISM_E_HOLIDAYBREAK
Corresponding SOAP Service: createHolidayBreak.

URL

POST: /rest/{client}/subscriptions/{orderNumber}/holidayBreak?sp={sp}

Parameter	Type/Length	Description
client	C/3	Client number
orderNumber	C/10	Subscription Order Number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)

Request Body

Request body includes additional common parameter.

Example Request Body JSON:

{
"dateOfBreakFrom": "2019-06-20",
"dateOfBreakTo": "2019-07-27",
"dateType" : 1
}

Element Definitions

Parameter	Type/Length	Description
dateOfBreakFrom	Date
dateOfBreakTo	Date
dateType	N/1	Type of the date values: 1: On Sale Date (default) 2: Issue Label Run Date 3: Technical Issue Date / Publication date
suspensionReason	C/3	Reason for suspension. Default “UKU” (optional)
modifyClaim	boolean	Adjusts the the next claim date based on the suspension time. Not possible for indefinite suspension! (optional)

Response

The Response is a JSON structure

Element	Description
message	Additional message
success	true/false

{
"message": "",
"success" : "true"
}

BETA This service

1. cancels / stops a subscription's holiday break.

or

2. changes an active interruption (extends or shortens)

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/undoHolidayBreak-1.0.0
SAP REST: /UNDO_HOLIDAYBREAK

URL

POST: /rest/{client}/subscriptions/{orderNumber}/holidayBreak/undo?sp={sp}

Parameter	Type/Length	Description
client	C/3	Client number
orderNumber	C/10	Subscription Order Number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)

1. If you want to undo the interruption (only if the interruption has not started yet) then “dateOfBreakTo” must be empty and “dateType” is not needed either.

Request Body

Example Request Body JSON:

{
"dateOfBreakTo": ""
}

2. If an active interruption is to be extended or shortened, then dateOfBreakTo and dateType must be set. If no value is set for date type then value (1 - On Sale Date) is used as default. Based on the desired dateOfBreakTo date, the appropriate end date of the interruption is determined.

Request Body

Example Request Body JSON:

{
"dateOfBreakTo": "2019-06-27",
"dateType" : 1
}

Element Definitions

Parameter	Type/Length	Description
dateOfBreakTo	D/10
dateType	N/1	Type of the date values: 1: On Sale Date (default) 2: Issue Label Run Date 3: Technical Issue Date

Response

The Response is a JSON structure

Element	Description
message	Additional message
success	true/false

{
"message": "",
"success" : "true"
}

This service creates a holiday redirect.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/createHolidayRedirect-1.0.0
Fuba: /DSB/_ISM_E_HOLIDAYREDIRECT
Corresponding SOAP Service: createHolidayRedirect]].

URL

POST: /rest/{client}/subscriptions/{orderNumber}/holidayRedirect?sp={sp}

Parameter	Type/Length	Description
client	C/3	Client number
orderNumber	C/10	Subscription Order Number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)

Request Body

Example Request Body JSON:

{
"dateOfRedirectFrom": "2019-06-20",
"dateOfRedirectTo": "2019-07-27",
"dateType" : 1,
"deliveryType" : "PI",
"quantity" : 1,
"businessPartner" : {
  "salutationCode" : "01",
  "lastName" : "Doe",
  "firstName" : "John",
  "additionalName1" : "",
  "additionalName2" : "",
  "zipcode" : "7A33D",
  "city" : "Northtown",
  "district" : "CC",
  "street" : "Middle Street",
  "streetNumber" : "27",
  "streetNumberSuffix" : "A",
  "streetSuffix" : "Nearby",
  "countryCode" : "GB"
  }
}

Element Definitions

Parameter	Type/Length	Description
dateOfRedirectFrom	Date	(mandatory)
dateOfRedirectTo	Date	(mandatory)
dateType	N/1	Type of the date values: 1: On Sale Date (default) 2: Issue Label Run Date 3: Technical Issue Date
deliveryType	AN / 2	delivery type
quantity	N /10
businessPartner	JSON	Recipient

Response

The Response is a JSON structure

Element	Description
message	Additional message
success	true/false

{
"message": "",
"success" : "true"
}

This service

1. cancels / stops a subscriptions holiday redirect.

or

2. changes (extends or shortens) an active redirect

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/undoHolidayRedirect-1.0.0
SAP REST: /UNDO_HOLIDAYREDIRECT

URL

POST: /rest/{client}/subscriptions/{orderNumber}/holidayRedirect/undo?sp={sp}

Parameter	Type/Length	Description
client	C/3	Client number
orderNumber	C/10	Subscription Order Number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)

1. If you want to undo the redirect (this is only possible if the redirect cycle has not started yet) then “dateOfRedirectTo” must be empty and “dateType” is not needed either.

Request Body

Example Request Body JSON:

{
"dateOfRedirectTo": ""
}

2. If an active redirect is to be extended or shortened, then “dateOfRedirectTo” and “dateType” must be set. If no value is set for date type then value (1 - On Sale Date) is used as default. Based on the desired “dateOfRedirectTo” date, the appropriate end date of the interruption is determined.

Request Body

Example Request Body JSON:

{
"dateOfRedirectTo": "2019-06-27",
"dateType" : 1
}

Element Definitions

Parameter	Type/Length	Description
dateOfRedirectTo	D/10
dateType	N/1	Type of the date values: 1: On Sale Date (default) 2: Issue Label Run Date 3: Technical Issue Date

Response

The Response is a JSON structure

Element	Description
message	Additional message
success	true/false

{
"message": "",
"success" : "true"
}

BETA This service changes the recipient for a given subscription order number.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/changeBp-1.0.0
Fuba: /DSB/_ISM_E_CHANGE_KUNWE

URL

POST: /rest/{client}/subscriptions/{orderNumber}/changeBp?sp={sp}

Parameter	Type/Length	Description
client	C/3	client
orderNumber	C/10	Subscription Order Number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)

Request Body

Example Request Body JSON:

{
	"bpNumber" : "1111111111",
	"validFrom" : "2020-08-12"
}

Element Definitions

Parameter	Type/Length	Description
bpNumber	D/10	Existing bpNumber of new recipient
validFrom	D/10	Date from when the new recipient is valid(yyyy-mm-dd)

++++ Response

The Response is a JSON structure

Element	Description
message	Additional message
success	true/false

{
"message": "",
"success" : "true"
}

This service changes the mix type of a subscription.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/changeMixType-1.0.0
Fuba: /DSB/_ISM_E_BATCHSCHNITTSTELL

URL

POST: /rest/{client}/subscriptions/{orderNumber}/mixtype?sp={sp}&so={so}

Parameter	Type/Length	Description
client	C/3	Client number
orderNumber	C/10	Subscription Order Number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)

Request Body

Request body includes additional common parameter.

Example Request Body JSON:

{
"mixType" : "02",
"issueNumberFrom" : "0004/2020",
"issueNumberTo" : "0011/2020"
}

Element Definitions

Parameter	Type/Length	Description
mixType	AN/2	New Mixtype(mandatory)
issueNumberFrom	AN/9	First issue number for the change
issueNumberTo	AN/9	Last issue number for the change

Response

The Response is a JSON structure

Element	Description
message	Additional message
success	true/false

{
"message": "",
"success" : "true"
}

(Use only with appropriate Backendintegration in the ccb Suite)
This service initiates different backend(ccb suite) actions with the sorry Interface.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/sorry-1.0.0
Fuba: /DSB/_ISM_E_SORRY

URL

POST /rest/{clientId}/subscriptions/{orderNumber}/sorry?sp={sp}&so={so}&issueNrFrom={issueNrFrom}&issueNrTo={issueNrTo}

Parameter	Type/Length	Description
client	C/3	Client number
orderNumber	C/10	Subscription Order Number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)
so	C/4	sales organization. (mandatory if the user account can use different sales organization values)
issueNrFrom	C/9	Issue number from (mandatory)
issueNrTo	C/9	Issue number to (mandatory)

Request Body

Example Request Body JSON:

{
"action" : "CREDIT| REPLACEMENT| PUBLISHERREPLACEMENT| NOACTION",
 "sorry" : {
  "description" : "",
  "complaintReasonSorry": ""
},
"changeShippingType" : {
   "shippingType": "",
   "shippingText":""
},
"isDeliveryMonitoring": false,      
"isPostalDelivery": false,              
"isPostResearch": false,               
"isDigitalReplacement": false      
}

Element Definitions

Parameter	Type/Length	Description
action		Selection [CREDIT / REPLACEMENT / PUBLISHERREPLACEMENT / NOACTION] (mandatory)
sorry
description	C/255	Free text
complaintReasonSorry	C/3	Additional complaint reason for Sorry interface
changeShippingType
shippingType	C/2	Shipping type
shippingText	C/5	Shipping text
isDeliveryMonitoring	B	activate delivery monitoring true/false(default)
isPostalDelivery	B	aktivate postal delivery true/false(default)
isPostResearch	B	activate post research true/false(default)
isDigitalReplacement	B	activate digital replacement true/false(default)

Response

The Response is a JSON structure

Element	Description
message	Additional message
success	true/false

{
"success" : true
}

oder

{
"message": "Error message.....",
"success" : false
}

This service allows to increase a renewal subscriptions price. !Internal purposes only!

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/priceIncrease-1.0.0
SAP REST: /DO_PRICE_INCREASE

URL

POST: /rest/{client}/subscriptions/{orderNumber}/priceIncrease?sp={sp}&bookImmediately={bookImmediately}&showErrorDialog={showErrorDialog}

Parameter	Type/Length	Description
client	C/3	client
orderNumber	C/10	subscription
sp	C/3	service provider. (mandatory if the user account can use different service provider values)
bookImmediately	bool	book immediately? (Default: true)
showErrorDialog	bool	Show error messages, if not they will be logged (Default: true)
createContact	bool	Creates an contact. If contact details in JSON body are empty an default contact will be created. Otherwise only the specific one. !! Only available if bookImmediately = true!! (Default: false)

Request Body

The requests body contains a JSON structure.

Example Request Body JSON:

1. Price Increase

{
   "increaseToClaim": 1,
   "totalPrice":30.55,
   "term":"M3",
   "letterNumber":"",
   "suppressLetter":false,
   "reversePriceInc":false,
   "bundlePrices":[
      0.00,
      0.00,
      0.00
   ]
}

2. Bundle price increase to claim 5 with letter number 0251 being triggered. Additionally DD_SAV and DD_BAS attributes are provided. The system doesn't have a standard price for bundles. Therefore it's better to provide the attributes when doing a bundle price increase. If it's not provided the system will just add up bundle component prices and calculate a saving based on that.

{
   "increaseToClaim": 5,
   "totalPrice":20.50,
   "term":"06",
   "letterNumber":"0251",
   "suppressLetter":false,
   "reversePriceInc":false,
   "bundlePrices":[
      4.50,
      6.50,
      0.00
   ],     
    "attributes":[ 
     {
       "code": "DD_SAV",  
       "value": 10.00     
     },
     {
       "code": "DD_BAS",  
       "value": 25.50     
     }
   ]
}

3. Reverse a price increase (save previous rate)

{
   "increaseToClaim": 0,
   "totalPrice": 0,
   "term":"",
   "letterNumber":"",
   "suppressLetter":false,
   "reversePriceInc":false,
   "bundlePrices":[
      4.50,
      6.50,
      0.00
   ]
}

4. Discounts - Give customers a permanent discount (= price decrease). Term will stay the same. The discount will be calculated on the customers last payment. You can either choose a percental or absolute discount. In the example below the customer will get a 30% discount.

{
   "increaseToClaim": 0,
   "discount":{
      "percent": 30,
      "amount": 0
   }
}

5. Price Increase with two specific contacts. Make sure “createContact” in header is set to true, if not no contact will be created.

{
   "increaseToClaim": 1,
   "totalPrice":30.55,
   "term":"M3",
   "letterNumber":"",
   "suppressLetter":false,
   "reversePriceInc":false,
   "bundlePrices":[
      0.00,
      0.00,
      0.00
   ],
   "contacts": [
     {
         "activity": "SAVE3",
         "class": "SAVE",
         "type": "S"
     },
     {
         "activity": "SAVE4",
         "class": "SAVE",
         "type": "S"
     }
   ]
}
}

6. Price Increase with a specific next claim date and numbers of days before the letter should be send. In this example the letter would be send on the 1st January 2022

{
   "increaseToClaim": 0,
   "totalPrice":30.55,
   "term":"M3",
   "letterNumber":"",
   "suppressLetter":false,
   "reversePriceInc":false,
   "nextClaimDate": 2022-01-31,
   "sendLetterXDaysBfClaim": 30,
   "bundlePrices":[
      0.00,
      0.00,
      0.00
   ]
}

Element Definitions

Parameter	Type/Length	Description
increaseToClaim	C/4	Claim number which the price will be increased to - if lower than current claim it will be automatically set to next possible claim
totalPrice	AN/9	new total price
term	C/2	term (current term can be changed with the new price)
letterNumber	C/4	letter number which will be triggered
suppressLetter	bool	suppress price increase letter
reversePriceInc	bool	reverse price increase
nextClaimDate	date	Format YYYY-MM-DD
sendLetterXDaysBfClaim	I/3	Number of days the letter should be send before the next claim
delUnpaidCycle	bool	Delete not yet paid future Cycles (Current cycle won't be deleted!)
bundlePrices
price	C/11	price bundle slave (max. 3)
discount
percent	C/2	percental discount condition (please check available SAP discount conditions first!)
amount	AN/9	absolute discount
attributes		Optional - Overwrites system calculation
code	AN/6	attribut Code (DD_BAS - Standardprice / DD_SAV - Savings in percent)
value	AN/9	attribute value
contacts		Optional - If createContact is true and contacts is empty a default contact is written!
activity	AN/6	contact activity
class	AN/9	contact class
type	AN/9	contact type

Response

The response is a JSON structure:

Parameter	Description
status	Status - OK/NOTOK
code	Error code
message	Error message

{
    "status": "OK",
    "code": 0,
    "message": ""
}

BETA Get cancellation details of a subscription.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/getCancellationInfo-1.0.0

URL

GET: /rest/{client}/subscriptions/{orderNumber}/cancellationInfo?sp={sp}&cancellationDate={cancellationDate}

Parameter	Type/LLength	Description
client	C/3	client ID
orderNumber	C/10	subscription order number
sp	C/3	service provider. (mandatory if the user account can use different service provider values)
cancellationDate	D	desired cancellation date (YYYY-MM-DD) `BETA`

Response

The response is a JSON document containing the payment details.

Element	Length	Type	Text	Hint or attribute listing
minRefIssueFollow	10	C	Minimum reference issue sequence VA: which is the last issue sequence to be purchased	Sample:„0000352857“ für Issue nr.. 0005/2016 publication 00000665
minRefIssueFollowNr	9	C	Minimum reference issue sequence Issue-Nr.: which is the last issue sequence to be purchased	Sample: „0005/2016“ publication 00000665
suggestedCancellationReason	3	C	Suggested cancellation reason	Sample: „301“
suggestedCancellationDate	10	D	Suggested cancellation date	Sample: „2021-04-23“ `BETA`
revocationDate	10	D	Revocation date: Until which date is a notice of revocation considered to be a cancellation period	Sample.: „2015-11-02“
revocationOrCancellationFlag	1	C	Flog if	revocation or cancellation
endOfContractVa	10	C	End of contract VA	Sample: „0000352855“ for Issue-Nr. 0003/2016 publication 00000665
endOfContractIssue	9	C	End of contract Issue-Nr.	Sample:„0003/2016“
actualDeliveredIssues	2	N	Actual delivered issues	Sample: 15
calculatedIssues	2	N	Actual calculated issues	Sample: 15
payedIssues	4	N	Actual payed issues	Sample: 15
contractAccountBalance	7,2	N	Actual contract account balance negative sign = customer credit positive sign = open receivables present	Sample:„1234567.89“
complaintAvailable		B	Are there currently complaint entries with the value <> “STGP”? true/false
currentAddressSearch		B	true/false
details
cancelType	4	C	Flag cancel type
validTo	10	D	Delivery end date / cancellation date
calculatedTo	10	D	End of calculation
deliveryEndReason	3	C	Cancellation reason
description	100	C	Description

{
  "minRefIssueFollow" : "",						
  "minRefIssueFollow" : "",				
  "suggestedCancellationReason" : "",
  "suggestedCancellationDate" : "",
  "revocationDate" : "",
  "revocationOrCancellationFlag" : "",
  "endOfContractVa" : "",
  "endOfContractIssue" : "",
  "actualDeliveredIssues" : "",
  "calculatedIssues" : "",
  "payedIssues" : "",
  "contractAccountBalance" : "",
  "complaintAvailable" : "",
  "currentAddressSearch" : "",
  "details" : [ {
    "cancelType" : "",
    "validTo" : "",
    "calculatedTo" : "",
    "deliveryEndReason" : "",
    "description" : ""
  }]
}

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getRights-1.0.0

URL

GET: /rest/{client}/subscriptions/{orderNumber}/rights

Parameter	Description
client	C/3	client
orderNumber	C/10	subscription
sp	C/3	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)

Response

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/updateRights-1.0.0

URL

POST: /rest/{client}/subscriptions/{orderNumber}/rights

Parameter	Description
client	C/3	client
orderNumber	C/10	subscription
sp	C/3	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)
type	insert, replace or delete

Request

This services requests the state of a new order.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getOrderState-1.0.0
Fuba: /GET_EXT_ORDER_STATUS

URL

POST rest/{client}/subscriptions/{orderNumber}/state

Parameter	Typ/Länge	Beschreibung
client	C/3	client
orderNumber	C/20	external order number
sp	C/3	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)
searchAllStacks	B	true: search order in all stacks; false (default): search only in stacks of last three months

Response

Element	Description
stack	stackname
numberInStack	position in stack
status	order state: B - Booked D - Deleted P - Pending R - Rejected F - Faulty M - Missing
orderNumber	ccb order number (only booked orders)

{
  "stack": "A0028650RFC180723",
  "numberInStack": 2,
  "status": "B",
  "orderNumber": "4010737692"
}

Subscriptions

Get Subscription

Examples

Get By Order Number

URL

JSON Subscription Order

Example

Element Definitions

JSON Business Partner

Example

Element Definitions

JSON Attributes

Example

Element Definitions

JSON Attributes

Example

Element Definition

JSON Attributes

Example

Element Definitions

Get By Reference Doc

URL

JSON Subscription Order

Example

Element Definitions

JSON Business Partner

Example

Element Definitions

JSON Attributes

Example

Element Definitions

JSON Attributes

Example

Element Definition

JSON Attributes

Example

Element Definitions

Get By Order Attribute

URL

JSON Subscription Order

Example

Element Definitions

JSON Business Partner

Example

Element Definitions

JSON Attributes

Example

Element Definitions

JSON Attributes

Example

Element Definition

JSON Attributes

Example

Element Definitions

Get Issues

Get Issues By Order Number

URL

JSON Extended Issue

Example

Element Definitions

JSON Issue

Example

Element Definitions

Get Delivered Issues

URL

JSON Delivered Issue

Example

Element Definitions

Get Payment Details

URL

Cancellation

URL

Replace Issue

URL

Create subscription

URL

JSON New Subscription Order

Example

Element Definitions

JSON Business Partner