PDF Export

getByBpNumber (Version 2)

  • Object: /net/dsb/avs3/SubscriptionOrder
  • Method: getByBpNumber
  • Version: 2.0.0
  • Fuba: /DSB/ISM_E_SEL_VBELN_TO_GP

This method retrieves all subscription orders related to the referred AVS/3 business-partner. This includes all orders that relates to this partner in any role and includes orders where this partner was related in the past. You have to check the returned orders if you only want orders where the partner is currently related. The result can contain none, one or more subscription orders. It can be searched within the active as well as the inactive orders. This is controlled by the request element only-active-subscription.

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

Name Type / Length Opt. / Mandat. Description
bp-number AN / 10 m Business Partner Number
role-ag AN / 1 k 'Y' / 'N' for AG orderer
role-re AN / 1 k 'Y' / 'N' for RE invoice recipient
role-vm AN / 1 k 'Y' / 'N' for VM procurer.
role-we AN / 1 k 'Y' / 'N' for WE consignee
publication AN / 8 kCode for the magazine (publication), which should be observed in search of
mix-type AN / 2 k mix type
send-invoice-recipientAN / 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 Y = Yes
N = No (default)
only-active-subscription AN / 1 k return only the active subscriptions
Y = Yes (Default)
N = no

Response Element

XML-Structure 'subscription-order'. This structure meet the description of 'new-subscription'

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>
    <bp-number>1003701415</bp-number>
    <role-ag>Y</role-ag>
    <role-re>Y</role-re>
    <role-vm>Y</role-vm>
    <role-we>Y</role-we>
    <return-current-we-address>N</return-current-we-address>
    <return-valid-to-by-evt>N</return-valid-to-by-evt>
    <only-active-subscription>N</only-active-subscription>
  </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

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