Supply lines
We define a supply line as a trade item that is marketed at a specific price and period during which a customer is allowed to purchase it.
Supply lines are a basis to create and process sales orders. We recommend syncing all supply lines a supplier organization has made and to make a distinction between Direct sales Supply lines and Clock (pre sales) Supply lines. These are seperate entities and should be treated as such during the implementation. The difference between the various Supply line types are listed on the Supply page.
Below is an instruction of how to retrieve Supply lines in general, using the Sync endpoint and the Get endpoint. In the following chapters you can read how to implement the different types of Supply lines.
Sync vs Get
This page describes how to utilize both the Sync and non-sync Get endpoints. We strongly recommend using the Sync endpoints whenever possible.
Read the Best Practices for more information.
Sync Supply-lines
Purpose
To Sync Supply lines from Floriday to the supplier application.
Prerequisites
The following models must be present in your system in order to fully process a supply line.
- Organizations, these determine for which customer(s) the supply line is available and which supplier is the owner.
- TradeItems, which contains the specific product information for which the supplyline has been offered.
- Batches, which is required when the supply is based on an existing batch. Take note: Batches may contain batch-specific values that override the tradeItem data.
- Note that you will only receive supply lines when the supplier organization works with one of the following flows via Floriday (Portal and/or API)
- Catalog base supply;
- Batch base supply;
- Weekly lines;
- Customer offer;
- Supply and Order requests.
Process steps
NR | Process step | API call / scenario |
---|---|---|
1 | Get highest generated sequence number. | GetSupplyLinesMaxSequence |
1 | Sync supply lines with limit and latest sequence number. Supply has supply type 'catalog price'. | GetSupplyLinesBySequenceNumber |
2 | Process the retrieved supply lines in the supplier application with their unique supply line ID. The supply lines will be added, updated or deleted in the supplier application. The supply lines are a basis to create and process sales orders. |
Get Supply lines
Purpose
To retrieve Supply lines within a given timeframe from Floriday to the supplier application.
Prerequisites
The following models must be present in your system in order to fully process a supply line.
- Organizations, these determine for which customer(s) the supply line is available and which supplier is the owner.
- TradeItems, which contains the specific product information for which the supplyline has been offered.
- Batches, which is required when the supply is based on an existing batch. Take note: Batches may contain batch-specific values that override the tradeItem data.
- Note that you will only receive supply lines when the supplier organization works with one of the following flows via Floriday (Portal and/or API)
- Catalog base supply;
- Batch base supply;
- Weekly lines;
- Customer offer;
- Supply and Order requests.
Process steps
NR | Process step | API call / scenario |
---|---|---|
1 A | Returns supply lines created within the given timeframe. | GetSupplyLines |
1 B | Returns a supply line based on ID. | GetSupplyLineById |
2 | Process the retrieved supply lines in the supplier application with their unique supply line ID. The supply lines will be added, updated or deleted in the supplier application. The supply lines are a basis to create and process sales orders. |
Updated 11 days ago