Diese Seite beschreibt die REST Web Services zu Abonnements.

Liefert die Vertriebsausgaben(VA) zu der übergebenen Auftragsnummer und dem angegebenen Filter im angegebenen Zeitraum.

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

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

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

Zusätzlich muss einer dieser Filter angegeben werden:

Ergebnis

{
"orderType": "REN",
"productType": "ON",
"isCombiSubscription": false,
"listOfIssueExt":[{
      "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",
      ...
 },
...
]
}

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

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

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

Ergebnis

[{
      "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" ; ""
 }]

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

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

Ergebnis

{
  "account" : {
    "listOfDebitAccount" : [ {
      "debitAccountId" : "0001",
      "debitBankName" : "Pkundenbank",
      "debitBankCode" : "00010010",
      "debitCountryCode" : "DE",
      "debitAccountNumber" : "11111111",
      "debitAccountHolder" : "Testet",
      "debitContinuous" : true,
      "iban" : "DE00000000000000000000",
      "bic" : "xxxxxxxxXXX"
    } ]
  },
  "bpNumber" : "0000520000"
}

Steuert eine Nachlieferung ein.
Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/replaceIssue-2.0.0
Fuba: /DSB/ISM_E_BATCHSCHNITTSTELLE

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

Request

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

Response

Corresponding SOAP Service: replaceIssue.

Legt ein neues Abonnement an. Dieser Service ist gepuffert, d.h. die Aufträge werden in einer Datenbank zwischengespeichert. Damit die Aufträge ins Backend(ccb-suite) gelangen,muss hierfür ein zusätzlicher Transferjob eingerichtet werden. Bitte bestellen Sie diesen Job bei dem zuständigen Kundenberater.

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

POST: /rest/{client}/subscriptions

Request Body

{
    "promotionSource" : "WEBSHOP",
    "offerCode" : "BAR1",
    "publication" : "00000100",
    "edition" : "00000100",
    "mixType" : "01",
    "quantity" : "1",
    "customerPurchaseOrderType" : "I",
    "issueNumberFrom" : "000006880",
    "paymentMethod" : "K",
    "totalPaidCurrencyCode" : "GBP",
    "totalPaidAmount" : 795.00,
    "fixPrice" : 795,
    "walletPartPaymentAmount" : 0.00,
    "currencyCode" : "GBP",
    "priceListType" : "01",
    "fixedPriceListAndCurrencyCode" : true,
    "externalOrderNumber" : "93-2",
    "inputOffice" : "TST-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" : "EUR",
        "payeeNote" : "Test Voucher 2"
    },
    "subscriptionRenewal" : {
        "automaticRenewal" : false
    },
    "bpRelations" : [ {
          "role" : "AG",
          "bp" : {...}
    }],
    "premium": [{
      "materialNumber": "TestGIFT",
      "role": "VM",
      "referral": true
    }],
    "orderAttribute" : [],
    "additionalInformation" : [
      {
        "type" : "aType",
        "text" : "blabla"
      },
      {
        "type" : "utm_campaign",
        "text" : "Test"
      }
    ],
    "offerPhases" : [
        {
         "phase" : 1,
         "numberOfClaims" : 9999,
         "billingFrequency" : "M2",
         "priceKey" : "MIG1",
         "price" : 100.00,
         "currency" : "EUR",
         "numberFreeIssues" : 0.00,
         "priceBundleSlave1" : 0.00,
         "priceBundleSlave2" : 0.00,
         "priceBundleSlave3" : 0.00,
         "freeCycle" : false,
         "rightDefinition" : "TestRecht"
        }
    ],
    "complaint": {
            "type": "delivery",
	    "complaintReason": "G01",
            "numberOfIssues": 5, 
            "text": "Test"
        },
    "complaints": [{
            "type": "delivery",
	    "complaintReason": "G01",
            "numberOfIssues": 5, 
            "text": "Test"
        },
        {
            "type": "delivery",
	    "complaintReason": "G02",
            "numberOfIssues": 4, 
            "text": "Test"
        }]
}

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

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

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

Response

Korrespondierender SOAP Service: createOrderBuffered.

(Nutzung nur bei entspr. Backendintegration in der ccb Suite)
Der Service stößt den Zahlwegsänderungsprozess im Backend (ccb suite) an.

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

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

Request Body

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

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

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

Response

{
"success" : true
}

{
"message": "Der Request konnte nicht verarbeitet werden weil.....",
"success" : false
}

(Nutzung nur bei entspr. Backendintegration in der ccb Suite)
Der Service erfasst eine Zahlung im Backend (ccb suite) an.

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

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

Request Body

{
"dsbPaymentId": "1234",
"paymentMethod" : "K",
"accountHolder" : "Tester Test"
"invoiceNumber" : "1533"
"amount"        : 12.80
"currency"      : "EUR"
"incentiveCode" : "AB"
"incentiveType" : "E"
}

Response

{
"success" : true
}

{
"message": "Der Request konnte nicht verarbeitet werden weil.....",
"success" : false
}

Diese Methode legt eine Unterbrechung vom Typ Urlaubsunterbrechung für einen bestehenden Abo-Auftrag an.
Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/createHolidayBreak-2.0.0
Fuba: /DSB/_ISM_E_HOLIDAYBREAK
Korrespondierender SOAP Service: createHolidayBreak.

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

Request Body

{
"dateOfBreakFrom": "2019-06-20",
"dateOfBreakTo": "2019-07-27",
"dateType" : 1,
"modifyClaim" : true,
"suspensionReason" : "ABC"
}

Response

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

BETA Dieser Service

1. Löscht / Stopt eine Urlaubsunterbrechung für ein angegebenes Abonnement.

or

2. ändert eine aktive Unterbrechung (Erweiterung/Kürzung)

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

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

1. Wenn sie die Unterbrechung rückgängig machen wollen(nur wenn der Unterbrechungszyklus noch nicht begonnen hat) dann muss “dateOfBreakTo” leer sein und der “dateType” ist nicht notwendig.

Request Body

{
"dateOfBreakTo": ""
}

2. Wenn sie eine aktive Unterbrechung verlängern oder verkürzen wollen, dann müssen die Felder „dateOfBreakTo“ und „dateType“ gesetzt werden. Wenn für „dateType“ kein Wert gesetzt wurde, dann wird der default Wert (1 - On Sale Date) genommen. Anhand des gewünschten „dateOfBreakTo“-Datums wird das entsprechende Enddatum der Unterbrechung ermittelt.

Request Body

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

Response

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

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

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

Request Body

{
"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"
  }
}

Response

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

Dieser Service

1. Löscht / Stoppt eine Urlaubsweiterleitung für ein angegebenes Abonnement.

oder

2. ändert eine aktive Weiterleitung (Erweiterung/Kürzung)

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

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

1. Wenn Sie die Weiterleitung rückgängig machen wollen (nur wenn der Weiterleitungszyklus noch nicht begonnen hat) dann muss das Feld “dateOfRedirectTo” leer sein und der “dateType” ist nicht notwendig.

Request Body

{
"dateOfRedirectTo": ""
}

2. Wenn Sie eine aktive Weiterleitung verlängern oder verkürzen wollen, dann müssen die Felder „dateOfRedirectTo“ und „dateType“ gesetzt werden. Wenn für „dateType“ kein Wert gesetzt wurde, dann wird der default Wert (1 - On Sale Date) genommen. Anhand des gewünschten „dateOfBreakTo“-Datums wird das entsprechende Enddatum der Unterbrechung ermittelt.

Request Body

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

Response

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

(Nutzung nur bei entspr. Backendintegration in der ccb Suite)
Der Service stößt im Backend (ccb suite) Aktionen der sorry Schnittstelle an.

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

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

Request Body

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

Response

{
"success" : true
}

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

Liest die Daten zu Multilizenzen eines Abos. Wird ein Code angeben diese eine Lizenz, ansonsten alle zum entsprechenden Abo.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getMultiLicenseDetails-1.0.0
SAP REST: /MEHRFACHLIZENZEN

GET: /rest/{client}/subscriptions/{orderNumber}/multiLicenses/{code}?sp={sp}

Response

{
  "maxLicenses": 7,
  "data": [
    {
     "code": "ML0001",
     "partner": "1000004469",
     ...
    },
    {
      ...
    }
  ]
}

{
   "code": "ML0001",
   "partner": "1000004469",
   ...
}

Legt Multilizenzen zu einem Abo an bzw. ändert bestehende. Es werden nur die mitgegebenen geändert bzw. neu angelegt.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/postMultiLicenseDetails-1.0.0
SAP REST: /MEHRFACHLIZENZEN

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

Request

[
  {
     "code": "ML0001",
     "partner": "1000004469",
     "feld": "Wert"
     ...
  },
  {
     ...
  }
]

Response

[
  {
     "code": "ML0001",
     "partner": "1000004469",
     ...
  },
  {
     ...
  }
]

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

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

Response

[
    {
        "phase": "0",
        "currentCycle": true,
        "rights": [
            "Recht1",
            "Recht2",
            "Recht3",
            "Recht4"
        ],
        "position": 1,
        "cycle": 1,
        "trial": true
    },
    {
        "phase": "1",
        "rights": [
            "Recht9",
            "Recht10"
        ],
        "position": 1,
        "cycle": 2
    },
    {
        "phase": "2",
        "rights": [
            "Recht10",
            "Recht11"
        ],
        "angphaPhase": 3
    }
]

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

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

Request

[
    {
        "phase": 1,
        "currentCycle": true,
        "rights": [
            "Recht14",
        ]
    },
    {
        "phase": 2,
        "rights": [
            "Recht19",
            "Recht20"
        ]
    }
]

Response

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

Der Service ermittelt den Status eines Auftrag, bei dem nur die externe Auftragsnummer bekannt ist.

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

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

Response

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

BETA Der Service liefert die Positionen zu einem Auftrag.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getPositionsByOrderNumber-1.0.0
Korrespondierender SOAP Service: getpositionsbyordernumber.

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

Response

[
	{
		"vbeln": "",
		"posNr": "",
		"posType": "",
		"timeslice": "",
		"validFrom": "",
		"validTo": "",
		"issueNrFrom": "",
		"issueNrTo": "",
		"publication": "",
		"edition": "",
		"mixType": "",
		"purchaseFrequency": "",
		"recipient": "",
		"countryDelivery": "",
		"deliveryType": "",
		"purchaseReason": "",
		"issueDeliveryStartStatistical": ""
	},
	{
		...
	},
...
]

oder wenn der Auftrag nicht gefunden wurde ein 404 HTTP Code.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getOrderHistory-1.0.0
SAP Fuba: /DSB/DM_JK_READ_ORDER_HISTORY

GET: /rest/{client}/subscriptions/{orderNumber}/orderHistory?sp={sp}

Response

[
  {
    "category": "INFBX",
    "text": "Ein neuer Eintrag für die Auftragshistorie.",
    "messageNumber": "",
    "messageReference": "",
    "creationTime": "2024-12-09T12:49:03Z",
    "amount": 0.00,
    "orderHistoryKey": "11111E42EBAAAAAAE1008000AC120188"
  }
]

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/writeOrderHistory-1.0.0
SAP Fuba: /DSB/DM_JK_WRITE_ORDER_HISTORY

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

Der Request enthält die Daten des neuen Eintrags als JSON.

  {
    "text": "Ein neuer Eintrag für die Auftragshistorie."
  }

Löscht ein Eintrag in der Auftragshistorie anhand des orderHistoryKey. Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/deleteOrderHistory-1.0.0
SAP Fuba: /DSB/ISM_JK_DELETE_ORDER_HIST

DELETE: /rest/{client}/subscriptions/{orderNumber}/orderHistory/{orderHistoryKey}?sp={sp}

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/updateOrderHistory-1.0.0
SAP Fuba: /DSB/ISM_JK_UPDATE_ORDER_HIST

PUT: /rest/{client}/subscriptions/{orderNumber}/orderHistory/{orderHistoryKey}?sp={sp}

Request

{
    "text": "das ist ein Test"
}

Response

Der Response ist eine JSON Struktur

{
  "category": "INFBX",
  "text": "Ein neuer Eintrag für die Auftragshistorie.",
  "creationTime": "2024-12-09T12:49:03Z",
  "amount": 0.00,
  "orderHistoryKey": "11111E42EBAAAAAAE1008000AC120188"
}

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/reinitiate-1.0.0
SAP Service: /DO_REINITIATE

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

Request

{
  "deviatingInvoiceBeginDate" : "2025-02-13" ,
  "deviatingInvoiceEndDate" : "2026-01-12" ,
  "cancelReason" : "121" ,
  "acquisitionReason" : "150" ,
  "validFrom" : "2025-01-30" ,
  "validTo" : "2026-01-29" ,
  "adjustSubsequentInvoice" : true ,
  "replacement" : true,
  "considerCredit": true
}

Response

Im Fehlerfall kommt eine JSON Struktur zurück.

{
  "errorId": 2,
  "errorType": "INTERNAL",
  "errorText": "Wiederaufnahme zum 30.01.2025 nicht möglich. Dsb-Urpos noch aktiv. Auftr 4100001777 Pos 000002",
  "errorTimestamp": "2025-05-07T13:05:53+01:00"
}

Der Service schafft einen Rückkanal für Prämienstatus für digitale Prämien (API)
Es können Versandstatus und Zusatzinformationen wie Gutschein-Code oder Downloadlink übergeben werden

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/setGiftStatus-1.0.0
Fuba: /DSB/_ISM_E_SET_GIFT_STATUS

POST /rest/{clientId}/subscriptions/{orderNumber}/gifts/{matnr}/status?sp={sp}&so={so}

Request Body

{
"posNr" : "01",
"confirmationStatus" : "",
"bpNumber" : "",
"deliveryDate" : "YYYY-MM-DD",
"confirmationText" : ""
}

Response

{
"success" : true
}

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

Der Service legt eine neue Prämie an oder löst einen Wiederversand aus

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/addGift-1.0.0
Fuba: /DSB/_ISM_E_GIFT_REPEAT

POST /rest/{clientId}/subscriptions/{orderNumber}/gifts/{matnr}/add?sp={sp}&so={so}

Response

{
"success" : true
}

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