PDF Export

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 TypeMax. LengthDescription
promotionSource C10Source code (mandatory)
promotionSourceVariantC1Promotion-source-variant
salesPromotion C8Sales-promotion (Mandatory if several sales-promotions have been set up for a BQ so it must be told which one can be used)
advertisingLevel N2Advertising level of the accepted offer(0-99 )
offerCode C5(renewal-)offer code
publication C8publication (if blank, publication is derived from source code)
edition C8edition (if blank, edition is derived from publication)
mixType C2mix-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 C2Purchase-frequency. Mandatory, if it is not clear for the client. Possible values are: VA = full sub; Other values are client specific.
deliveryType C2Delivery-type
quantity N Quantity of customer order-publisher-Position-division. Default is 1.
salesOrganization C4Sales-organization. If not set it is derived from the source code or edition. Mandatory if it can't be derived.
salesSuborganization C5sub organization of vkorg
salesBureau C4Sales-bureau, based on the field „input-user“. otherwise: 0001. Other values are client specific.
distributionChannel C2Distribution-channel. Mandatory, if the value can not be clearly derived out of the publication (field ‚publication‘).
division C2Division. Mandatory, if the value can not be derived out of the publication (field ‚publication‘).
customerPurchaseOrderNumberC20Customer-purchase-order no.
customerPurchaseOrderTypeC4Order type of customer, e.g. ‚I‘ → Internet; ‚T‘ → by telephone
customerPurchaseOrderDateD 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.
issueNumberFromC9Issue 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.
issueNumberToC9Issue 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.
archiveReferenceC20Reference Number
paymentMethodC1Payment-method (mandatory) (Codes)
payMethodDetails
* cheque
* bankClearingAccountC10Bank clearing account (mandatory)
* chequeNumber C13 Cheque number (mandatory)
* amount N Amount in transaction currency (mandatory)
* currencyCode C3 ISO Currency code (mandatory)
* bankCode C15Bank code
* bankControlKey C2Bank control key
* bankCountryCode C2Bank country code
* bankAccountNumber C18Bank account number
* other
* bankClearingAccountC10Bank clearing account
* amount N Amount in transaction currency
* currencyCode C3Currency code
* payeeNote C80Payee note
totalPaidCurrencyCodeC3Currency 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 C3Currency code for discount/extra-pay (only in use for renewal)
* discount N discount
* extraPay N extra pay
extraPayVoucher BETA
* bankClearingAccountC10BETA Bank clearing account,must, if structure 'extraPayVoucher' denoted
* amountN9,2BETA Amount in transaction currency, must, if structure 'extraPayVoucher' denoted
* currencyCodeC3BETA Currency code, must, if structure 'extraPayVoucher' denoted
Currency as ISO-Code
EUR Euro
CHF Schweizer Franken
GBP Great British Pound
etc.
* payeeNoteC80BETA Payee note, can, if structure 'extraPayVoucher' denoted
printInvoice B Mark print invoice
purchaseReason C3Purchase reason
deliveryEndReason C3 Delivery end reason
billingFrom D Date of beginning of payment
issueBillingFrom C9Copy no., from which it should be billed
currencyCode C3Currency as ISO-Code
priceListType C2Price-list-type
fixedPriceListAndCurrencyCode B don't change the submitted price and currency code (Default: false)
debitAccounts
* debitAccountId C4debit account id
* debitBankCode C15Debit-bank-code (debitBankCode or bic is mandatory)
* debitCountryCode C2ISO-country code of bank
* debitAccountNumber C18Debit account number (debitAccountNumber or iban is mandatory)
* debitAccountHolder C60Name of account holder (mandatory)
* debitContinuous B Is there a direct debit mandate? (mandatory)
* debitDueDate C2due day for direct-debit Day of month (0-31) (mandatory)
* iban C34International bank account nummer (debitAccountNumber or iban is mandatory)
* bic C11Bank identifier code (debitBankCode or bic is mandatory)
sepaMandate
* creationType C1„ “ = no mandate created
„N“ = Create new mandate
„T“ l= Mandate change(currently not to use)
„M“ = Mandate migration(currently not to use)
* transactionType C1„1“ = 1x Mandate
„N“ = Multiple Mandate (default)
* sepaDetails
* b2bMandante B B2B-Mandate (currently not supported)
* mandateRefPerCreditorC35Unique reference to mandate per creditor / previous mandate id (only in conjunction with creationType „T“ and „M“)
* previousCreditorId C35Creditor identifier(unique accross country) / previous creditor id (only in conjunction with creationType „T“ and „M“)
* previousBic C11Previous BIC-Code ((only in conjunction with creationType „T“ and „M“)
* lastDueDate C
priceKeyInTrialterm C4Price-key-in-trialterm
billingFrequencyInTrialtermC2Billing-frequency-in-trialterm billing frequency
priceGroupInTrialtermC2Price-group-in-trialterm
durationInTrialtermC3Duration-in-trialterm
unitInTrialterm C3Unit-in-trialterm, For example.: MON months, WCH weeks, TAG days
priceKeyInNormalterm1C4Price-key-in-normalterm 1
billingFrequencyInNormalterm1C2Billing-frequency-in-normalterm 1 billing frequency
priceGroupInNormalterm1C2Price-group-in-normalterm1
durationInNormalterm1C3Duration-in-normalterm1
unitInNormalterm1C3Unit-in-normalterm 1, For example.: MON months, WCH weeks, TAG days
priceKey C4Price-key of normalterm
billingFrequency C2billing frequency of normalterm
priceGroup C2Price-group of normalterm
duration C3Duration of normalterm
unit C3Unit of duration of normalterm. For example.: MON months, WCH weeks, TAG days
postageKey C30Postage-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 C1Field for free disposal. Is stored to the order.
dsbMedia2 C2Field for free disposal. Is stored to the order.
dsbMedia3 C3Field for free disposal. Is stored to the order.
dsbMedia4 C4Field for free disposal. Is stored to the order.
dsbMedia2b C2Field for free disposal. Is stored to the order.
dsbMedia7 C7Field for free disposal. Is stored to the order.
ruleIdC3Unique 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)
externalOrderNumberC35External-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 C12Input-office (mandatory)
inputDate D Input-date (mandatory)
inputUser C12Input-user (mandatory)
stackName C17Stack-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 C1Stack lock code, W= webservice; F=file (only in createDirect requests)
agentNumber C10External agent-number
agentOrganisationC5external agent-organisation
costCenter C10Cost-center
matriculated B Is matriculation certification available
matriculatedTo D Matriculated-to (mandatory if matriculated)
advanceBilling Bbill in advance (default: false)
previouslyBilledTo D „billed to“ date in previous system
issuePreviouslyBilledToC9Copy no. “billed to” in pre-system
deliveryStartStatisticalD Date for statistical delivery start
issueDeliveryStartStatisticalC9Copy no. for statistical delivery start
dispatchType C2Dispatch-type. LP = air-mail
dispatchText C5Dispatch-text
ivwGroup C2Special group for ivw evaluation
statisticGroup C2Token of statistic-group
conditionTermCommitmentPeriodN2Duration of commitment-period (regular cancellation after x Months possible)
conditionTermCancellationPeriodN2period of notice
conditionTermRenewal N2renewal of bounded time limit
dsbEPaymentGuid C36Authorisation-GUID in the dsb-Webservice environment. Contains the id from a previous notify request (for example notifyCardTransactionWithWirecard)
dsbTrxIdForSolvencyCheckC36 Solvency-GUID in the dsb-WSI
bpRelations
* roleC2business partner role
* bp business partner (see below)
subscriptionRenewal
* renewalOrderNumberC10renewal order-number
* automaticRenewal B automatic renewal
utmParameters
* sourceC30UTM Parameter
* mediumC30UTM Parameter
* campaignC30UTM Parameter
premium
* role C2Partner role who gets the premium
* materialNumber C18Material-number of premium
* referralBReceives gift because of referral - true/false(default)
premiumPayment
* paymentMethodC1
* debitAccount
* ccAccount
orderAttribute
coreWbzCondition
* wbzWkzC1promotion charge benefit
* wbzWkzFixB WKZ-Key fixed
* wbzConditionC3WBZ-Condition
offerPhases ** Angebots Phasen
* phaseN1Offer phase
* numberOfClaimsN4Number of claims in renewal phase
* billingFrequencyC2Billing frequency
* priceKeyC2Price key subscription
* priceN8,2Price
* currencyC5Currency
* numberFreeIssuesN3Number of free issues
* priceBundleSlave1N13,2
* priceBundleSlave2N13,2
* priceBundleSlave3N13,2
* freeCycleC1Free cycle
* rightDefinitionC255Right definition

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