PDF Export

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
isCombiSubscriptionBBETA 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

orderAttributes

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