...
Parameters | Required field | Max. Length <>255 Characters | Comment |
|---|---|---|---|
Deliverer | 510 | Name of the delivery service. The names are freely assignable in the shop, e.g. UPS, DHL, ... | |
DelivererType | 64 | Supplier type. Freely assignable in the shop | |
DelivererID | 64 | Supplier ID. Freely assignable in the shop | |
<+DelivererAdditionalInfo> | -- | Subsection for each additional information of a shipping type | |
ID | 128 | ID from the shop configuration | |
Info | Info text from the shop configuration | ||
</+DelivererAdditionalInfo> | -- | End of subsection | |
<+DelivererAdditionalInput> | -- | Subsection if additional input field for a shipping method (if MultiDelivererSelection is disabled) | |
ID | 128 | ID from the shop configuration | |
FieldDescr | 1024 | Description of the input field from the shop configuration | |
Input | 128 | entered text of the buyer | |
</+DelivererAdditionalInput> | -- | End of subsection | |
IDCardNumber | 20 | Delivery by hand plus: ID card number | |
IDCardType | Integer | Delivery Personally Signed Plus: Type of ID card (freely assignable) | |
IDCardAuthority | 30 | Delivery Personal Plus: Name of the issuing authority | |
DeliveryDate | 10 | Requested delivery date. Format: DD.MM.YYYY | |
ConditionsAcceptedDate | 10 | Date when the buyer accepted the terms and conditions in the format YYYY-MM-DD | |
ConditionsAcceptedTime | 8 | Time when the buyer accepted the terms and conditions in the format HH:MM:SS | |
TotalWeight | float | Total weight of the order | |
TotalVolume | float | Total volume of the order | |
PriceType | X | Gross Net | Values: Gross, Net Item prices in the shop are gross (Gross) or net prices (Net) |
Currency | X | 3 | International 3-digit currency code, e.g. "EUR". |
CommunityMember | yes no | Only if the CommunityInterface is used: Buyer has authenticated as community member | |
CommunityMemberShip | 255 | Only if the CommunityInterface is used: Type of membership | |
CommunityUserID | 64 | Only if the CommunityInterface is used: User ID in the authorization system | |
PaymentType | 64 | Technical name of the payment type. E.g. CreditCard, CashOnDelivery, DebitNote, Bill, Prepayment, etc. | |
PaymentName | 255 | Language-dependent name of the payment type, e.g. "Cash on delivery". | |
PaymentCode | Integer | Payment method code 1=credit card | |
PayPalComputopPayID | 255 | Only for online clearing with PayPal via Computop. The PayID of Computop. See Computop documentation. | |
PayPalComputopTransactionID | 255 | Only for online clearing with PayPal via Computop. The transaction number in the PayPal system. See Computop documentation. | |
VoucherNumber | 19 | The number of the redeemed voucher | |
VoucherRest | float | The remaining amount of the redeemed voucher | |
VoucherChargeID | 64 | The batch ID of the redeemed voucher | |
VoucherAmount | float | The redeemed amount of a voucher. For example, if a voucher worth 100€ was redeemed, although the invoice amount was only 25€, this would read "25.00". | |
VoucherPositionAmount | float | Sum of voucher amounts determined on position level | |
VoucherVATRate | float | VAT rate of the voucher | |
VoucherVATIndex | Integer | VAT index of the voucher | |
VoucherType | absolute percental | Type of voucher: absolute or percentage | |
VoucherRate | float | percentage voucher value (e.g. 5.00 for 5% voucher) | |
VoucherChargeCreator | 128 | First name and last name of the batch creator who created the batch in OSB | |
VoucherChargeLabel | 128 | Batch label that can be selected in the OSB via drop-down list | |
SpecialFeaturesAdditionalProductFieldsFilter | yes | Voucher is dependent on product data fields (yes) | |
SpecialFeaturesAdditionalProductFieldsFilter_SetBehavior | asUnit/single | Set subproducts are considered as a unit or checked individually | |
SpecialFeaturesAdditionalProductFieldsFilter_fieldname_X | 128 | technical field name of the product data field to be checked (X: number of the filter) | |
SpecialFeaturesAdditionalProductFieldsFilter_valuelist_X | 1024 | comma-separated list of values that must be contained in the product data field (X: number of the filter) | |
OrderOption_Name-X (X=1..5) | 255 | Name of the order option | |
OrderOption_Price-X (X=1..5) | float | Cost of the order option | |
OrderOption_VAT-X (X=1..5) | float | VAT rate of the order option | |
TS_ID | 32 | Trusted Shops ProductID | |
TS_ERPID | 255 | A Trusted Shops ProductID, which can be assigned by the WWS | |
TS_Name | 255 | Trusted Shops product name | |
TS_VAT | float | The VAT rate of the Trusted Shops product | |
TS_Cost | float | The cost of the Trusted Shops product | |
WSPartnerID | 128 | The partnerID of the WEBSALE Affilinet system | |
WSPartnerCode | 128 | The entered PartnerCode of the WEBSALE Affilinet system | |
UploadID | 8 | The unique UploadID of an order (for file uploads) | |
UploadLink | 4096 | Link to the data upload | |
DownloadID | 8 | The unique DownloadID of an order (for file downloads) | |
DownloadLink | 4096 | Link to the download module | |
OfferID | 128 | The unique ID when ordering an offer | |
RefText | 50 | The reference text for an order | |
RefText2 | 50 | The additional reference text for an order | |
CostCenterEmailAddress | 64 | eMail address of the releaser for the payment type cost center | |
WishListOrder | yes | Set if at least one item of the order was bought from a wish list | |
AutoOrder | yes | Set if the order was triggered by the order generator | |
AutoOrderTestMode | yes | Set if the order was triggered by the order generator in test mode | |
UserDiscountRate | X | float | Customer discount rate in % |
UserDiscount | X | float | Value of customer discount |
PaymentDiscountRate | X | float | Payment discount rate in % |
PaymentDiscount | X | float | Value of payment type discount |
OrderDiscountRate | X | float | Value of goods discount in |
OrderDiscount | X | float | Value of the discount |
GroupDiscount | X | float | Value of the grouping discount |
ProductDiscount | X | float | Value of direct product discount |
PaymentCostDiscountRate | float | Payment cost discount rate in | |
PaymentCostDiscount | float | Value of payment cost discount | |
DeliveryCostDiscountRate | float | Delivery cost discount rate in % | |
DeliveryCostDiscount | float | Value of delivery cost discount | |
OrderOption_VAT Index-X | Integer | Value added tax index of the order option | |
TS_VATIndex | Integer | Value added tax index of the TrustedShop product | |
CashedBonusPointsVATRate | float | VAT rate of the redeemed bonus points | |
CashedBonusPointsVATIndex | Integer | Value added tax index of the cashed bonus points | |
CustomerSubsidyVATRate | float | VAT rate of the customer subsidy | |
CustomerSubsidyVATIndex | Integer | Value added tax index of the customer subsidy | |
DeliveryVATIndex | Integer | VAT index of the delivery cost | |
DefaultVATIndex | Integer | Default VAT index | |
MainServiceVATIndex | Integer | VAT index of the main service | |
PaymentCostVATRate | float | Value added tax rate of payment type cost | |
PaymentCostVATIndex | Integer | Value added tax index of payment type costs | |
SurchargeVATRate | float | Value added tax rate of the shortage surcharge | |
SurchargeVATIndex | Integer | Value added tax index of the reduced quantity surcharge | |
GiftPackageVATRate | float | VAT rate of the gift package | |
GiftPackageVATIndex | Integer | Value added tax index of the gift package | |
ClimateNeutralVATRate | float | Value added tax rate of climate neutral production | |
ClimateNeutralVATIndex | Integer | Value added tax index of the climate neutral production | |
BuyXPayYDiscount | float | Value of discount for promotions BuyXPayY | |
GlobalDiscount | float | Summarized global discount | |
TotalDiscount | X | float | Value of all accumulated discounts |
OrderBonusPoints | Integer | Number of credited bonus points | |
CashedBonusPoints | Integer | Number of cashed bonus points | |
CashedBonusPointsAmount | float | Amount of cashed bonus points | |
BonusProductPoints | Integer | Number of bonus points used for reward products | |
DeliveryCost | X | float | Delivery cost |
DeliveryCost [MerchantID] | float | Merchant specific delivery cost. The MerchantID can be configured at the product | |
DeliveryCostReduction | float | Discount on payment method costs | |
DeliveryVATRate | X | float | VAT rate of delivery cost |
TotalMultiDeliveryAddressUsageCost | float | Total cost of MultiDelivery | |
TotalMultiDeliveryAddressUsageCostVATRate | float | VAT rate for MultiDelivery | |
TotalMultiDeliveryAddressUsageCostVATIndex | integer | VAT index for MultiDelivery | |
TotalSampleCopyCost | float | Total cost for voucher copies | |
TotalSampleCopyVATRate | float | VAT rate for voucher copies | |
TotalSampleCopyVATIndex | integer | VAT index for voucher copies | |
BasketProductOptionCost | float | Additional costs for free fields at split-order basket position level (BasketProductOptions BPO) | |
BasketProductOptionVATRate | float | VAT rate for BPO | |
BasketProductOptionVATIndex | integer | VAT index for BPO | |
DefaultVATRate | X | float | Default VAT rate |
CustomerSubsidy | float | Granted customer subsidy | |
CustomerSubsidyRemainder | float | Remaining customer subsidy for next order | |
PaymentCost | float | Payment cost | |
Surcharge | float | Low quantity surcharge | |
ResellerSurcharge | float | Reseller surcharge | |
ClimateNeutral | float | Cost of climate neutral production | |
W2PCost | float | Total costs of Web2Print design | |
W2PVAT | float | VAT Web2Print cost | |
GiftPackage | float | Total cost of all gift packages | |
GiftPackageVATRate | float | VAT rate of the gift package | |
PaymentInputSuffixX | Input additional information about the selected payment method | ||
SubTotal | X | float | Value of goods |
VAT | float | Total amount of VAT (included) | |
VATDiscount | float | Total amount of VAT (deducted) | |
Total | X | float | Total amount, including all discounts, vouchers, surcharges, deductions and including VAT. |
AltCurrencyISO | 3 | Alternative currency code (ISO) | |
AltCurrencyExchangeRate | float | Exchange rate for alternative currency | |
PartialDelivery | partial | Issued only if order is partial deliverable AND buyer has made a selection | |
VoucherNumber, | When using single vouchers. The explanation of the parameters can be found in a separate section see (Multi-)Vouchers | ||
eMailSharingWithShippingProviderAllowed | yes/no | Permission to forward the e-mail to the deliverer. yes: if the checkbox has been ticked | |
eMailSharingWithShippingProviderData | entered e-mail or the e-mail of the billing address, if permission to forward the e-mail to the deliverer = yes |
Section: OrderList/Item (product data)
...