Parameters
Home > Parameters

Parameters overview



Please make sure that you pass the URL-encoded parameters.

Parameters are the data that you pass when you call the API method. The parameters can be passed with HTTP-GET or also with HTTP-POST. Which parameters the individual API methods require can be found on the corresponding detail page of the API method.

Basically, both methods can be used with each API method. For each API method, a corresponding transfer method is recommended on the details page. Unnecessary parameters are ignored.

Example with HTTP-GET
This is what your URL looks like when you want to pass with HTTP-GET to the API method:

Code:
https://api.afterbuy.de/afterbuy/ShopInterface.aspx?Action=new&Lieferanschrift=0&PartnerToken=XXX&KLFirma=&KLVorname=&UserToken=XXX&KLNachname=&PosAnz=2&KLStrasse=&KLStrasse2=&Kbenutzername=Mustertester
&KLPLZ=&Kanrede=Herr&KLOrt=&KFirma=Mustermann+GmbH&KLLand=&KVorname=Max&KLBundesland=
&Artikelnr_1=54321&AlternArtikelNr1_1=159753&KNachname=Muster&AlternArtikelNr2_1=456852
&KStrasse=Musterstr.+33&Artikelname_1=Testartikel+API-Post&KStrasse2=Musterstr.+34&ArtikelEpreis_1=5%2C23&KPLZ=12345
&KOrt=Musterhausen&ArtikelMwSt_1=16&KBundesland=&ArtikelMenge_1=2&Ktelefon=01234+56789
&ArtikelLink_1=http%3A%2F%2Fwww.via.de&Kfax=01234+98765&ArtikelStammID_1=123456&Kemail=max%40muster.de
&ArtikelGewicht_1=0%2C5&KLand=D&Artikelnr_2=777777777&BuyDate=14.06.2010+16%3A19%3A12&SetPayDate=14.06.2010+16%3A19%3A12
&AlternArtikelNr1_2=159753&AlternArtikelNr2_2=456852&kommentar=Bla+Kommentar&Artikelname_2=Testartikel+API-Post-2
&Versandgruppe=Shop&Versandart=Post&ArtikelEpreis_2=4%2C25&Versandkosten=6%2C80&ArtikelMwSt_2=16&ZahlartenAufschlag=1%2C20
&ArtikelMenge_2=3&ArtikelLink_2=http%3A%2F%2Fwww.afterbuy.de&ArtikelStammID_2=123456&MarkierungID=&ArtikelGewicht_2=0%2C5
&USStID=196F55C5A&Zahlart=%DCberweisung&ZFunktionsID=1&NoFeedback=0&VID=&SoldCurrency=EUR&VMemo=
&Bankname=&attribute_1=farbe%3Ablau%7Cgr%F6%DFe%3AXXL&BLZ=&Attribute_2=&Kontonummer=&Kundenerkennung=0
&Kontoinhaber=&Artikelerkennung=0&EKundenNr=&Bestandart=auktion





Parameter Default value Data type Data length Mandatory information Meaning
Action
new
String
3
Yes
Name of the desired action (default "new") - further option "CheckUserId".
PartnerToken
N/A
String
N/A
Yes
Partner token is created in Afterbuy when ordering interface access.
(Read Authentication)
UserToken
N/A
String
N/A
Yes
User token (Account token) is displayed in Afterbuy under Account-> Bestellte Schnittstellen anzeigen.
PosAnz
N/A
Integer
N/A
Yes
Number of items (articles) to be transferred to the order.
Kbenutzername
N/A
String
50
Yes
The username of the buyer used in your system.
This is displayed in the auction overview as eBayName.

Hint:
The assigned interface name is always placed in front of your access data.

Example:
Interface name = testschnittstelle
eBayName: testschnittstelle - Ihre_Angaben_in_KBenutzername

The maximum number of characters includes your interface name, i.e. for the above example the example interface name (17 characters) still leaves 34 characters for the KBenutzername.

Attention: The field must be unique for your account. You can also use an email address at this point, for example, to ensure this.
Kanrede
N/A
String
150
No
Salutation of the buyer.
KFirma
N/A
String
150
No
Company name of the buyer.
KVorname
N/A
String
150
Yes
First name of the buyer.
KNachname
N/A
String
150
Yes
Last name of the buyer.
KStrasse
N/A
String
150
Yes
Street + house number of the buyer.
KStrasse2
N/A
String
150
No
Additional information about the street of the buyer.
Example:
3rd floor
KPLZ
N/A
String
150
Yes
Zip code of the buyer.
KOrt
N/A
String
150
Yes
Location of the buyer.
KBundesland
N/A
String
150
No
State of the buyer.
Ktelefon
N/A
String
150
No
Phone number of the buyer.
Kfax
N/A
String
50
No
Fax number of the buyer.
Kemail
N/A
String
150
Yes
Email address of the buyer.

This is the identifier if you run the customer recognition (see below) through the email address.
KLand
N/A
String
10
Yes
Billing country of the buyer.
The country is specified in the format of the car license plate.
Example for Germany: D

Here you can find an overview of the current car country codes: Wikipedia
KBirthday
N/A
Date
N/A
No
Date of birth of the buyer
Lieferanschrift
N/A
Boolean
1/0
No
Indicates whether a different delivery address belongs to the order.

1 = different delivery address exists
(Invoice address != delivery address)
0 = no different delivery address available
(Invoice address = delivery address)

Afterbuy does not check whether the delivery address is the same as the billing address, i.e. if the identical address is given as the delivery address, this information is simply taken over.
KLFirma
N/A
String
255
No
Delivery address - Company of the buyer
KLVorname
N/A
String
255
No
Delivery address - First name of the buyer.
KLNachname
N/A
String
255
Yes/No
Delivery address - Last name of the buyer.

Mandatory for parameter "Lieferanschrift = 1"
KLStrasse
N/A
String
255
Yes/No
Delivery address - Street + house number of the buyer.

Mandatory for parameter "Lieferanschrift = 1"
KLStrasse2
N/A
String
255
No
Delivery address - Additional information about the street of the buyer.
KLPLZ
N/A
String
255
Yes/No
Delivery address - Zip code of the buyer.

Mandatory for parameter "Lieferanschrift = 1"
KLOrt
N/A
String
50
Yes/No
Delivery address - Location of the buyer.

Mandatory for parameter "Lieferanschrift = 1"
KLLand
N/A
String
50
Yes/No
Delivery address - Country of the buyer.
The country is specified in the format of the car license plate.
Example for Germany: D

Here you can find an overview of the current car country codes: Wikipedia
Mandatory for parameter "Lieferanschrift = 1"
KLTelefon
N/A
String
255
Yes/No
Delivery address phone number
Haendler
N/A
Boolean
0/1
No
Sets the dealer status in the buyer record.
Artikelnr_1  
N/A
Long Integer
N/A
Yes
The numerical item number of the first item.
AlternArtikelNr1_1  
N/A
String
100
No
The alphanumeric item number of the first item.
AlternArtikelNr2_1  
N/A
String
20
No
The alphanumeric item number of the first item.
Artikelname_1  
N/A
String
255
Yes
Name of the first article.
ArtikelEpreis_1  
N/A
Float
0,00
Yes
Unit price (in gross) of the first item.
ArtikelMwSt_1  
N/A
Float
0,00
Yes
VAT of the first article.
ArtikelMenge_1  
N/A
Integer
10
Yes
Order quantity of the first item.
ArtikelGewicht_1  
N/A
Float
0,00
No
Single weight of the first item.
ArtikelLink_1  
N/A
String
255
No
Direct link of the first article.
Attribute_1  
N/A
String
255
No
Selected attributes for the first item.

Hint:
You can find more information about the transfer syntax below in the "further explanations" section.
ArtikelStammID_1  
N/A
Integer/String
N/A
No
Afterbuy "Stammartikel-ID" for unique assignment to an Afterbuy product.

Hint:
The specified value depends on the specification in the "Artikelerkennung" parameter (see "Further explanations" below)
ArtikelTag_X_1  
N/A
Integer/String
N/A
No
Assign existing tags (ArtikelTag_x_1 - ArtikelTag_x_5) to a sale
Artikelnr_x
...
ArtikelStammID_x
N/A
N/A
N/A
N/A
This information can be repeated as often as specified under PosAnz.
Where x is to be replaced with the position number.
Kommentar  
N/A
Text
N/A
No
Buyer's comment about the order.
UseComplWeight  
0
Boolean
0/1
No
Do not use Afterbuy product weight.

With the value 1 the transferred weight is taken over, otherwise the weight from the Afterbuy product is taken over, if a product is recognized due to the "article recognition".
UseProductTaxRate
0
Boolean
0/1
No
Use VAT stored in Afterbuy from the VAT table.

If the value is 1, the VAT is determined based on the data in the VAT table in Afterbuy.
BuyDate  
now
Datetime
dd.mm.YYY H:i:s
No
Purchase date/auction end
With this specification you can pass your own date + time for the auction end/buy date/order date.

If no BuyDate is passed, the date + time of the transfer is taken.
Bestandart  
auktion
String
7
No
Stock type for stock reduction.
With this specification you can indicate from which stock field the transferred quantity for the item should be debited.

Possible values: auktion/shop
Versandart  
N/A
String
150
No
Shipping method name of the order
ReturnCarrier
N/A
String
150
No
Return shipping type name of the order
Versandkosten  
N/A
Float
0,00
No
Shipping costs (in gross) of the order
ZahlartenAufschlag  
N/A
Float
0,00
No
Payment method surcharge for the selected payment method of the order.
Example: Cash on delivery charge
Zahlart  
N/A
String
150
No
Payment method of the order.
Example: Prepayment
ZFunktionsID  
N/A
Integer
N/A
No
Afterbuy internal ID of the payment method.
The field can be used if no default payment type is passed.
In that case the ZFunktionsID can be passed to support the functions of the filters and the feedback page.
The list of valid ID's can be found in the Afterbuy variable list.  

Hint:
If a payment type is passed, this field will be overwritten if the payment type can be found in the following list:

Bank transfer: ZFunktionsID = 1
Cash/Collection: ZFunktionsID = 2
Cash on delivery: ZFunktionsID = 4
Paypal: ZFunktionsID = 5
Bank transfer/Invoice: ZFunktionsID = 6
Direct debit: ZFunktionsID = 7
Click&Buy: ZFunktionsID = 9
Express purchase/Bonicheck: ZFunktionsID = 11
Instant bank transfer: ZFunktionsID = 12
Cash on delivery/Creditworthiness check: ZFunktionsID = 13
Ebay Express: ZFunktionsID = 14
Moneybookers: ZFunktionsID = 15
Credit card: ZFunktionsID = 16
Direct debit: ZFunktionsID = 17
Billsafe: ZFunktionsID = 18
Credit card payment: ZFunktionsID = 19
Ideal: ZFunktionsID = 20
Carte Bleue: ZFunktionsID = 21
Online bank transfer: ZFunktionsID = 23
Giropay: ZFunktionsID = 24
Dankort: ZFunktionsID = 25
EPS: ZFunktionsID = 26
Przelewy24: ZFunktionsID = 27
Carta Si: ZFunktionsID = 28
Postepay: ZFunktionsID = 29
Nordea Solo Sweden: ZFunktionsID = 30
Nordea Solo Finland: ZFunktionsID = 31
Billsafe Installment purchase: ZFunktionsID = 34
Bankname  
N/A
String
50
No
Name of the buyer's bank.
BLZ  
N/A
String
50
No
Sort code of the buyer's bank.
Kontonummer  
N/A
String
50
No
Buyer's account number
Kontoinhaber  
N/A
String
255
No
Account holder of the buyer
UsStID  
N/A
String
50
No
The VAT ID of the buyer
Notice:
A check for the validity of the VAT ID does not take place.
NoFeedback  
N/A
Integer
0,1,2
No
Specifies whether the order should be completed in Afterbuy (set feedback date) and whether an initial contact email should be sent from Afterbuy.

Possible entries:
0 = Set feedback date (do not send email).
1 = Do not set feedback date (send email)
2 = Set feedback date (send email)

Hint:
Prerequisite for sending the email is the activation of the option "ErstKontaktmail versenden" in the settings in your Afterbuy account.
NoVersandCalc  
0
Boolean
0/1
No
Specifies whether no attempt should be made to determine the shipping costs on the part of Afterbuy, as well as the weight, the shipping group and the CrossCatalog.

0 = Shipping cost calculation on the part of Afterbuy.
1= No shipping cost calculation on the part of Afterbuy - transferred shipping costs are retained.
Versandgruppe  
N/A
String
shop or empty/whitespace
No
Determines whether the value from "Versandgruppe Shop" or "Versandgruppe" is used.
MwStNichtAusweisen  
0
Boolean
0/1
No
Specifies whether VAT should be not shown, e.g. when printing an invoice.

0 = VAT is shown
1 = VAT is not shown
MarkierungID  
N/A
Integer
N/A
No
Afterbuy internal ID of the own marking. By specifying a valid ID, the transaction will be marked in Afterbuy with the assigned color.

Hint:
Marker must also be created, otherwise you will get a corresponding error message.
You can find the ID of the markers in your Afterbuy account.
EKundenNr  
N/A
Integer
N/A
No
Own customer number.
If specified, this customer number will be assigned to the customer.

Hint:
Afterbuy always generates an internal customer number for internal identification.
Kundenerkennung  
0
Integer
0/1/2
No
Specifies how an existing customer should be recognized in Afterbuy.

0 = eBay name (KBenutzername)
1 = Email address (Kemail)
2 = Own customer number (EKundenNr)
NoeBayNameAktu  
0
Integer
0/1
No
Specifies whether the eBay name should not be overwritten.

0 = overwrite eBay name
1 = Do not overwrite eBay name

Hint:
If an existing customer is recognized by the customer ID, the eBay name is overwritten with KBenutzername by default, which has the consequence that this customer is no longer recognized as existing for the next eBay order, because the eBay name is no longer present.
Artikelerkennung  
0
Integer
0/1/2
No
Specifies how an existing product should be recognized in Afterbuy.

0 = Afterbuy ProductID
1 =Afterbuy article number
2 = Afterbuy external item number
13 = Manufacturer EAN

Hint:
This selection refers to the specification for the parameter "ArtikelStammID_x".
That is the value specified in "ArtikelStammID_x" must contain in the Afterbuy product in the field ProduktID, article number, external article number, or manufacturer EAN.
VMemo  
N/A
String
1000
No
Information about the operation - this is entered into the operation memo.
OrderInfo1
N/A
String
255
No
OrderInfo 1
OrderInfo2
N/A
String
255
No
OrderInfo 2
OrderInfo3
N/A
String
255
No
OrderInfo 3
VID  
N/A
String
40
No
Own VorgangsID.
Here you can enter e.g. your order number.
This information can also be used to search for the transaction in Afterbuy.
SoldCurrency  
EUR
String
3
No
Currency of your sale.
Example: CH or GBP

Hint:
If not passed, 'EUR' is taken by default.

For other currencies, the price is converted according to the account currency and the current daily exchange rate.
The daily exchange rate is requested daily from the European Central Bank.
SetPay  
N/A
Boolean
0/1
No
Mark Afterbuy transaction as paid.
This will post the invoice amount of the transaction as the payment total.

0 = Do not set paid status
1 = Set paid status
SetPayDate  
N/A
Date
dd.mm.YYY
No
Payment date
With this specification, if the parameter is "SetPay=1", you can pass a payment date.

Hint:
If no payment date is passed and paramter is "SetPay=1", then the current date from the transfer to Afterbuy is set as the payment date..
CheckVID
N/A
Boolean
0/1
No
Protection against double import
In order for the protection to be successful, you should pass a unique value for the order in the "VID" parameter.
We recommend to pass the order number from your external system. This order number is unique for the given order.
CheckPackstation
0
Boolean
0/1
No
Check for packing station only in the delivery address.

If the value 1 is passed for this parameter, the system checks whether the data in KLVorname and KLNachname as well as KLStrasse and KLStrasse2 contain a valid packing station. The address data will then be converted Intraship- or EASYLog-optimized as selected in the shipping settings.
OverrideMarkID
0
Boolean
0/1
No
If the MarkierungID parameter is used and a mark is stored in the shipping settings at the packing station, OverrideMarkID indicates which mark has priority.

0: MarkierungID parameter has priority
1: Marking for packing station has priority
BillsafeTransactionID
N/A
String
50
No
If the BillsafeTransactionID is already known in the external shop, the TransactionsID can be assigned to this parameter.
BillsafeOrdernumber
N/A
String
50
No
This is the transaction number/string with which your shop reported the transaction to BillSafe. You should pass this transaction number/string to Afterbuy via the parameter "BillsafeOrdernumber".
BIC
N/A
String
75
No
BIC
IBAN
N/A
String
75
No
IBAN
reference
N/A
String
50
No
Reference number
If you do not pass the "reference", it is automatically assigned by the system and corresponds to the internal Afterbuy customer number.
If you pass your own value, you have to check the uniqueness in the connected store system.
PaymentStatus
N/A
String
20
No
Payment status, status of a payment provider (PayPal, Sofortüberweisung, Credit card payment, iDeal, Carte Bleue, Online bank transfer, Giropay, Dankort, EPS, Przelewy24, Carta Si, PostePay, Nordea Solo Sweden, Nordea Solo Finland)
PaymentTransactionId
N/A
String
25
Yes/No
Transaction id of a payment provider

Mandatory if PaymentStatus is specified

»

Further explanations



Customer recognition
When recognizing customers with email addresses, it should be noted that if a customer with the same email address was saved several times, the customer that was found first during the recognition will be taken over.

Article recognition
When recognizing the products with article number or EAN, it must be noted that in the case of duplicate ANR or EAN, the data records that are found first during recognition are used.
The ANR or EAN must be transferred for recognition in the field ArtikelStammID_x.

Passing attributes
The selected attributes for an article must be passed in the following systax:
Code:
Attribute name_1:Value_1Attribute name_2:Value_2|...|Attribute name_x:Value_x


Example:
Color:Blue|Size:XXL

Important:
The attribute names and values must not contain the ":" and "|" separators.
Line breaks are not permitted.
© Copyright 2003 - 2023 ViA-Online GmbH – All rights reserved | www.afterbuy.de