Release notes - Customers API
This page will show the changes made in the customers API version 2023v2.
New changes are added at the top of the page and include a summary of the modified models. A summary of all model changes can be found here.
New incoterms
The incoterms have been updated to include new values. These new values have not yet been implemented in Floriday. The incoterms will be enabled as soon as they can be financially processed.
Affected models:
SalesOrders - Cancellation if order delivery is below minimum deliveryquantity
In Q4 2023 Floriday will add support for a new trade setting. This trade setting allows suppliers to choose if SalesOrders below the minimum delivery quantity will be kept on status ACCEPTED, until the minimum delivery quantity from the delivery condition in the specific delivery group has been met. The property automaticallyCancelledOn
has been added as an indication; the SalesOrder will be automatically marked as CANCELLED after automaticallyCancelledOn
has passed.
We have added new endpoints: SetSalesOrderCancelled and SetSalesOrderCommitted. Suppliers will have the ability to cancel or commit the SalesOrder before automaticallyCancelledOn
has passed, as long as the SalesOrder still has the status ACCEPTED.
Affected models:
PurchaseOrderRequest - Removed characteristics as vbn criteria
Removed the option to add characteristics
while searching a TradeItem based on the VbnCriteria when adding a PurchaseOrder.
Affected models:
OrderRequest - Deviating characteristics
Added the option to set deviating characteristics while sending an order request. This option is still in development and the functionality will be further implemented in Q2/Q3 in combination with "temporary trade items".
Affected models:
TradeItem - Hidden in catalog
The property isHiddenInCatalog
will now be set by default if the TradeItem is created as a variant by the supplier.
CustomerSticker - Validate size
The property size
will be used while validating the found AdditionalService. The AdditionalService must contain the size or else it will throw an error message. size
is still optional and can be left undefined or null in order to skip the validation.
Affected routes:
CustomerSticker - MultiType
When you want to upload a PDF with multiple sticker types, you must now use the new endpoint AddSalesOrderAdditionalStickerServiceMultiType. The endpoint expects the sticker information for 1 PDF in combination with a list of compositions to indicate the type and number of units per type. The match functionality is still available to use for every single composition. You get an error message if even one of the compositions does not match.
Affected models:
Affected routes:
CustomerSticker - Compositions
Added an overview of the sticker compositions to CustomerSticker. With the new additional sticker service cost calculation the CustomerSticker has been expanded with compositions to give an understanding of the calculated costs per type with the property numberOfUnits
.
- The default CustomerStickers with a single type, such as PRODUCT, SLEEVE, PACKAGE, etc.. will always contain 1 composition of the same type.
- CustomerStickers of type MULTI_TYPE will always contain more than 1 composition.
Affected models:
- AddAdditionalStickerServiceComposition
- AddSalesOrderAdditionalStickerService
- CustomerSticker
- CustomerStickerComposition
Additional sticker service cost calculation
The additional service costs of type LABEL, used by the customer while adding a CustomerSticker to a SalesOrder, will be calculated based on the numberOfUnits
submitted by the customer. In this case unit
will be represented with the value LABEL.
Additional services placed by the customer with the 2023v2 endpoint AddSalesOrderAdditionalStickerService will contain a numberOfUnits
. The costs given in the AdditionalService will be multiplied by the numberOfUnits
instead of the number of pieces, packages, etc.. on the SalesOrder. The same flow will be implemented within the Floriday portal, over the course of Q4 2023 and Q1 2024. Additional services placed with older API versions will not contain the numberOfUnits
, in this case the costs are calculated as they were before based of the unit
in the AdditionalService.
Affected models:
SelectedTradeItem - TradeItem, PackingConfiguration and Photo status
Added new properties to indicate if the TradeItem has been deleted, if the Photo is unavailable or if the packing configuration is unavailable in the suppliers catalog.
Affected models:
TradeItemGoupSelection - Supply selections
Trade item group selections are now available within the Customers API. In the Floriday portal this is called Supply selections and is used to create different groups of TradeItems. A group contains a name
, description
and imageUrl
together with a list of tradeItemIds
. A customer can manage the group within the Floriday portal and with the API. Changes can be retrieved through the sync endpoints.
Affected models:
- AddTradeItemGroupSelection
- EditTradeItemGroupSelection
- TradeItemGroupSelection
- TradeItemGroupSelectionTradeItem
Affected routes:
SalesOrder - GroupId
Added property salesOrderGroupId
to indicate that sales orders were created within the same flow based on bundled offers.
Affected models:
Organization - E-mail and phone
Removed the properties email
and phone
from Organization
Affected models:
SupplyRequest - GroupId
Added the property supplyRequestGroupId
to group multiple supply requests with the same header information like period and title for different suppliers. The supply requests will be shown as one in the Floriday portal and can be used internally to group the requests.
Affected models:
BunchesPerPackage
Removed obsolete property bunchesPerPackage
Affected models:
Updated 7 months ago