getByOrderNumber (Version 2) Object: /net/dsb/avs3/SubscriptionOrder Method: getByOrderNumber Version: 2.0.0 Fuba: /DSB/ISM_E_SEL_VBELN/ This method returns all subscription orders referenced by the given AVS/3 order numbers. Zero, one or more subscription orders may be returned. These can be both active and inactive. The returned business-partners match to the following rules: BP-Role Contained in response … Address point in time … WE = consignee (goods rescipient) always - address at the time of last shipment (default) - current address, if parameter “return-current-we-address” is set to Y AG = orderer only if parameter “send-orderer ” is set to Ycurrent address RE = invoice recipient only if parameter “send-invoice-recipient” is set to Yaddress at the time of last shipment Important hint: It is possible to customize which attributes (order or business-partner) are returned in the response. This is maintained in the customizing table /DSB/JET_MERK_RE or /DSB/JET_MERK_GP in AVS/3. Please get in touch with customer service if you would like to add additional values. All values are returned if the wildcard (*) is set. Parameter NameType / max. lengthmandatory?Description order-number AN / 10 m Abo-Auftragsnummer(n) (1..n) publication AN / 8 k Filter for publication send-invoice-recipient AN / 1 k ‚Y‘ enter, in case if also the consignee should receive drifted receipt of invoice ‚N‘ if not send-orderer AN / 1 k ‚Y‘ enter, if also drifted orders have to be sent back to the consignee ‚N‘ if not return-current-we-addressAN / 1 k Specifies, wether the current address of the business-partner in role WE should be returned. othterwise the address of the last inital shipment date (EVT) is returned. Y = Yes N = No (default) return-valid-to-by-evtAN / 1 k Specifies, wether the valid-to value should be determined by the inital shipment date (EVT). Y = Yes N = No (default) Response Element XML-Structure 'subscription-order'. This structure meet the description of 'newsubscription', see below. Example Request <message version="1.0" system="avs/3" > <header> <client>999</client> <avs3-sales-organization>9999</avs3-sales-organization> <avs3-service-provider>123</avs3-service-provider> </header> <body> <order-number></order-number> <publication></publication> <send-invoice-recipient></send-invoice-recipient> <send-orderer></send-orderer> </body> </message> Example Response <message version="1.0" system="avs/3"> <header> <client>999</client> <avs3-sales-organization>9999</avs3-sales-organization> <avs3-service-provider>123</avs3-service-provider> </header> <body> <subscription-order> ... </subscription-order> </body> </message> Response Structure Structure <new-subscription> or <subscription-order> <new-subscription> <order-number></order-number> <publication></publication> <publication-name></publication-name> <edition></edition> <mix-type></mix-type> <purchase-frequency></purchase-frequency> <delivery-type></delivery-type> <order-status></order-status> <is-renewal>true</is-renewal> <is-timebased>true</is-timebased> <order-currency></order-currency> <issue-nr-from></issue-nr-from> <issue-nr-to></issue-nr-to> <issue-nr-first-bill></issue-nr-first-bill> <valid-from></valid-from> <valid-to></valid-to> <valid-from-evt><valid-from-evt> <valid-to-evt></valid-to-evt> <valid-from-on-sale-date><valid-from-evt-on-sale-date> <valid-to-on-sale-date></valid-to-on-sale-date> <end-reason></end-reason> <promotion-source></promotion-source> <pr-source-var></pr-source-var> <reference-doc></reference-doc> <cust-order-nr></cust-order-nr> <cust-order-date></cust-order-date> <subscr-phase></subscr-phase> <price-group></price-group> <price-key></price-key> <payment-method></payment-method> <payment-method-details> <sub-payment-method-code></sub-payment-method-code> </payment-method-details> <billing-frequency></billing-frequency> <billing-frequency-short-description></billing-frequency-short-description> <quantity></quantity> <sales-organization></sales-organization> <dsb-media1></dsb-media1> <dsb-media2></dsb-media2> <dsb-media3></dsb-media3> <dsb-media4></dsb-media4> <dsb-media2b></dsb-media2b> <dsb-media7></dsb-media7> <agent-number></agent-number> <material-number></material-number> <premium-description></premium-description> <premium-dispatch-date></premium-dispatch-date> <billing-payed-to></billing-payed-to> <issue-number-next-bill></issue-number-next-bill> <issue-number-from-last-bill></issue-number-from-last-bill> <issue-number-to-last-bill></issue-number-to-last-bill> <current-dunning-level></current-dunning-level> <ct-commitment-period></ct-commitment-period> <ct-cancelation-period></ct-cancelation-period> <ct-renewal></ct-renewal> <dsb-urpos-lief></dsb-urpos-lief> <sales-source></sales-source> <advertising-medium></advertising-medium> <sales-document-type></sales-document-type> <dispatch-type></dispatch-type> <dispatch-text></dispatch-text> <contract-account-balance></contract-account-balance> <postage-key></postage-key> <renewal> <expiry-date></expiry-date> <expiry-issue-nr></expiry-issue-nr> <renewal-due-date></renewal-due-date> <number-issues-remaining></number-issues-remaining> <current-cycle-number-of-issues></current-cycle-number-of-issues> <current-cycle-start-issue-nr></renewal-cycle-start-issue-nr> <current-cycle-start-date></renewal-cycle-start-date> <current-cycle-expiry-issue-nr></current-cycle-expiry-issue-nr> <current-cycle-expiry-date></current-cycle-expiry-date> <current-cycle-acceptance-date></current-cycle-acceptance-date> <current-cycle-offer></current-cycle-offer> <current-cycle-offer-type></current-cycle-offer-type > <current-cycle-offer-description></current-cycle-offer-description > <current-cycle-offer-marketingtext></current-cycle-offer-marketingtext > <offer-classification></offer-classification> <offer-classification-definition></offer-classification-definition> <current-cycle-paid-amount></current-cycle-paid-amount> <current-cycle-bundle-paid-amount></current-cycle-bundle-paid-amount> <order-currency></order-currency> <renewal-bundle-component></renewal-bundle-component> <auto-renewal></auto-renewal> <auto-renewal-next-payment-amount></auto-renewal-next-payment-amount> <auto-renewal-next-payment-frequency-code></auto-renewal-next-payment-frequency-code> <auto-renewal-next-payment-frequency-text></auto-renewal-next-payment-frequency-text> <auto-renewal-last-payment-date></auto-renewal-next-payment-date> <auto-renewal-last-payment-amount></auto-renewal-last-payment-amount> <auto-renewal-last-payment-frequency-code></auto-renewal-last-payment-frequency-code> <auto-renewal-last-payment-frequency-text></auto-renewal-last-payment-frequency-text> <auto-renewal-last-payment-date></auto-renewal-last-payment-date> <auto-renewal-actual-claim-counter></auto-renewal-actual-claim-counter> <auto-renewal-increase-claim-counter></auto-renewal-increase-claim-counter> </renewal> <!— 0 to n -- > <bundled-subscription-info> <bundle-order-number></bundle-order-number> <publication></publication> <edition></edition> <quantity></quantity> </bundled-subscription-info> <current-suspension> <suspended-from-date></suspended-from-date> <suspended-to-date></suspended-to-date> <suspended-from-issue-nr></suspended-from-issue-nr> <suspended-to-issue-nr></suspended-to-issue-nr> <suspended-reason-code></suspended-reason-code> </current-suspension> <change-info> <future-mix-type /> <future-mix-type-from-issue-nr /> <future-mix-type-to-issue-nr /> <former-mix-type /> <former-mix-type-to-issue-nr /> <future-delivery-quantity>0</future-delivery-quantity> <future-delivery-quantity-from-issue-nr /> <former-delivery-quantity>0</former-delivery-quantity> <former-delivery-quantity-to-issue-nr /> <future-delivery-type /> <future-delivery-type-from-issue-nr /> <former-delivery-type /> <former-delivery-type-to-issue-nr /> <future-dispatch-type /> <future-dispatch-type-from-issue-nr /> <former-dispatch-type /> <former-dispatch-type-to-issue-nr></former-dispatch-type-to-issue-nr> <future-dispatch-text /> <future-dispatch-text-from-issue-nr /> <former-dispatch-text /> <former-dispatch-text-to-issue-nr></former-dispatch-text-to-issue-nr> </change-info> <!-- 1 to 3 possible --> <business-partner> ... </business-partner> <!-- 0 to n possible --> <order-attribute> ... </order-attribute> </new-subscription> Element Definitions Field nameLengthType Text Remark, field supply or recoding order-number 10 C Subscription no. Corresponding to order no. publication 8 C publication publication-name 30 C name of publication edition 8 C edition mix-type 2 C mix-type purchase-frequency 2 C Purchase frequency delivery-type 2 C delivery type order-status 2 C order status is-renewal B is this a renewal sub ? is-timebased B is this a timebased Renewal-Sub ? (true/false) order-currency 3 C currency code of the subscription issue-nr-from 9 C Delivery start copy no. Copy no. of first delivered distribution edition. Default Format: HHHH/YYYY or any other client specific format /free text. issue-nr-to 9 C End of delivery copy no. Copy no. of last delivered distribution edition. Format: HHHH/YYYY or any other client specific format /free text. issue-number-first-bill 9 C Copy no. of 1. invoice Default Format: HHHH/YYYY or any other client specific format /free text. valid-from 10 D Start of the of delivery Date in format: yyyymmdd valid-to 10 D Date of end of delivery, filled only when a subscription has been cancelled.Date in format: yyyymmdd valid-from-evt 10 D Date in format: yyyymmdd valid-to-evt 10 D Valid till EVT, whereas EVT means “first shipment date”. Date in format: yyyymmdd valid-from-on-sale-date 10 D Date in format: yyyymmdd valid-to-on-sale-date 10 D Date in format: yyyymmdd end-reason 3 C Reason for delivery stop Each values dependent on client. promotion-source 10 C Source code pr-source-var 1 C Source code-Variation reference-doc 20 C Reference evidence Comprises order number of the old system. Apart from that it is identical with the field order-number. cust-order-nr 20 C Cust-order-nr custorder-date 10 D The date where the customer order was entered into the system. Date in format: yyyy-mm-dd subscr-phase 3 C subscription phase price-group 2 C Price group of customer stipulates possible reductions on basic price. price-key 4 C Price-key of customer Stipulates the basic price. payment-method 1 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. payment-method-details * sub-payment-method-code 3 C Subtype of Payment-method Sub type of Payment-method(Code) billing-frequency 2 C billing frequency billing-frequency-short-description 15C billing frequency short description quantity 10 C quantity sales-organization 4 C Sales-organization dsb-media1 1 C Field for free disposal. Is stored with the order. dsb-media2 2 C Field for free disposal. Is stored with the order. dsb-media3 3 C Field for free disposal. Is stored with the order. dsb-media4 4 C Field for free disposal. Is stored with the order. dsb-media2b 2 C Field for free disposal. Is stored with the order. dsb-media7 7 C Field for free disposal. Is stored with the order. agent-number 10 C Agent-number material-number 18 C Premium number Material-number of goods premium premium-description 50 C Premium description premium-dispatch-date 10 C Premium dispatch date Date in format: yyyy-mm-dd billing-payed-to 9 C Billing-payed-to copy no. Format: HHHH/YYYY issue-number-next-bill 9 C Issue no. of next invoice Default Format: HHHH/YYYY or any other client specific format /free text. issue-number-from-last-bill 9 C Issue no. from last bill Default Format: HHHH/JJJJ or any other client specific format /free text. issue-number-to-last-bill 9 C Issue-number-to-last-bill Default Format: HHHH/JJJJ or any other client specific format /free text. current-dunning-level 2 C Current-dunning-level ct-commitment-period 2 N Commitment-period Terms of contract: duration of commitment-period (regular cancellation after x months possible) ct-cancellation-period 2 N Cancelation-period Terms of contract: cancellation-period ct-renewal 2 N renewal Terms of contract: (autom.) extension of commitment-period dsb-urpos-lief 6 N Deliveryposition Reference Refer to the original delivery position sales-source 4 C Sales source advertising-medium 10 C Advertising medium sales-document-type 4 C Sales document type dispatch-type 2 C Dispatch type dispatch-text 5 C Dispatch text contract-account-balance 15 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 renewal * expiry-date 10 C The date at the which the subscription as a whole, will expire. Timestamp date ( YYYY-MM-TT ) * expiry-issue-nr 9 C The last Issue number that the subscriber will receive Default Format: HHHH/JJJJ or any other client specific format /free text. * renewal-due-date 10 C Due date for next payment Timestamp date (YYYY-MM-TT ) * number-issues-remaining N The number of issues, still to deliver If the requestflag 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. * current-cycle-number-of-issues N The number of issues that are in the renewal cycle * current-cycle-start-issue-nr 9 C Issue number at the start of the renewal cycle Default Format: HHHH/JJJJ or any other client specific format /free text. * current-cycle-start-date 10 C Start date of the renewal cycle Timestamp date (YYYY-MM-TT ) * current-cycle-expiry-issue-nr 9 C Issue number at the end of the renewal cycle Default Format: HHHH/JJJJ or any other client specific format /free text. * current-cycle-expiry-date 10 C End date of the renewal cycle Timestamp date ( YYYY-MM-TT ) * current-cycle-acceptance-date 10 C The date at which the subscriber accepted the renewal of their subscription Timestamp date (YYYY-MM-TT ) * current-cycle-offer 5 C Offer from current cycle * current-cycle-offer-type 2 C Offer type of the offer from current cycle (RN, DD or BU) * current-cycle-offer-description 100 C Offer description of the offer from current cycle (if filled) * current-cycle-offer-marketingtext 100 C Marketingtext of the offer from current cycle (if filled) * offer-classification 1C Klassifikation (Bundle, Membership, Normal etc.)B = bundle N = normal M = membership * offer-classification-definition 4C Offer classification definition * current-cycle-paid-amount 11,2 C Amount of the current order cycle * current-cycle-bundle-paid-amount 11,2 C Amount of the whole bundle Only relevant if it’s a valid bundled subscription * order-currency 5 C Order currency * renewal-bundle-component C M = Master, S = Slave * auto-renewal 1 C Y / N flag, if subscription is auto renewal * auto-renewal-next-payment-amount 11,2 N Amount of the next collection in the regarding subscription currency * auto-renewal-next-payment-frequency-code 2 C Frequency code of the next payment collection * auto-renewal-next-payment-frequency-text 15 C Frequency text/description of the next payment collection * auto-renewal-next-payment-date 10 C Date of the next payment collection Format YYYY-MM-TT * auto-renewal-last-payment-amount 11,2 N Amount of the last collection in the regarding subscription currency * auto-renewal-last-payment-frequency-code 2 C Frequency code of the last payment collection * auto-renewal-last-payment-frequency-text 15 C Frequency text/description of the last payment collection * auto-renewal-last-payment-date 10 C Date of the last payment collection Format YYYY-MM-TT * auto-renewal-actual-claim-counter N actual claim counter * auto-renewal-increase-claim-counter N increase claim counter bundled-subscription-info 0 … n * bundle-order-number 10 C Order number of this bundled Element * publication 8 C publication * edition 8 C edition * quantity 10 N quantity current-suspension * suspended-from-date 10 C Suspension from date Format YYYY-MM-TT * suspended-to-date 10 C Suspension to date Format YYYY-MM-TT * suspended-from-issue-nr 9 C Suspension from issue number * suspended-to-issue-nr 9 C Suspension to issue number * suspended-reason-code 3 C Suspension reason code change-info (to obtain this data, please contact your customer consultant. The customizing flag x_change_info must be set.) * future-mix-type 2 C Future mix type * future-mix-type-from-issue-nr 9 C Issue nr. from Sample 0009/2015 * future-mix-type-to-issue-nr 9 C Issue nr. toSample 0009/2015 * former-mix-type 2 C Former mix type * former-mix-type-to-issue-nr 9 C Issue nr. to Sample 0009/2015 * future-delivery-quantity 10 N Future delivery quantity * future-delivery-quantity-from-issue-nr 9 C From issue nr Sample 0009/2015 * former-delivery-quantity 10 N Former delivery quantity * former-delivery-quantity-to-issue-nr 9 C To issue nr Sample 0009/2015 * future-delivery-type 2 C Future delivery type * future-delivery-type-from-issue-nr 9 C From issue nr Sample 0009/2015 * former-delivery-type 2 C Former delivery type * former-delivery-type-to-issue-nr 9 C To issue nr. Sample 0009/2015 * future-dispatch-type 2 C Future dispatch type * future-dispatch-type-from-issue-nr 9 C From issue nr. Sample 0009/2015 * former-dispatch-type 2 C Former dispatch type * former-dispatch-type-to-issue-nr 9 C To issue nr. Sample 0009/2015 * future-dispatch-text 5 C Future dispatch text * future-dispatch-text-from-issue-nr 9 C From issue nr. Sample 0009/2015 * former-dispatch-text 5 C Former dispatch text * former-dispatch-text-to-issue-nr 9 C To issue nr. Sample 0009/2015 business-partner order-attribute Structure <business-partner> <business-partner> <role></role> <bp-number></bp-number> <full-salutation></full-salutation> <last-name1></last-name1> <last-name2></last-name2> <first-name></first-name> <nick-name></nick-name> <full-last-name></full-last-name> <name-addition></name-addition> <job-titel></job-titel> <titel></titel> <salutation-code></salutation-code> <salutation></salutation> <company1></company1> <company2></company2> <company3></company3> <company4></company4> <department></department> <zipcode></zipcode> <street></street> <street-suffix></street-suffix> <street-name></street-name> <street-number></street-number> <street-number-suffix></street-number-suffix> <address-line-1></address-line-1> <address-line-2></address-line-2> <address-line-3></address-line-3> <po-box-zipcode></po-box-zipcode> <po-box></po-box> <po-box-city></po-box-city> <major-cust-zip></major-cust-zip> <city></city> <district></district> <region-code></region-code> <region-text></region-text> <country-code></country-code> <country></country> <advertisement></advertisement> <block-tag></block-tag> <eu-sales-tax-number></eu-sales-tax-number> <date-of-birth></date-of-birth> <bic-master-number></bic-master-number> <sector></sector> <mobile-phone-number></mobile-phone-number> <phone-number></phone-number> <fax-number></fax-number> <email-address/></email-address> <!-- 0 ... n --> <ext-communication> <communication-type></communication-type> <communication-value></communication-value> <communication-default></communication-default> </ext-communication> <attribute> <attribute-type></attribute-type> <attribute-value></attribute-value> </attribute> <holiday-address> <valid-from></valid-from> <valid-to></valid-to> <street></street> <street-number></street-number> <street-number-suffix></street-number-suffix> <zipcode></zipcode> <zipcode-extension></zipcode-extension> <city></city> <district></district> <po-box></po-box> <po-box-extension></po-box-extension> <po-box-zipcode></po-box-zipcode> <po-box-city></po-box-city> <major-cust-zip></major-cust-zip> <major-cust-zip-extension></major-cust-zip-extension> <country-code></country-code> </holiday-address> </business-partner> Element Definitions Field name Length Type Text Remark, field supply or recoding role 2 C Type of business partner For example AG = orderer WE = consignee RE = invoice recipient bp-number 10 C Business partner no. full-salutation 60 C Mounted personal salutation last-name1 35 C Lastname 1 last-name2 35 C Lastname 2 first-name 35 C First-name nick-name 35 C Nick-name full-last-name 35 C Mounted last-name Inkl. last name, addition, intention name-addition 30 C Name-addition Name-addtion for example profession job-titel 35 C Job titel titel 35 C Academic Title salutation-code 2 C Salutation-Code in AVS/3 For example 01 = Mr. 02 = Ms. salutation 35 C Salutation For example: Mr., Ms. company1 35 C company 1. line of firm address. If this field is filled is the above name the contact person of the firm. company2 35 C company 2. line of firm address. Contains for example section or continuation of firm address. company3 35 C company 3. line of firm address company4 35 C company 4. line of firm address department 30 C department zipcode 10 C zipcode street 35 C Street with house no. and addition to house no. street-suffix 35 C Addition to street street-name 40 C Street Name street-number 20 C Street Number street-number-suffix 20 C Street Number Suffix address-line-1 35 C Address line 1 for UK addresses address-line-2 35 C Address line 2 for UK addresses address-line-3 35 C Address line 3 for UK addresses po-box-zipcode 10 C Po-box-zipcode Only filled when po-box-zipcode po-box 35 C Po-box Only filled when po-box-zipcode po-box-city 35 C Po-box-city Only filled when po-box-zipcode major-cust-zip 10 C Major-cust-zip city 35 C Ort district 35 C Addition of city region-code 3 C Regions-Code (federal state, province, county) region-text 25 C Region as cleartext (e.g. County…) country-code 2 C Country-code Two-digit country-code (for example ,de’ for Germany) country 30 C country advertisement 1 C Advertisement permitted Y = advertisement desired N = advertisement not desired block-tag 1 C General block-tag X = put block-tag <empty> = no block-tag actual not available eu-sales-tax-number 20 C EG-UST ID number date-of-birth 10 D Birthdate (YYYY-MM-DD) bic-master-number 10 C Partner-ID of master (for example firm of contact person) sector 10 C branch mobile-phone-number 30 C Mobile Telephone-No.: pre code + termination phone-number 30 C Telephone no..: pre code + termination fax-number 30 C Fax-No.: pre code + termination email-address 50 C IS-M: e-mail number ext-communication 0 … n * communication-type 2 C Communication Types Values * communication-value 50 C Communication value * communication-default 1 C Default value Y = yes N = no attribute * attribute-type 6 C Function of business partner attribute for example: type of address * attribute-value 50 C Attribute-value of business partner holiday-address 0 … n - valid-from 10 Cvalid from YYYY-MM-DD - valid-to 10 C valid to YYYY-MM-DD - street 35 C Street - street-number 10 C Street numer - street-number-suffix 8 C Street number extension - zipcode 10 C Zipcode - zipcode-extension 4 CErweiterung der Postleitzahl - city 35 C City - district 35 C District - po-box 35 C Pobox - po-box-extension 4 C Pobox extension - po-box-zipcode 10 C Pobox zipcode - po-box-city 35 C Pobox city - major-cust-zip 10 C Zipcode of company - major-cust-zip-extension 4 C Zipcode extension of company - country-code 3 C Country code Structure <order-attribute> <order-attribute> <type> </type> <value> </value> </order-attribute> Element Definitions Field nameLengthTypeTextRemark, field supply or encoding type 6 C Marks the type of attribute value 50 C Actual attribute value This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.OKMore information