from
The new SOAP API version 114 was released along with plentymarkets 6.13. As usual, the new version not only includes many new developments, but also several interesting and helpful calls.
We recommend that you always use the latest SOAP API version. For the time being, all of the other available SOAP versions can still be used. However, older SOAP versions up to and including version 110 will be deleted in mid-June. Therefore, it is best to start using the new SOAP API 114 and all of its new additions right away.
Among other things, the new version includes calls that make it possible to create a return without a main order or that create lists with different information about newsletters or coupons. Refer to the following list for further information.
All new calls in the SOAP version 114
- SetAutonomousReturn: Creates a return without a main order. The call is intended for point of sale systems.
- SetContentPages: This call makes it possible to edit several category pages at the same time. The page will only be edited in the language and client that were specified.
Newsletter calls
- GetEmailFolderList: Displays a list of all the system's e-mail directories, i.e. NewsletterFolder.
- GetFolderEmails: Displays information about all e-mails, newsletters of a certain directory, i.e. NewsletterFolder.
Coupon calls
- ValidateCoupons: Checks whether or not a coupon code has already been redeemed. Displays all information that relates to the coupon with the entered code.
- GetCouponListOfCampaign: Displays a list of all coupons with a specific "CampaignID" (required request parameter: CampaignID).
- GetCampaignList: Displays a list of all "Campaigns" from the system.
Many calls were improved and enhanced
- The Boolean parameter "IsGuest" was added to the following calls:
- GetCustomers
- SetCustomers
- The parameter "ReferrerID" was changed from the declaration INT to FLOAT for the following calls:
- GetDeliveryCharges
- GetItemsDefaultShippingCost
- GetItemsStockSearch
- GetLinkPriceColumnToReferrer
- GetReturns
- GetSalesOrderReferrer
- SearchOrders
- SetAutonomousReturns
- SetOrdersHead
- AddOrders
- GetDeliveryOrders
- SetOrderItems
- GetItemsBase
- The parameter "MarketReferrer" was also changed from INT to FLOAT for all relevant calls.
- Items can be made available for the market Zentralverkauf with the following calls:
- SetItemsBase
- SetItemsAvailability
- The parameters "CostDomesticShipping", "CostForeignShipping" and "CostValueInPercentage" were removed from the call GetMethodOfPayments.
- The new parameter LogisticType was added to the call SetWarehouse for the future structure of the warehousing system in plentymarkets. The parameter WarehouseType was extended to include new values.
- The new parameter "StateISOCode" was added to the following calls:
- GetCustomers
- SetCustomers
- SetCustomerDeliveryAddresses
- GetCustomerDeliveryAdresses (was also given the new parameter "State" for the region's name)
- The call GetListing received the new parameter "ItemId". It displays the ID of the item that the listing was created for.
- The call GetReorder received the new parameter "ReorderItemId". It displays the stock unit's ID from the reorder.
- The call SetReorders received the new parameter "DeliveredQuantity". It displays the quantity of a reorder.
- The call GetOrderDocument makes it possible to not only search for a certain document but also to search for orders for which documents have already been created. It is possible to search for the date when the document was created, the DocumentID and the DocumentNumber.
The call GetItemsBase is used to retrieve the availability.
Removed calls
- The call SetContentPage was replaced by SetContentPages.
News from the SOAP API documentation
In order to structure the documentation of the SOAP calls more clearly, we saved the request and response objects as SVG files. These are "uml class diagrams". There are two versions of each graphic: one without a comment and one with a comment (Documented). The files can be accessed with the following 4 new buttons within the documentation.
- Request SVG
- Documented Request SVG
- Respond SVG
- Documented Respond SVG
You can download the complete documentation for the SOAP API version 114 from our manual.