Version History

Versie

Datum

Auteur

Reden van wijziging

1.0

28-01-2015

Original version

2.0

29-11-2016

Roland Vonk

Updating of all interfaces

2.1

2-12-2016

Peter Leermakers

Extension of the Customer Information Interface with VAT number and GLN. Casing of element names corrected in interface description. FirstName, MiddleName and LastName fields added to description. Casing of elements corrected in description Gross price information interface.

2.1.1

5-12-2016

Eddie Reinhoudt

Expansion of the gross price list with tiers

2.2

7-12-2016

Peter Leermakers

Batch interface extension1 with Customer XML 2.0 definition

2.3

14-12-2016

Weiwen Lau

Update realtime interface: StemService globally replaced by ShoxlService; complex types placed with methods for clarity

2.4

16-1-2017

Peter Leermakers

Identification element removed as part of Customer ImportSettings. From now on, the way a customer is identified is regulated by a setting in Vendisto.

2.5

23-1-2017

Peter Leermakers

The vendisto setting 'Customer identifying property' determines whether the Debit number must be unique and is mandatory for customer import. Customer import extended with PartialUserImport setting.

2.6

24-2-2017

Weiwen Lau

Filter type possibilities of the method GetOrderHistory adjusted. "Jobnumber" and "order placed by name" removed.

2.7

18-05-2017

Roland Vonk

PlaceOrder Web service type Order extended with Orderstate (open/closed). type Orderline extended with status 0 (open) and status names changed (1 = backordered, 2 = shipped instead of shipped/delivered, 3 = cancelled instead of cancelled/credited). Added field QuantityNotShipped to Orderline. Address type Invoicing changed to Invoice. Added new webservice GetInvoice, which returns an invoice in PDF format. Added component GrossPriceExclVAT to OrderLine

2.8

07-06-2017

Roland Vonk

Added AccountNumber as a mandatory field when querying both OrderHistoryDetail and InvoiceHistoryItem, so that this function can also be used outside the context of OrderHistory and InvoiceHistory for searching Orders/Invoices by customers.

2.9

27-6-2017

Peter Leermakers

In sample XML from CustomerImport, UserName node has been changed to Username.

2.10

11-7-2017

Peter Leermakers

Import of discount prices added at gross price interface.

2.11

19-10-2017

Roland Vonk

AddressType Value Invoice changed to Invoicing

2.12

13-12-2017

Peter Leermakers

Description Authorization interface

Extension Customer interface with Authorization Element

2.13

15-3-2018

Peter Leermakers

Adjustment Explanation Authorisation interface

2.14

06-04-2018

Peter Leermakers

Superfluous space removed in XML declaration Legacy Customer interface

2.15

11-04-2018

Peter Leermakers

Expansion of Customer interface with Authorisation element at User level

2.16

25-4-2018

Peter Leermakers

Extension of the customer interface with e-mail address and BuyOnCredit at user level

2.17

23-08-2107

Roland Vonk

Formatted / removed formatting errors in section “Structuur Customer XML”

2.18

27-08-2018

Kristian Jacobs

Added PreferredBranche to Customer

2.19

27-09-2018

Peter Leermakers

Added description for pagenumber of GetOrderHistoryResult

Replaced tempuri.org namespace by shoxl.com for realtime interfaces

Type of InvoicePdf in GetInvoiceResult changed to base64Binary

Updated cardinality of ArrayOfOrderLineRequest

Updated namespaces in element names realtime interfaces

Added reference to WSDL document for realtime interfaces

2.20

01-10-2018

Kristian Jacobs

Added OrderNumber to the PlaceOrderResult object

2.21

30-11-2018

Peter Leermakers

Correction of FTP server specifications. The FTP server supports FTPS and not SFTP.

2.22

10-12-2018

Peter Leermakers

Zipped format is now also supported for Authorization import

2.23

05-03-2019

Roland Vonk

Added clarification of Authorization working principle.

2.24

11-03-2019

Peter Leermakers

StreetAddress1, PostalCode, City and Country are no longer optional under Loose ValidationType of Customer import

2.25

12-03-2019

Peter Leermakers

Added currency to batch price interface

2.26

20-06-2019

Peter Leermakers

Added currency attribute to DiscountPriceExclVat element in batch price interface

2.27

05-07-2019

Peter Leermakers

ERP Cache import formats

2.28

09-07-2019

Peter Leermakers

Description of Order XML Export Batch interface format

2.29

19-07-2019

Aleksandar Staykov, Peter Leermakers

Added description of Article XML import format

2.30

22-07-2019

Peter Leermakers

Added suggested retail price field to gross price batch import

2.31

26-08-2019

Peter Leermakers

Added ERP Cache import format for exchange rates. Fixed error in description of ERP Cache CustomerPrice interface.

2.32

06-09-2019

Peter Leermakers

Added description of settings on Article XML import

2.33

08-10-2019

Peter Leermakers

Added Coc Number to Order XML Export format

3.0

12-11-2019

Peter Leermakers

Definition of Customer XML version 2.1

3.1

9-1-2020

Peter Leermakers

Added ExternalId to CustomerAddress element in Customer XML import format

3.2

3-2-2020

Peter Leermakers

Updated Webservice wsdl to ShoxlWebService_v3.wsdl. Updated Shipping and Billing order address fields in webservice definition.

6-2-2020

Peter Leermakers

Fixed fault in description of CustomerAddress AddressType element in customer batch import. Changed 'Invoice' to 'Invoicing'.

11-2-2020

Peter Leermakers

Removed PartialUserImport node from customer batch import example

3.3

11-2-2020

Peter Leermakers

Added ERP Cache import format for delivery dates

3.4

12-3-2020

Peter Leermakers

Renamed ERP Cache DeliveryDate batch interface to ProductDeliveryScheme. Added MaximumOrderDate element.

3.5

26-3-2020

Roland Vonk

Changed description of Authorization Import to clarify that authorizations also apply to general content, not just product info

20-4-2020

Peter Leermakers

Added AuthorizationProfiles to Article XML import Batch interface

25-5-2020

Peter Leermakers

Added DeliveryDate to Order Export XML format

3.6

22-6-2020

Peter Leermakers

Added WarehouseId to ERP Cache Stock Batch data format

3.7

16-9-2020

Kristian Jacobs

Added UserRestrictedProducts and ProfileRestrictedProducts import description

19-11-2020

Peter Leermakers

Version 2.2 of Customer import batch interface

3.8

15-2-2021

Peter Leermakers

Quantity and RemainingQuantity elements in ERP Cache Order XML format were changed from Integer to Decimal. Quantity element in Order Export XML definition was also changed from Integer to Decimal.

17-2-2021

Peter Leermakers

Updated description of NettoPricePerItemExclVat fields in GetProductInformation Webservice call and in PriceList and CustomerPrice ERP Cache batch formats.

2021.1

17-2-2021

Peter Leermakers

Added DeliverySchemeCode to ERP Cache Customer and ERP Cache DeliverySchemes Batch import formats.

17-2-2021

Peter Leermakers

Added description of ERP Cache Cleanup import format

2021.3

24-3-2021

Peter Leermakers

Changed type of stock field from int to decimal in GetProductInformation webservice. Updated interface definition to ShoxlWebService_v4.wsdl.

Updated ErpCache_Stock XML from version 1.1 to 1.2. The stock import now supports decimal values for stock.

29-3-2021

Peter Leermakers

Added description of ERP Cache Invoice history import format.

2021.4

1-4-2021

Peter Leermakers

Added ERP Cache OrderDocument import format

22-4-2021

Peter Leermakers

Updated ErpCache_PriceLists XML from version 1.0 to 1.1. Updated ErpCache_CustomerPrices XML from version 1.0 to 1.1.

Added Currency attributes on both import formats in order to support prices in multiple currencies without the need to use Exchange rates in the ERP Cache.

2021.6

19-07-2021

Christian de Koning

Updated ERPCache_CustomerPrices XML from version 1.1 to 1.2

Added VatCode, BaseUnit and PriceUntit to the customer price import

2021.7

23-7-2021

Peter Leermakers

Definition of a REST API version of the realtime interface as an alternative for the SOAP API.

2021.9

2-8-2021

Peter Leermakers

Made some small adjustments to ShoxlRestApiSwagger_v1.json on order to let the REST interface comply more with the WSDL interface. The following fields are now nullable: stock and PriceUnit on GetProductInformationResult, orderDate and PaymentMethodCode on Order, FilterType on GetOrderHistoryRequest, TotalPriceExclVat and TotalPriceInclVat on OrderHistoryItem and TotalOutstanding and TotalPrice on InvoiceHistoryItem.

2021.9

3-8-2021

Peter Leermakers

Added paragraph on webservice security.

2021.9

27-9-2021

Roland Vonk

Added explanation to the article batch import, regarding the exact working of the partial import

2021.10

11-10-2021

Peter Leermakers

Added preferredDeliveryDate to REST API definition of PlaceOrder Webservice. Introduced ShoxlRestApiSwagger_v2.json

2021.12

8-12-2021

Peter Leermakers

Added orderState to result of GetOrderHistory webservice. Introduced ShoxlWebService_v5.wsdl and ShoxlRestApiSwagger_v3.json

2021.12

8-12-2021

Christian de Koning

Added RelatedProductNumber and Type to orderline to the result of CalculateOrder webservice

2021.12

9-12-2021

Peter Leermakers

Added comment on 1-based pagenumbering for GetOrderHistory and GetInvoiceHistory webservices.

2021.12

14-12-2021

Peter Leermakers

Added description of LineNumber element in ErpCache_Order import format.

2021.12

15-12-2021

Peter Leermakers

Added comment to default number of orders/invoices on GetOrderHistory/GetInvoiceHistory webservices.

2021.12

16-12-2021

Peter Leermakers

Added comment on format of Decimal field in batch interfaces.

2021.12

21-12-2021

Peter Leermakers

Added paragraph headings for the SOAP API descriptions in the webservices documentation.

2021.12

24-12-2021

Peter Leermakers

Added ArticleNumber, CostLineType and DiscountPercentage elements to CostLine of Order Export XML

2022.1

27-1-2022

Peter Leermakers

Changed PriceInclVat for Required to Optional in Gross Prices Import. Added General Patterns section in ERP Integration Guid with pages on Import file naming and zipped XML. Added Currency and Incoterm elements to description of Customer XML import format.

2022.1

3-2-2022

Peter Leermakers

Removed stockindication codes 1, 2 and 3 from description ErpCache Stock Importer

2022.1

4-2-2022

Peter Leermakers

BaseUnit and PriceUnit are now marked as Required in the Gross Prices import

2022.1

9-2-2022

Peter Leermakers

Added GIROPAY, UBERWEISUNG, APPLEPAY and BANCONTACT to definition of OrderXML Batch export

2022.1

11-2-2022

Peter Leermakers

Added CustomOrderFields field on OrderLine to REST API definition of PlaceOrder Webservice. Introduced ShoxlRestApiSwagger_v4.json

2022.3

8-3-2022

Peter Leermakers

Added description of Package Units Import batch interface. Added General Pattern page on Package Units import. Added optional AdditionQuantity field on Gross Prices Import. Added DeleteNotImportedProperties import option to Article XML Import. Incoterm field on customer is no longer restricted to 3 characters.

11-3-2022

Peter Leermakers

Added shippingCountry to REST API defintion of CalculateOrder Webservice.

Removed Required attribute from ExternalOrderNumber of request on CalculateOrder WebService

Introduced ShoxlRestApiSwagger_v5.json

14-3-2022

Peter Leermakers

Added DeliveryEmailAddress and DeliveryPhoneNumber to Order Export XML format. Updated to xsd version OrderXmlExport_v6.xsd.

17-3-2022

Peter Leermakers

Added description of MatchOwnArticleNumbers enpoint to REST API.

23-3-2022

Peter Leermakers

Added GetProductInformations REST API endpoint as a replacement of the GetProductInformation endpoint. Introduced ShoxlRestApiSwagger_v6.json. Added shippingCountry example to CalculateOrder REST API.

28-3-2022

Peter Leermakers

Added ArticleGroupDefaultTitle and EnableArticleGroupSplitting import settings of Article XML import.

4-4-2022

Peter Leermakers

Introduced type on OrderLine of REST API PlaceOrder webservice

2022.4

26-4-2022

Peter Leermakers

Introduced OrderLineType on ErpCache Order History

13-5-2022

Peter Leermakers

Added PartialImport import setting to ErpCache PriceLists XML format.

2022.5

28-6-2022

Peter Leermakers

Added extra description on discountAmountPerItemExclVat fields in API.

4-7-2022

Peter Leermakers

Correction of GetProductInformations request example

2022.7

6-7-2022

Peter Leermakers

Added GetReturnOrders and GetReturnOrderDetail REST endpoints to Webservice definition. Introduced ShoxlRestApiSwagger_v7.json.

2022.7

13-7-2022

Peter Leermakers

Updated ImportSettings Version number in example XML of ErpCache_CustomerPrices batch file.

2022.7

27-7-2022

Peter Leermakers

Added InvoiceTo field to Customer and ErpCache_Customer XML formats. Updated default name of Importer node of Articles XML import. Added PartialImport element to ERP Cache CustomerPrices import settings.

2022.7

29-7-2022

Peter Leermakers

Introduction of taxPercentage in REST API. The vatCode field is replaced by taxPercentage in CalculateOrder, PlaceOrder and GetOrderHistoryDetails. TaxPercentage is introduced as a new field in GetProductInformations next to vatCode, which is preserved for backwords compatiblity reasons but is also marked as deprecated.

2022.9

12-9-2022

Peter Leermakers

Added PreferredDeliveryDate on order level to Order XML export format.

10-10-2022

Peter Leermakers

Marked OrderDate as a required element in the ErpCache Order history import format.

2022.11

7-11-2022

Peter Leermakers

Added ErpCache Customer Products import format. With this import format it is possible to disclose customer specific productnumers in the shop.

8-11-2022

Peter Leermakers

Introduction of GetCustomerProducts and MatchCustomerProducts REST API endpoints. These endpoints replace the MatchOwnArticleNumbers endpoint.

23-12-2022

Peter Leermakers

PriceListNumber of Gross Prices Import is a legacy field and made optional.

2023.2

2023-02-06

Antoine Granpre Moliere

Price fields made nullable for results of Calculate Order and GetProductInformations

2023.3

3-3-2023

Peter Leermakers

Replaced VatCode element by VatPercentage in GrossPrices XML format as well as in ERP Cache PriceList, CustomerPrice and Order history formats.

2023.4

4-3-2023

Peter Leermakers

Added Quantity element to CostLine in Order XML export

2023.5

2-5-2023

Peter Leermakers

Updated Order Export XML format

2023.5

10-5-2023

Antoine Granpre Moliere

Added DiscountPercentage element to Customer in ERP Cache Batch Customers XML format

2023.6

25-5-2023

Peter Leermakers

Added some extra fields to REST API order format

2023.6

7-6-2023

Christian de Koning

Added baseUnit in the CalculateOrder request

2023.6

26-6-2023

Peter Leermakers

The MinimumOrderQuantity, AdditionQuantity and DiscountMinimumQuantity elements of the Gross Price Import XML format now support Decimal numbers. Changed FromQuantity and ToQuantity datatype to decimal in ErpCache PriceList and CustomerPrices XML import formats and in GetProductInformations REST API. Introduced ShoxlRestApiSwagger_v14.json.

2023.6

27-6-2023

Peter Leermakers

Added DeliveryDate to ErpCache Order history import format. Added deliveryDate to GetOrderHistory REST API. Introduced ShoxlRestApiSwagger_v15.json.

2023.6

5-7-2023

Peter Leermakers

Removed description of ERP Cache Delivery Scheme import. This import is moved to the Batch Interfaces section.

2023.7

28-7-2023

Antoine Granpre Moliere

Added DeliverySchedule to BatchCustomer xml to be imported to vendisto

2023.10

29-09-2023

Luka Spaninks

Added Description field to Order in "ERP Cache Batch" -> "Order history"