Introduction

This page contains the ERP API documentation of V0.2. With API endpoints, scenarios (flows) and guidance.

General starting conditions

The following general starting conditions are applicable:

1 The supplier application has an updated GLN company code codelist from Floricode
2 The supplier application has an updated VBN productcode codelist from Floricode.
3 The supplier application has an updated VBN product characteristics codelist from Floricode.
4 The supplier application has an updated VBN product regulatory characteristics codelist from Floricode.
5 The supplier application has an updated VBN packaging codelist from Floricode.
6 The supplier application has been given all neccessary permissions (by default all permissions will be given). For more information see Permissions v0.2
7 The supplier application has a valid ClientID and client secret ID(not applicable for PKCE flow) from the Floriday.
8 The supplier organization is registered as an organization on Floriday.
9 The (mandated) key user of the supplier organization with all permissions is registered as an user on Floriday. Further referred to as the user.
10 The user has a valid API-key from Floriday entered in the supplier application.
11 The user has agreed terms & conditions of Floriday.
12 The user has agreed terms & conditions of the customer’ channels (eg. FloraMondo, FloraXchange) in Floriday.
13 The user has entered his warehouse location(s) with its delivery conditions in Floriday.
14 The key user has set the Floriday application for managing his trade-items. For migration purposes the user can choose between managing trade-items in the FX application (temporarily) or Floriday application.Floriday can only guarantee proper supplier application integration if Floriday has reading and writing permissions on all Trade-items.

 

Please take the following in consideration before starting:

1 For this API document version the context is direct sales. In next versions other sales instruments and domains will be added e.g. clock sales, contract sales, fulfillment and payment.
2 For channel compliancy the ‘Linneaus blauwdruk’ implementation conventions & rules are applicable. https://www.floricode.com/nl-nl/
3 For channel compliancy the VBN regulatory characteristics are applicable.
4 For FloraMondo channel compliancy the following regulatory characteristics are applicable (mandatory): S98 Quality group.
5 For FloraXchange channel compliancy the following regulatory characteristics are applicable (mandatory): S15 Transportheight
6 For calculating packaging, Floriday requires the lineair dimensions of trade-items. Mandatory if VBN package code has no lineair dimensions.
7 The photo regulations: Minimusm resolution 640x640, Max. 5MB, JPG format.
9 The Floriday Entity Relationship Model and its definitions are applicable.
10 Users can use the supplier application and Floriday application simultaneous. For multiple reasons: 1) User preference. 2) Floriday application as a backup. 3) To enrich data in the application.

 

Scope v02

This version of the API is aimed at:

  • Direct sales to customer via channel FloraXchange ('weeklists') and FloraMondo ('daytrade') and placing 'manual sales orders' from other sources on supply lines.
  • Information exchange with the following Floriday modules and related functions:
    • Core module: get warehouses, get customer organizations, add and get photo's
    • Deliveryconditon module: get delivery conditionsets.
    • Catalogue module: Get, add and delete trade-items.
    • Stock module: get, create and update batches, toggle continuous stock.
    • Supply module: Get, create, update and delete base supply / supply lines based on continuous stock and batches.
    • Sales module: Get and create sales orders.

Permissions v02

The following permissions (scopes) are applicable for autorization with this version op the API:

Scopes Permissions for Related functions
catalog:read Read permissions for catalog module  Get trade-items
catalog:write Write permissions for catalog module Add trade-items, delete trade-items
supply:read Read permissions for stock and supply module Get batches, get supply-lines
supply:write Write permissions for stock and supply module Create batches and update batches, toggle continuous stock, create base supply, create and delete supply-lines.
sales-order:read Read permissions for order module Get sales orders.
sales-order:write Write permissions for order module Add sales orders.
organization:read Read permissions for core module: organizations Get organizations, get warehouses
delivery-conditions:read Read permissions for core module: delivery-conditions Get deliveryconditionsets
role:app Role application  

API endpoints v02

The API endpoints version 0.2 are documented by Swagger and can be reached with the following link:

https://api.staging.floriday.io/erp-api-specs/swagger/index.html?urls.primaryName=ERP%20API%20-%20v0.2%20(in%20development)

Notice: To enable developers to start pre-development and review of the next API version, we will do a pre-publication. Such a version is refered to with 'in development', where endpoints are under construction and refered to with 'NOT IMPLEMENTED' or in QC and are not all stable. If all endpoints are stable the complete version is changed from 'in development' to 'stable'. On a stable version our Beta version policy is applicable. 

Tip: With editor.swagger.io the following URL that refers to the API specification, can be easily imported and translated to different clients.

https://api.staging.floriday.io/apps/v0.2/api-spec

Notice: We are in the process of creating and publishing a mockup testclient containing example API calls and responses, which can enable a quick start for developers. Our aim is to publish the testclient in the near future.

Scenario overview v02

The following scenario's are decribed in the context of user working in the supplier application.

Core scenarios:

  • All scenario's related to supporting Trade-items, Stock, Direct sales Supply and Sales Order scenario's.

Trade-item scenarios:

  • All scenario's related to Trade-items.

Stock scenarios:

  • All scenario's related to Contiuous Stock and Batches based on trade-items.

Direct sales Supply scenarios:

  • All scenario's related to Direct sales Base Supply and Supply Lines based on Continuous stock and Batches.

Direct sales Order scenarios:

  • All scenario's relatied to Direct sales Sales orders based on Supply Lines.

Core scenarios

  1. Get Organizations
  2. Get Warehouses
  3. Get Delivery conditions
  4. Add Media (photo)
  5. Get Media (photo)

Get Organizations

Purpose: Get Floriday organizations. The information of the organizations that are registered in Floriday can be retrieved.

The following needs to be taken in consideration:

  • By default the Floriday organization id is used, for purposes of Floricode compatibility a GLN company ID can also be used.
Nr Process steps API call / [scenario]
1A Get organization details with Floriday organization id GET / organizations/{organizationId}
1B Get organization details with GLN id GET / organizations
2 The retrieved organization details: will be added or updated in the supplier application.  

 

Get Warehouses

Purpose: Get warehouses. The supplier' stock is registered on a specific warehouse location, this can be a 'nursery' or an external warehouse location ('instore', 'DC') . Warehouses can have different type of services (e.g. labeling). An external warehouse can be stocked by a shipment. A nursery can be stocked by creating batches or continuous stock.

Before starting the following needs to be in place:

  • The user has inserted one or more warehouse(s) in the Floriday application.

The following needs to be taken in consideration:

  • All supplier warehouses can be retreived.
  • At this moment only one default supplier warehouse is applicable with continuous stock. For this reason a default warehouse is internally choosen by Floriday for the supplier organization and for continuous stock warehouses are not used at this moment. In the forseeable future one or more warehouses can be applicable.
  • A batch is located on one of the supplier warehouses.
Nr Process steps API call / [scenario]
1 Get delivery condition sets with delivery conditions for warehouses locations. GET / warehouses
2 The retrieved warehouses will be added or updated in the supplier application.  

Get Delivery Conditions

Purpose: Get supplier' delivery conditions for customers in the channels. The delivery conditions give information on orderwindows for delivery with delivery charges and charges for services.

Before starting the following needs to be in place:

  • The user had inserted delivery condition sets applicable for its warehouse(s) in the Floriday application with or without customers organizations for direct sales.
  • The user supplier can have delivery condition sets in the supplier application.

Before starting the following needs to be taken in consideration:

  • At this moment the delivery conditions can only be managed by the user in the Floriday application.
Nr Process steps API call / [scenario]
1 Get delivery condition sets with delivery conditions for warehouses locations. GET / delivery-condition-sets
2 Get customer organizations for customer specific delivery condition sets [Get organizations]
3 The retrieved delivery condition sets will be added or updated in the supplier application.  

Add Media

Purpose: Add an image. Add an image of the supplier' trade-item to the Floriday image repository.

The following needs to be taken in consideration:

  • 2/8/2019: This method is mandatory for adding photos. The method of adding a non-Floriday image URL to a trade-item or batch has become absolete.
  • The photo regulations: Minimum resolution 640x640, Max. 5MB, JPG format.
Nr Process steps API call / [scenario]
1 Post an image to Floriday and get a mediaId from Floriday. POST / media

2
Supplier application combines mediaId with Floriday URL:
Staging: https://api.staging.floriday.io/images/{mediaId}.jpg
Live: https://api.floriday.io/images/{mediaId}jpg
 
3 Process the media in the supplier application  

Get Media

Purpose: Get an image of the supplier' trade-item from the Floriday image repository.

Nr Process steps API call / [scenario]
1 Get an image from Floriday with a Floriday mediaId. Get / media{mediaId}.jpg
2 Process the image in supplier application  

Trade item scenarios

  1. Get Trade-items. Synchronize trade-items from Floriday with supplier application.
  2. Add trade-items. Creating new trade-items in the supplier application.
  3. Delete trade-items. Deleting trade-items in the supplier application.
  4. Change trade-items. Changing a trade-item in the supplier application.

Get Trade items

Purpose: Get Trade-items. Synchronize trade-items from Floriday with supplier application.

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without one or more specific customer organizations.

Before starting the following needs to be taken in consideration:

  • At this moment there is no trade-item update API call (PUT / trade-item). This will be provided in the foreseeable future. See scenario [change trade-items]
  • For an easy starting implementation, the users can be asked to not alter or manage trade-items in the Floriday application.
  • If the user can alter the trade-items in the Floriday application it is advised to get trade-items from Floriday and process the latest changes before adding new trade items. 
  • All non customer specific trade-items are currently exposed to the supplier catalogue on the channel FloraXchange. At this moment specific trade-items cannot be excluded by a trigger.
Nr Process steps API call / [scenario]
1 Get trade items with all product specifications and one or more packing options, which are not deleted in the past. GET / trade-items
2 Get customer organizations for customer specific trade items [Get Organizations]
3 Process the retrieved trade-items with the trade-items in the supplier application with their unique trade-item ID. The trade-items will be added or deleted from the supplier application.  

4
If trade-items no longer exist in Floriday (soft deleted), and the supplier application expected them, it is possible to check if the trade-items are deleted by checking them individually. The Trade-item should contain: "isDeleted": true.
GET / trade-items /{tradeItemId}

Add Trade items

Purpose: Create trade-items. Creating new trade-items in the supplier application.

Before starting the following needs to be in place:

  • The user had inserted trade-item data in the supplier application with or without customer organizations.

Before starting the following needs to be taken in consideration:

  • At this moment there is no trade-item update API call (PUT / trade-item). This will be provided in the foreseeable future. See scenario [change trade-items]
  • For an easy starting implementation, the users can be asked to not alter or manage trade-items in the Floriday application.
  • If the user can alter the trade-items in the Floriday application it is advised to get trade-items from Floriday and process the latest changes before adding new trade items. 
  • All non customer specific trade-items are currently exposed to the public customer catalog on the channel FloraXchange. At this moment specific trade-items cannot be excluded by a trigger.
  • 2/8/2019: The method for adding photos with a Floriday URL is mandatory. The method of adding a non-Floriday image URL to a trade-item or batch has become absolete.
Nr Process steps API call / [scenario]
1 Add one or more photo's and get mediaId + Floriday URL [Add Media]
     
2A Create a new trade item with one or more photos (URL), with all product specifications and one or more packing options without customer organizations POST / trade-items
2B Create a new trade item with one or more photos (URL), with all product specifications and one or more packing options with customer organizations POST / trade-items
[Get Organizations]
3 The new trade-item is validated by Floriday.  
4 The new trade-item will be added to the supplier organization's catalog in Floriday.  
5 The new trade-item will be added to the supplier organization's catalog in the customer’ channel  

 

Trade-item implemenation guidance in addition to Swagger doc (non exhaustive):

Field Short description Guidance
TradeItemID Trade item UUID Generate unique UUID
SupplierArticleCode Supplier article code Suppliers use this code for referential purposes. At this moment it is common practice that this code is also used by customers.
articleGtin GS1 GTIN  
vbnProductCode VBN productcode A valid Floricode VBN productcode
tradeItemName Trade item name At least a dutch trade-item name. In addition an english name can be added. an..35
vbnCode VBN characteristic code The Floricode regulated VBN product characteristic code related to the VBN productcode with optional additional codes.
vbnValueCode VBN characteristic value code The Floricode VBN product characteristic value code related to the VBN productcode with optional additional codes.
customerOrganizationIds Customer organization ID Used with customer specific trade-items. One or more Customer Organization ID's can be used.
seasonalPeriodsstartweek - endweek Seasonal periods Seasonal periods communicated in the catalog to customers to indicate the availibility of the product in weeks.

Photos:

Photo

One or more photo's

-primary

Primary photo indic.

True = default/main photo, false = secundary photo

-URL

Photo URL

Floriday Photo URL

-seasonalPeriod
Seasonal period Seasonal period of the product where the photo is applicable.
-type Photo type Additional classification of the photo. See enumerations. If not known, use Unknown.
packingConfigurations:   One or morge packing configurations
-packingConfigurationId Packing configuration ID Generate unique UUID
-primary Primary packing config. indic. True = default packing configuration, false = secundary packing configuration. 
-piecesPerPackage Pieces per package  
-bunchesPerPackage Bunches per package  
-packagesPerLayer Packages per layer  
-layersPerLoadCarrier Layers per loadcarrier  
-transportheightInCM Transport height in cm  
-loadCarrier Loadcarrier type Enumeration
-additionalPricePerPiece:   Additional price per piece for the packing configuration.
-currency Currency, default EUR  
-value Additional price per piece  
Package   Package information
-vbnPackageCode VBN package code VBN package code
-heightInMM Package height in MM  
-lenghtInMM Package lenght in MM Mandatory if VBN package code has no lineair dimensions, used for calculating packaging
-widthInMM Package width in MM Mandatory if VBN package code has no lineair dimensions, used for calculating packaging

Delete Trade items

Purpose: Delete trade-items. Deleting trade-items in the supplier application.

Before starting the following needs to be in place:

  • The user had inserted trade-items in the supplier application.
  • The user is deleting a trade-item in the supplier application.

Before starting the following needs to be taken in consideration:

  • At this moment there is no trade-item update API call (PUT / trade-item). This will be provided in the foreseeable future. See scenario [change trade-items]
  • For an easy starting implementation, the users can be asked to not alter or manage trade-items in the Floriday application.
  • If the user can alter the trade-items in the Floriday application it is advised to get trade-items from Floriday and process the latest changes before adding new trade items. 
  • All non customer specific trade-items are currently exposed to the customer catalog on the channel FloraXchange. At this moment specific trade-items cannot be excluded by a trigger.
  • By deleting the trade-item, the trade-item is ‘soft deleted’ and will no longer be exposed in the customer catalog. Aloocated supply to channels based on (soft) deleted trade-item, will remain allocated for the given conditions and period. 
Nr Process steps API call / [scenario]
1 Delete an existing trade item with an unique tradeItemId DELETE / /trade-items / {tradeItemId}
2 The trade-item will be deleted from the supplier organization's catalog in Floriday.  
3 The trade-item will be deleted from the supplier organization's catalog in the customer’ channel.  

Change Trade items

Purpose: Change trade-items. Changing a trade-item in the supplier application. 

Before starting the following needs to be in place:

  • The user had inserted trade-item data in the supplier application with or without customer organizations.

Before starting the following needs to be taken in consideration:

  • A trade-item is changed by deleting and adding a new trade-item. At this moment there is no trade-item update API call (PUT / trade-item). This will be provided in the foreseeable future. See scenario [change trade-items]
  • For an easy starting implementation, the users can be asked to not alter nor manage trade-items in the Floriday application.
  • If the user can alter the trade-items in the Floriday application it is advised to get trade-items from Floriday and process the latest changes before adding new trade items. 
  • All non customer specific trade-items are currently exposed to the customer catalog on the channel FloraXchange. At this moment specific trade-items cannot be excluded by a trigger.
Nr Process steps API call / [scenario]
1 Delete a trade-item. [Delete Trade-items
2 Add trade-item. [Add Trade-items]

Stock scenarios

  1. Toggle Continuous Stock: Set Continuous-stock of a trade-item on available or non-available.
  2. Get Batches: Get Batches with an available quantity.
  3. Add Batches: Add a Batch with an available quantity.
  4. Update Batch: Update a Batch with an available quantity.

Toggle Continuous Stock

Purpose: Toggle Continuous Stock: Set Continuous-stock of a trade-item on currently available or unavailable.

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted or changed its current availability for trade-items for direct sales in Floriday.

Before starting the following needs to be taken in consideration:

  • It is advised to get delivery conditions from Floriday and process the latest changes.
  • Trade-items with customer organizations cannot be allocated as a supplyline to other customer organizations.
  • Currently supply-lines based on this scenario can only be allocated to FloraXchange. FMO channel requires batch availability.
  • Currently one default supplier warehouse applicable.
Nr Process steps API call / [scenario]
1 Toggle availability (true or false) of an existing trade item with an unique tradeItemId PUT / trade-items / {tradeItemId} / continuous-stock
2 The continuous stock of the trade-item is set to available(true) or not available(false) in Floriday.  

Get Batches

Purpose: Get Batches with available quantities.

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted or changed its current batch available quantity for a period for trade-items on a warehouse location in the supplier application.
  • The supplier application has the latest update of warehouses see [Get Warehouses]

Before starting the following needs to be taken in consideration:

  • A batch is located on one warehouse location.
  • A batch has one packingconfiguration. In the foreseeable future multiple packingconfigurations can be added.
Nr Process steps API call / [scenario]
1 Get batches based on trade-items with an available quantity, a packingconfiguration on a warehouse location. GET / batches
2 The retrieved batches are processed in the supplier application.  

Add Batches

Purpose: Add a Batch with an available quantity.

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted or changed its current batch available quantity for a period for trade-items on a warehouse location in the supplier application.
  • The supplier application has the latest update of warehouses see [Get Warehouses]

Before starting the following needs to be taken in consideration:

  • A batch is located on one warehouse location.
  • A batch has one packingconfiguration. In the foreseeable future multiple packingconfigurations can be added.
Nr Process steps API call / [scenario]
1 Create a batch of a trade-item with available quantity, a packingconfiguration on a warehouse location. POST / batches
2 The batch is created in Floriday.  

 

Batche implemenation guidance in addition to Swagger doc (non exhaustive):

Field Short description Guidance
batchId Batch ID Generate unique UUID
batchDate Batch creation date and time Creation date and time of the batch
tradeItemId Trade-item ID  
numerOfPieces Number of pieces Total batch quantity in pieces
selectedPackingConfiguration Packing configuration ID Selected packing configuration Id from a trade-item
piecesPerPackage Pieces per package  
bunchesPerPackage Bunches per package  
Package   Package information
-vbnPackageCode VBN package code  
-heightInMM Package height in MM  
-lenghtInMM Package lenght in MM Mandatory if VBN package code has no lineair dimensions, used for calculating packaging
-widthInMM Package width in MM Mandatory if VBN package code has no lineair dimensions, used for calculating packaging
-loadCarrier Loadcarrier type Enumeration
warehouseId Warehouse ID  

Update Batches

Purpose: Update a Batch with an available quantity.

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted and changed its current batch available quantity for trade-items on a warehouse location in the supplier application.
  • The supplier application has the latest update of warehouses see [Get Warehouses]

Before starting the following needs to be taken in consideration:

  • A batch is located on one warehouse location.
  • A batch has one packingconfiguration. In the foreseeable future multiple packingconfigurations can be added.
  • At this moment only a batch quantity can be updated.
Nr Process steps API call / [scenario]
1 Update available quantity of a batch. PUT /batches/{batchId}/quantity-corrections
2 The batch quantity is updated in Floriday.  

 

Batch correction implemenation guidance in addition to Swagger doc (non exhaustive):

Field Short description Guidance
correctionId Correction ID Generate unique UUID
deltaInPieces Correction quantity in pieces Correction quantity in pieces, '-' = substraction, '+'=addition
reason Reason Reason in free text. for communication between warehouses eg. 'inaccurate stock count'

Direct sales Supply scenarios

  1. Get Supply: Get Supply-lines created or updated in Floriday
  2. Base Supply Contiuous Stock: Create and update week base supply based on continuous stock
  3. Supply Contiuous Stock: Create and update week supply-lines based on continuous stock
  4. Base Supply Batches: Create and update base supply based on batches in ERP
  5. Supply Batches: Create and update supply-lines based on batches in ERP
  6. Delete supply-lines: Delete Supply-lines in Floriday.

Get Supply lines

Purpose: Get Supply-lines. Synchronize supply-lines from Floriday with supplier application.

Before starting the following needs to be in place:

  • The user has inserted supply in the Floriday catalog with or without one or more specific customer organizations.

Before starting the following needs to be taken in consideration:

  • For an easy starting implementation, the users can be asked to not alter nor manage supply in the Floriday application.
  • If the user can alter the supply-lines in the Floriday application it is advised to get supply-lines from Floriday and process the latest changes before adding or deleting supply.
  • If the user manages his base-supply and sales-orders in the supplier application it is advised to get supply-lines from Floriday.
  • All allocated supply-lines are currently exposed to the channels FloraMondo and FloraXchange and its customers. Specific supply-lines can be allocated to a certain channel and one or more specific customer organizations.
Nr Process steps API call / [scenario]
1 Get supply-lines with all product specifications and one or more packing options GET / supply-lines
2 Get customer organizations for customer specific trade items [Get Organizations]
3 Process the retrieved supply-llines in the supplier application with their unique supply-line ID. The supply-lines will be added or deleted from the supplier application.  

Add Base Supply Continuous Stock

Purpose: Add or change week base supply based on continuous stock.

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted his continuous stock in the supplier application. See [Toggle Continuous Stock
  • The user has inserted delivery conditions in Floriday. See [Get Delivery Conditions]
  • The user has inserted one or more price conditions for one or multiple groups of customer organizations (price groups) for direct sales in Floriday.

Before starting the following needs to be taken in consideration:

  • For an easy starting implementation, the users can be asked to not alter or manage supply in the Floriday application.
  • If the user can alter the supply-lines in the Floriday application it is advised to get supply-lines from Floriday and process the latest changes before adding or deleting supply.
  • If the user manages his base-supply and sales-orders in the supplier application it is advised to get supply-lines from Floriday.
  • All allocated supply-lines are currently exposed to the channels FloraMondo and FloraXchange and its customers. Specific supply-lines can be allocated to a certain channel and one or more specific customer organizations.
  • At this moment Supply-lines based on this scenario can only be allocated to FloraXchange. FloraMondo channel requires supply based on batch availability.
Nr Process steps API call / [scenario]
1 Add or change week base price, weeknumber and maximum commercial order quantity for the trade-item. PUT / trade-items /{tradeItemId} / base-supply/{year}/{week}
2 Supply lines will be created or updated in Floriday based on price conditions and delivery conditions.  
3 Supply lines will be allocated or updated in the customer channel for the customers  
4 Get supply lines as a basis to create and process sales orders. [Get Supply-lines]

Add Supply lines Continuous Stock

Purpose: Add week supply-lines based on continuous stock.

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted his continuous stock in the supplier application. See [Toggle Continuous Stock
  • The user has inserted delivery conditions in Floriday. See [Get Delivery Conditions]
  • The user has inserted his prices with maximum commercial orderquantity for a week in the supplier application.

Before starting the following needs to be taken in consideration:

  • For an easy starting implementation, the users can be asked to not alter or manage supply in the Floriday application.
  • If the user can alter the supply-lines in the Floriday application it is advised to get supply-lines from Floriday and process the latest changes before adding or deleting supply.
  • If the user manages his base-supply and sales-orders in the supplier application it is advised to get supply-lines from Floriday.
  • All allocated supply-lines are currently exposed to the channels FloraMondo and FloraXchange and its customers. Specific supply-lines can be allocated to a certain channel and one or more specific customer organizations.
  • At this moment Supply-lines based on this scenario can only be allocated to FloraXchange. FloraMondo channel requires supply based on batch availability.
Nr Process steps API call / [scenario]
1A Add specific week price, weeknumber and maximum commercial order quantity for the trade-item without customer organizations for general supply. POST / week-supply-lines

1B
Add specific week price, weeknumber and maximum commercial order quantity for the trade-item with customer organizations for customer specific supply [Get Organizations]
POST / week-supply-lines
2 Supply lines will be created or updated in Floriday based on delivery conditions.  
3 Supply lines will be allocated or updated in the customer channel for the customers  
4 Get supply lines as a basis to create and process sales orders. [Get Supply-lines]

 

Week supply-lines implemenation guidance in addition to Swagger doc (non exhaustive):

Field Short description Guidance
supplyLineId Supply line ID Generate unique UUID
pricePerPiece    
-currency Currency default "EUR"
-value Price per piece  
numerOfPieces Number of pieces  
tradePeriod TradePeriod  
-year Year  
-week Week number  
allowedCustomerOrganizationIds    
includedServices Included Service Included services in the price per piece

 

Add Base Supply Batches

Purpose: Add or change base supply based on batches

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted his batches in the supplier application. See [Add Batches
  • The user has inserted delivery conditions in Floriday. See [Get Delivery Conditions]
  • The user has inserted one or more price conditions for one or multiple groups of customer organizations (price groups) for direct sales in Floriday.

Before starting the following needs to be taken in consideration:

  • For an easy starting implementation, the users can be asked to not alter or manage supply in the Floriday application.
  • If the user can alter the supply-lines in the Floriday application it is advised to get supply-lines from Floriday and process the latest changes before adding or deleting supply.
  • If the user manages his base-supply and sales-orders in the supplier application it is advised to get supply-lines from Floriday.
  • All allocated supply-lines are currently exposed to the channels FloraMondo and FloraXchange and its customers. Specific supply-lines can be allocated to a certain channel and one or more specific customer organizations.
  • At this moment Supply-lines based on this scenario can be allocated to FloraXchange and FloraMondo.
Nr Process steps API call / [scenario]
1 Add or change base price, period and commercial order quantity for the batch. PUT / batches / {batchId} / base-supply
2 Supply lines will be created or updated in Floriday based on price conditions and delivery conditions.  
3 Supply lines will be allocated or updated in the customer channel for the customers  
4 Get supply lines as a basis to create and process sales orders. [Get Supply-lines]

 

Base supply implemenation guidance in addition to Swagger doc (non exhaustive):

Field Short description Guidance
supplyLineId Supply line ID Generate unique UUID
pricePerPiece    
-currency Currency default "EUR"
-value Price per piece  
numerOfPieces Number of pieces  
tradePeriod TradePeriod  
-startDateTime Start Date/time  
-endDateTime End Date/Time  

Add Supply lines Batches

Purpose: Add supply-lines based on batches

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted his batches in the supplier application. See [Add Batches
  • The user has inserted delivery conditions in Floriday. See [Get Delivery Conditions]
  • The user has inserted his prices with commercial quantity for a period in the supplier application.

Before starting the following needs to be taken in consideration:

  • For an easy starting implementation, the users can be asked to not alter or manage supply in the Floriday application.
  • If the user can alter the supply-lines in the Floriday application it is advised to get supply-lines from Floriday and process the latest changes before adding or deleting supply.
  • If the user manages his base-supply and sales-orders in the supplier application it is advised to get supply-lines from Floriday.
  • All allocated supply-lines are currently exposed to the channels FloraMondo and FloraXchange and its customers. Specific supply-lines can be allocated to a certain channel and one or more specific customer organizations.
  • At this moment Supply-lines based on this scenario can be allocated to FloraXchange and FloraMondo.
Nr Process steps API call / [scenario]
1 Add specific price, period and commercial quantity for the batch. POST / supply-lines
2 Supply lines will be created or updated in Floriday based on price conditions and delivery conditions.  
3 Supply lines will be allocated or updated in the customer channel for the customers  
4 Get supply lines as a basis to create and process sales orders. [Get Supply-lines]

Base supply implemenation guidance in addition to Swagger doc (non exhaustive):

Field Short description Guidance
supplyLineId Supply line ID Generate unique UUID
batchId Batch ID  
pricePerPiece    
-currency Currency default "EUR"
-value Price per piece  
numerOfPieces Number of pieces  
tradePeriod TradePeriod  
-startDateTime Start Date/time  
-endDateTime End Date/Time  
inckudedServices Included services Included services for the price per piece
allowedCustomerOrganizationIds Customer Ids Customer(s) for whom the price is intended. If none are given, the price is applicable for all customers.

Delete Supply lines

Purpose: Delete supply-lines

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted supply-lines in the supplier application.
  • The user has inserted delivery conditions in Floriday. See [Get Delivery Conditions]

Before starting the following needs to be taken in consideration:

  • For an easy starting implementation, the users can be asked to not alter or manage supply in the Floriday application.
  • If the user can alter the supply-lines in the Floriday application it is advised to get supply-lines from Floriday and process the latest changes before adding or deleting supply.
  • If the user manages his base-supply and sales-orders in the supplier application it is advised to get supply-lines from Floriday.
  • All allocated supply-lines are currently exposed to the channels FloraMondo and FloraXchange and its customers. Specific supply-lines can be allocated to a certain channel and one or more specific customer organizations.
Nr Process steps API call / [scenario]
1 Delete a specific supply-line DELETE / supply-lines / {supplyLineId}
2 Supply line will be deleted in Floriday.  
3 Supply line will be deleted in the customer channel for the customers.  

Direct sales Order scenarios

  1. Add Sales Orders: Place accepted sales orders based on supply-lines
  2. Get Sales Orders: Get accepted and cancelled Sales Orders (polling)
  3. Receive-Sales Orders: Initiate event server in ERP to get accepted and cancelled Sales Orders with possibility to reject

Get Sales Orders

Purpose: Get sales orders.

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted delivery conditions in Floriday. See [Get Delivery Conditions]
  • The user has inserted supply lines in Floriday with or without customer organizations.
  • The supplier application has the supply-lines from Floriday. See [Get Supply-lines]

Before starting the following needs to taken in consideration:

  • A sales order needs to be placed on a supply-line.
  • Sales orders and cancelled orders are returned.
  • In addition to direct sales, sales orders of other trade instruments will be made available in the foreesable future:
    • Clock sales and clock pre sales.
    • Contract sales: standing orders based on contracts or agreements in Floriday.
  • A sales order can be placed by:
    • the buyer in the channel or the user in the floriday application on behalf of the buyer. In which case the delivery conditions in Floriday are applicable.
    • the user in the the supplier application (manual order) on behalf of the buyer. In which case the delivery conditions are added to the sales order in the supplier application.
Nr Process steps API call / [scenario]
1 Get sales orders and cancelled sales order within a given period and tradeInstrument='DIRECT_SALES'. GET / sales-orders
2 Get customer organizations for sales orders [Get Organizations]
3 Process the retrieved sales-orders in the supplier application with their unique sales order ID. The sales orders will be added or cancelled in the supplier application.  
4 The current RFH fulfillment & payment process can be initiated for direct sales.  

 

Add Sales Orders

Purpose: Add sales orders.

Before starting the following needs to be in place:

  • The user has inserted trade-items in the Floriday catalog with or without customer organizations.
  • The user has inserted delivery conditions in Floriday. See [Get Delivery Conditions]
  • The user has inserted supply lines in Floriday with or without customer organizations.
  • The supplier application has the supply-lines from Floriday. See [Get Supply-lines]

Before starting the following needs to taken in consideration:

  • A sales order needs to be placed on a supply-line.
  • Sales orders and cancelled orders are returned.
  • A sales order can be placed by:
    • the buyer in the channel or the user in the floriday application on behalf of the buyer. In which case the delivery conditions in Floriday are applicable.
    • the user in the the supplier application (manual order) on behalf of the buyer. In which case the delivery conditions are added to the sales order in the supplier application.
Nr Process steps API call / [scenario]
1 Get customer organizations for sales orders [Get Organizations]
2 Add a sales order in Floriday based on a supply-line. POST / sales-orders
3 Floriday validates the sales-order  
4 The sales-order is processed on the supply-line.  
5 The sales-order is notified to the customer.  
5 The current RFH fulfillment & payment process can be initiated for direct sales.  

 

Sales order implemenation guidance in addition to Swagger doc (non exhaustive):

Field Short description Guidance
orderLineId Order line ID Generate uniqye UUID
customerOrganizationId Customer organization ID  
supplyLineId Supply line ID  
numerOfPieces Number of pieces Total batch quantity in pieces
pricePerPiece    
-currency Currency default 'EUR'
-value Price per piece  
customerOrderId Customer orderreference ID The order reference ID of the customer
tradeInstrument Trade instrument DIRECT_SALES
packingConfigurationId    
selectedPackingConfiguration Packing configuration ID Selected packing configuration Id from a trade-item
piecesPerPackage Pieces per package  
bunchesPerPackage Bunches per package  
Package   Package information
-vbnPackageCode VBN package code  
-heightInMM Package height in MM  
-lenghtInMM Package lenght in MM Mandatory if VBN package code has no lineair dimensions, used for calculating packaging
-widthInMM Package width in MM Mandatory if VBN package code has no lineair dimensions, used for calculating packaging
-loadCarrier Loadcarrier type Enumeration
orderDateTime Order date time  
deliveryConditionId Delivery condition ID  
latestDeliveryDateTime Latest delivery date/time  
regionGln regionGln  
location location  
gln gln GLN location number
address address  
addressLine address line  
city city  
countryCode Country Code  
postalCode Postal code  
stateOfProvince state of province  

 

Receive Sales Orders

NOTE: This scenario is to be validated in a proof of concept and will be made available if successfull.

Purpose: Receive sales orders

Veelgestelde vragen

Floriday maakt gebruik van analytische cookies om uw ervaring op onze website te verbeteren, om uw voorkeuren te onthouden en om informatie te kunnen geven waardoor de website kan worden verbeterd.


Door op akkoord te klikken, geeft u toestemming om Cookies te gebruiken.

 Klik hier 

voor meer informatie.

Ja, ik ga akkoord