Home
GuidesChangelog
HomeLog In
Guides
These docs are for v2023.2. Click to read the latest docs for v2024.2.

Release notes - Suppliers API

This page will show the changes made in the suppliers API version 2023v2.

Suggest Edits

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 delivery quantity

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:

New routes:


WeeklyBaseSupply - Price group prices and rate/burst limit

WeeklyBaseSupply now contains the price group prices from both the calculated and manual prices of the week per trade item. A rate limit of 1 per second and a burst limit of 20 have also been added to endpoint GetWeeklyBaseSupplies.

Affected models:

Affected routes:


CustomerSticker - AdditionalServiceId

The property additionalServiceId has been removed from the CustomerSticker. The introduced property did not always reflect the correct additionalServiceId when the customer used the flow to match on type. The OrderedAdditionalService still contains a stickerId as a reference to the CustomerSticker.

Affected models:


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:


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:

  • OrderedAdditionalService
    • numberOfUnits has been added as a new property to calculate the cost of an additional sticker service.
  • AdditionalServiceUnit
    • LABEL has been added as a new value, only useable in combination with the numberOfUnits.

Set base supply for multiple trade items and manual price groups

Base supply can now be set for multiple TradeItems in the specifiedweek and year with a maximum of 50 items per call. Optionally you can now set the manual price for a specific PriceGroup. If a manual PriceGroup is not provided, it will be left unchanged. You can remove the manual price by setting the manualPricePerPiece with a null value.

New models:

New routes:


PriceGroups

Added new models and endpoints to fetch the PriceGroup by id or sync the PriceGroup from your organization.

New models:

New routes:


FulfillmentOrderCorrection - Model changes

Fulfillment order correction models has seen a few changes. Previously, the POST endpoints contained some unused properties that were only used in the GET endpoints. The POST endpoints for Fulfillment order corrections now use new models without these unused properties. Changes made in FulfillmentOrder have been carried over to the correction models.

The property logisticLabelCode has been renamed to documentReference. Previously, logisticLabelCode gave the impression it was possible to use one of the multiple logistic label codes available for the load carrier. The documentReference is now used to indicate each seperate load carrier instead. The item now has a specific indication for the proper "logisticLabelCode" called deliveryNoteCode.

LoadCarrierItemCorrection now contains a deliveryNoteCode. The property sequenceCharacter has been renamed to deliveryNoteLetter. The combination of deliveryNoteCode and deliveryNoteLetter should be used to indicate the appropriate load carrier item for the correction.

Affected models:

  • Added AddFulfillmentOrderCorrection as a copy of FulfillmentOrderCorrection without the unused properties.
  • Added AddLoadCarrierCorrection as a copy of LoadCarrierCorrection with changed properties.
    • The documentReference from the LoadCarrierConfiguration must now be used as identification.
  • Added AddLoadCarrierItemCorrection as a copy of LoadCarrierCorrection with changed properties.
    • sequenceCharacter has been renamed to deliveryNoteLetter
    • deliveryNoteCode has been added to indicate the item you want to correct and is needed in case the load carrier contains multiple delivery note letters with duplicate delivery note letters.
  • FulfillmentOrderCorrection
  • LoadCarrierCorrection
    • logisticLabelCode has been renamed to documentReference to indicate the main logistic label code used to reference the load carrier.
  • LoadCarrierItemCorrection
    • deliveryNoteCode has been added as an extra indication in case the load carrier contains multiple delivery note letters with duplicate delivery note letters.

FulfillmentOrder - Model changes

FulfillmentOrder models have seen a few changes. The property sequenceNumber that has been used to indicate the position of the model has been placed with the integer sortIndex to avoid confusion with the property sequenceNumber used for syncing data.

LoadCarrierConfiguration now contains a documentReferenceas the main deliveryNoteCode and can be used to indicate the load carrier while creating a correction.

logisticLabelCode has been renamed to deliveryNoteCode to be more in line with the other models.

  • AddLoadCarrierConfiguration
  • AddLoadCarrierItem
    • Renamed deliveryRemark into deliveryRemarks and changed the property to an optional nullable string with a minimum length of 1 when used. The value cannot be set with an empty string.
    • Removed unused properties.
  • FulfillmentOrderCreate
  • FulfillmentOrder
    • Renamed submissionErrors into submissionError and changed the type from FulfillmentOrderSubmissionErrors to a simplified string. The error message always contained one string as a global error without any errors per batch.
  • FulfillmentOrderInbound
  • FulfillmentOrderStatus
    • Renamed submissionErrors into submissionError and changed the type from FulfillmentOrderSubmissionErrors to a simplified string. The error message always contained one string as a global error without any errors per batch.
  • LoadCarrierConfiguration
  • LoadCarrierConfigurationInbound
  • LoadCarrierItem
    • Split the property itemPosition into two new properties;
      • deliveryNoteLetter to indicate the specific letter on the delivery note
      • sortIndex to indicate the index for the item.
    • The deliveryNoteLetter could occur multiple times with the same letter for a different deliveryNoteCode, the sort index is a unique index.
  • LoadCarrierItemInbound
    • Split the property itemPosition into two new properties;
      • deliveryNoteLetter to indicate the specific letter on the delivery note
      • sortIndex to indicate the index for the item.
    • The deliveryNoteLetter could occur multiple times with the same letter for a different deliveryNoteCode, the sort index is a unique index.
  • FulfillmentType

LogisticLabelCode - Renamed into DeliveryNoteCode

Renamed the property logisticLabelCode into deliveryNoteCode to be more concise. In some cases the logisticLabelCode has been renamed to documentReference. See FulfillmentOrder - Model changes for more information.


FulfillmentRequest - Clock minimum price

Added new property clockMiminumPrice derived from the property in AddDeliveryOrderAuction set while creating a delivery order for a specific auction.

Affected models:


Organization - E-mail and phone

Removed the properties email and phone from Organization

Affected models:


SalesOrderExternalIntegration - Included services

Added new property includedServices as a List in SalesOrderExternalIntegrationRequest. This property can be used to determine if the price includes the sticker cost. The flow does not support type DELIVERY.

Affected models:


Validate default UUID values

Throw a status 400 validation error when the UUID's are filled with the default empty guid value 00000000-0000-0000-0000-000000000000


BunchesPerPackage

Removed obsolete property bunchesPerPackage

Affected models:


Delivery remarks as plural

Renamed the properties deliveryRemark into deliveryRemarks

Affected models:


SalesOrder - Required payment provider

Changed the optional property paymentProvider into a required property.

Affected models:

Updated 9 months ago