IDS- (Integrated data interface) - WEBSALE Dokumentation

A tradesman system accesses the shop via the integrated data interface. It sends product numbers and optionally a delivery address, and it picks up the finished basket again. The IDS- tags make these two directions visible in the template: the passed delivery address for display, and the data for returning the basket. All tags on this page require that the interface is enabled for the shop. Without activation, the area tags do not take effect and the single tags remain empty. Guide: Integrated data interface

Displaying the passed delivery address

If the tradesman system sends a delivery address, the shop displays it and passes it on in the additional order information. It is only displayed and is not used as the shop’s delivery address. If no address is sent, the address stored in the shop applies. IDS-Delivery is the area tag around the whole block. It takes effect if any address was passed at all.

{IDS-Delivery}
   <h2>Lieferadresse aus Ihrem System</h2>
   <address>
      {IDS-Delivery_Name1}~IDS-Delivery_Name1~<br>{/IDS-Delivery_Name1}
      {IDS-Delivery_Name2}~IDS-Delivery_Name2~<br>{/IDS-Delivery_Name2}
      {IDS-Delivery_Street}~IDS-Delivery_Street~<br>{/IDS-Delivery_Street}
      {IDS-Delivery_PCode}~IDS-Delivery_PCode~ {/IDS-Delivery_PCode}
      {IDS-Delivery_City}~IDS-Delivery_City~<br>{/IDS-Delivery_City}
      {IDS-Delivery_Country}~IDS-Delivery_Country~{/IDS-Delivery_Country}
   </address>
{/IDS-Delivery}

Each field has its own area tag, because hardly any address fills all fields. Without the area tag, the output would otherwise contain empty lines and stray separators.

The fields

The interface defines these suffixes:

Suffix	Content
`Name1` to `Name4`	the four name lines
`Street`	street and house number
`PCode`	postal code
`City`	city
`Country`	country
`ILN`	the International Location Number
`Contact`	contact person
`Phone`	phone number
`Fax`	fax number
`Email`	email address

Write the suffix exactly as specified in the IDS interface description. The shop system builds the name of the element to look for in the passed data from the suffix. A suffix written differently finds nothing, and the area tag then simply does not take effect, without any recognizable error.

The shop system does not check against the list above. It searches for every suffix you specify. If the interface extends its address block by another field, you can output it immediately with IDS-Delivery_<Feldname>, without waiting for a new shop version.

Returning the basket

There are two tags for the way back to the tradesman system. They provide the two pieces of information that the collecting system needs.

Tag	Returns
`IDS-SendBasketHookURL`	the address to which the basket is returned
`IDS-SendBasketPayloadJSEncoded`	the basket data, prepared for embedding in JavaScript

Both are also area tags and take effect if the interface is active and the respective value is available.

{IDS-SendBasketHookURL}
   <form action="~IDS-SendBasketHookURL~" method="post" id="ids_rueckgabe">
      ...
   </form>
{/IDS-SendBasketHookURL}

These two tags are not described in the previous documentation. The naming of the return and its process belong in the guide; this page only covers what the tags return.

The link to the shop page that triggers the return is provided by WS-IDSSentBasketLink from the WS- group. It belongs to the same process but is not under this prefix.

Product numbers not added to the basket

If the tradesman system sends product numbers that the shop does not know, it names them in a message. The placeholder for this is ~IDS-PRNumbers~.

~IDS-PRNumbers~ is not a template tag. The placeholder is part of the text of the message that you store in the shop configuration shop.config in the <NotifyMessages-Txt> section under IDSNoBasketInput. When outputting the message, the shop system replaces it with the affected product numbers. Written in a template, it has no effect.

<NotifyMessages-Txt>

   IDSNoBasketInput = Folgende Produktnummern sind unbekannt: ~IDS-PRNumbers~

</NotifyMessages-Txt>

In the template, you output the finished message with MSG-IDS_Notify.

{MSG-IDS_Notify}
   <p class="hinweis">~MSG-IDS_Notify~</p>
{/MSG-IDS_Notify}

Reference: MSG- (Messages) · Reference: NotifyMessages-Txt section

The tags at a glance

Tag	Single tag	Area tag	Negative area tag	Loop tag
`IDS-Delivery`	–	yes	yes	–
`IDS-Delivery_<Suffix>`	yes	yes	yes	–
`IDS-SendBasketHookURL`	yes	yes	yes	–
`IDS-SendBasketPayloadJSEncoded`	yes	yes	yes	–

The tags are permitted on all templates. Naturally, the delivery address is only available from the order process onward, usually on the order overview page ws_place_order.htm.

IDS-Delivery without a suffix works exclusively as an area tag. Written as a single tag, it outputs nothing, even if an address is available. You always retrieve the individual values using the suffix notation.

Guide: Integrated data interface
Reference: MSG- (Messages)
Reference: WS- (General tags)

​Displaying the passed delivery address

​The fields

​Returning the basket

​Product numbers not added to the basket

​The tags at a glance

​Related topics

Displaying the passed delivery address

The fields

Returning the basket

Product numbers not added to the basket

The tags at a glance

Related topics