PDF Export

Articles

Get the article data from the backend.

This web service can be used for avs offer articles and vhs articles.

AVS articles / subscription offers

Path mapping(intern): /net/dsb/avs3/ArticleMaster/getArticleComplete-1.0.0
SAP REST: /GET_SHOP_ARTICLES or /GET_SHOP_ARTICLES_BY_NUMBER

URL

GET: /rest/{client}/articles?so=xx&sales-channel=xx&articleupdated-since=xxx

Parameter Description
client client ID
sp service provider. (mandatory if the user account can use different service provider values)
so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client)
sales-channel sales channel. (optional)
max-hit-count maximum number of results
from-hit start result at this article count
articleupdated-since Read changed articles only from a this time. (optional) Timestamp in ISO Format, e.g. 2017-01-01T12:00:00Z
deleted if true: Read the deleted articles. (optional)
prev-unread-only if true: returns changed articles, that are not yet acknowleged. Use Acknowledge processed articles or Acknowledge deleted articles for Acknowledgment. (default:false). (optional)
articles 0 … 100 article numbers (optional) → only in conjunction with sp, so BETA

You can do a paged query with max-hit-count and from-hit count. Do this queries with the other parameters unchanged until you get less than max-hit-count results.

Example:

  1. query from-hit=1;max-hit-count=100 –> 100 results
  2. query from-hit=101;max-hit-count=100 –> 100 results
  3. query from-hit-count=201;max-hit-count=100 –> 87 results –> query is complete

Response

HTTP Response Status Meaning
200 Success
401 Authorization required
500 Internal error

Recom-Engine

In AVS/3 there is a mapping of order related characteristics that includes a parent-child assignment for different business cases (categories). The following characteristics can be defined in each case: source code, source code variant, offer, valid-from date, publication, mix typ, sales source, payment method. If there is no explicit definition, it is handled as a wildcard. In this way the respective alternative order characteristics can be assigned to leading order characteristics.

Depending on the application, this service is used in different ways. Not all functions are available for all clients. Please check with your client manager which functions are available for you. Those parameters are available for all clients and subscription models:

Path mapping(intern): /net/dsb/avs3/ArticleMaster/getArticleAlternatives-1.0.0
SAP REST: /GET_ALT_ARTICLES

Parameter Description
client client number
sp Service provider code. (Mandatory field if the user account uses more than one service provider code.)
category Includes certain business cases within the Recom-Engine. For example.: CATEGORY=SCRIPT
campaign Example campaign = EFF01
source Includes certain sources e.g.: SOURCE=SCR01
activity Includes certain contact activities, eg: CT_ACTIVITY=SC01
actionType DM = DarkMode, TF = To Forward
channel channel to filter

Please enter only one value at a time. If these parameters are omitted, this category is a wildcard (all entries are relevant). Source and contact activities return explicitly empty values.

Available for non-liability account subscriptions, mainly used for German clients

Determine all articles to a recommended article ID

For non-liability account subscriptions, a shop article id is provided out of the ccb jet_shop table (/DSB/JET_SHOPD). The returned output are the article numbers for the recommendation.

URL

GET: /rest/{client}/articles/{articleId}/articlealternatives?sp=xx

Parameter Description
articleId article ID

Response

It is possible to return all recommended articles for the non-liability account subscriptions modell.

GET: /rest/{client}/articlealternatives/full?sp=xx

Response

Available for the renewal subscription and the non-liability account subscriptions within all clients

The subscription number is used to determine the relevant order characteristics to get the recommended articles.

URL

GET: /rest/{client}/subscriptions/{orderNumber}/articlealternatives?sp=xx&filter=PUBLICATION

Parameter Description
orderNumber subscription order number
filter The results can be restricted by using a filter parameter. It is also possible to use more than one filter. In this case the values need to be separated via commas. E.g. FILTER=PUBLICATION,SHOPARTICLES).
PUBLICATION: the filter criteria is the publication code of the provided order number.
SHOP_ARTICLES: All recommended entries that are available as a shop article (having a shop article ID) are returned. Depending on the subscription model of the client the corresponding articles within their specific structure are returned.

Response

It is also possible to provide order specific characteristics within the API call. Below is a list with all possible characteristics to get the recommended shop articles.

URL

GET: /rest/{client}/articlealternatives?sp=xx&sourceCode=ABC&….

Parameter Description
sourceCode source code
sourceCodeVariant source code variant
validFrom valid from date (ISO Format)
publication publication code
edition edition code
offerCode offer code
mixType mix type
filter The results can be restricted by using a filter parameter. It is also possible to use more than one filter. In this case the values need to be separated via commas. E.g. FILTER=PUBLICATION,SHOPARTICLES). PUBLICATION: the filter criteria is the publication code of the provided order number. SHOP_ARTICLES: All recommended entries that are available as a shop article (having a shop article ID) are returned. Depending on the subscription model of the client the corresponding articles within their specific structure are returned.

Response

HTTP Status for all variants

HTTP Response Status Meaning
200 Success
401 Authorization required
500 Internal error

VHS articles / back issues, marketing articles, ..-

URL

GET: /rest/{client}/articles?max-hit-count=xx&from-hit=xx

Parameter Description
client client id
sp service provider. (mandatory if the user account can use different service provider values)
response type of response:
- articles-complete : return complete article data like the SOAP service ArticleMaster:getArticleComplete.
Only “articles-complete” is supported by now
max-hit-count maximum number of articles received. (optional)
from-hit Number of the first article received. (optional)
include-inactive true / false (default). Read inactive articles too
articleupdated-since Read changed articles only from a this time. (optional) Timestamp in ISO Format, e.g. 2017-01-01T12:00:00Z
price-lists price-lists for which you want to query the prices. Format: price-lists=ABC,DEF. Use price-lists=ALL_PRICES to get all prices.
with-sc get source code with price lists (true/false) (default: false)
omitProductGroups list of product groups that shouldn't be returned

To avoid long running requests and huge responses you should implement a paged request. Use max-hit-count to limit the response. Use from-hit in the next request to get the next page.

Corresponing SOAP Service: getArticleComplete.

Response

HTTP Response Status Meaning
200 Success
401 Authorization required

single VHS article

BETA

URL

GET: /rest/{client}/article??sp=xxx&distArticleNr=xxx

Parameter Description
client client id
sp service provider. (mandatory if the user account can use different service provider values)
priceLists price lists for which you want to query the prices. Format: priceLists=ABC,DEF. Use priceLists=ALL_PRICES to get all prices.
distArticleNr distribution article number of the article. Only one of the two article numbers is required
distArticleNrExt external article number of the article. Only one of the two article numbers is required
countryCodeType Controls which types of country-code will be returned. car = triple-digit int.car country-code iso = two-digit ISO countycode

Corresponing SOAP Service: getarticle_1_0_0.

Response

HTTP Response Status Meaning
200 Success
401 Authorization required
This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information