Catalog supply
Supported scenarios
- Sync Supply lines;
- Get Supply lines;
- Create Weekly Base Supply;
- Update Weekly Base Supply;
- Delete Weekly Supply lines.
For the business rules concerning Catalog supply, please read Business Rules - Catalog Supply.
Note
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
Sync (weekly) Supply-lines from Floriday to the supplier application.
Prerequisites
- The supplier application has the latest update of
[organizations](doc:organizations); - The supplier application has the latest update of trade items;
- The supplier application has the latest update of trade item availabilities;
- The user has inserted weekly (base) supply with or without one or more specific customer organizations in Floriday;
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Get highest generated sequence number. | [GetSupplyLinesMaxSequence](https://api.staging.floriday.io/suppliers-api-2024v1/swagger/index.html#/DirectSales/GetSupplyLinesMaxSequence) |
| 2 | Sync supply lines with limit and latest sequence number. Supply has supply type 'catalog price'. | [GetSupplyLinesBySequenceNumber](https://api.staging.floriday.io/suppliers-api-2024v1/swagger/index.html#/DirectSales/GetSupplyLinesBySequenceNumber) |
| 3 | Process the retrieved weekly 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
Get (weekly) Supply-lines from Floriday in supplier application.
Prerequisites
- The supplier application has the latest update of
[organizations](doc:organizations); - The supplier application has the latest update of trade items;
- The supplier application has the latest update of trade item availabilities;
- The user has inserted weekly (base) supply with or without one or more specific customer organizations in Floriday.
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 A | Returns supply lines created within the given timeframe. | [GetSupplyLines](https://api.staging.floriday.io/suppliers-api-2024v1/swagger/index.html#/DirectSales/GetSupplyLines) |
| 1 B | Returns a supply line based on ID. | [GetSupplyLineById](https://api.staging.floriday.io/suppliers-api-2024v1/swagger/index.html#/DirectSales/GetSupplyLineById) |
| 2 | Process the retrieved weekly 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. |
Update Weekly Base Supply
Purpose
Update weekly base supply in Floriday.
Prerequisites
- The supplier application has the latest update of
[organizations](doc:organizations); - The supplier application has the latest update of trade items;
- The supplier application has the latest update of trade item availabilities;
- The weekly supply is not 'fixed' for sales within the channel. Exemption for patching number of pieces;
- The user has inserted one or more price groups conditions for one or multiple groups of customer;organizations (price groups) for direct sales in Floriday;
- The user has updated direct sales weekly base price in the supplier application;
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1A | Update weekly base price, week number and an indicative available weekly quantity for the trade item. | [EditWeeklyBaseSupply](https://api.staging.floriday.io/suppliers-api-2024v1/swagger/index.html#/CatalogPrices/EditWeeklyBaseSupply) |
| 1B | Patch number of pieces of an existing base supply. | [SetWeeklyBaseSupplyNumberOfPieces](https://api.staging.floriday.io/suppliers-api-2024v1/swagger/index.html#/CatalogPrices/SetWeeklyBaseSupplyNumberOfPieces) |
| Weekly Supply lines will be updated in Floriday based on price conditions and delivery conditions. | ||
| 2 | Weekly Supply lines will be updated in the Customer channels. | |
| 3 | Weekly supply lines can be retrieved by the Customer organizations from the Customer channel. |
Delete Weekly Supply-lines
Purpose
Delete weekly supply lines based in Floriday.
Prerequisites
- The supplier application has the latest update of
[organizations](doc:organizations); - The supplier application has the latest update of trade items;
- The supplier application has the latest update of trade item availabilities;
- The supplier application has weekly supply-lines;
- The supplier has deleted weekly supply in the supplier application;
- The weekly supply is not 'fixed' for sales within the channel.
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Delete weekly supply line. | [DeleteWeeklySupplyLines](https://api.staging.floriday.io/suppliers-api-2024v1/swagger/index.html#/CatalogPrices/DeleteWeeklySupplyLines) |
| Weekly Supply lines will be deleted in Floriday. | ||
| 2 | Weekly Supply lines will be deleted in the Customer channels. | |
| 3 | Weekly supply lines can no longer be retrieved by the Customer organizations from the Customer channel. |
Create Weekly Supply-lines
Purpose
Create weekly supply lines in Floriday.
Prerequisites
- The supplier application has the latest update of
[organizations](doc:organizations); - The supplier application has the latest update of trade items;
- The supplier application has the latest update of trade item availabilities;
- The user has inserted his prices with indicative available quantity for a week in the supplier application.
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Create specific week price, weeknumber and indicative available weekly quantity for the trade item with customer organizations for customer specific supply. | [AddWeeklySupplyLine](https://api.staging.floriday.io/suppliers-api-2024v1/swagger/index.html#/CatalogPrices/AddWeeklySupplyLine) |
| Weekly Supply lines will be created in Floriday based on price conditions and delivery conditions. | ||
| 2 | Weekly Supply lines will be allocated in the Customer channels. | |
| 3 | Weekly supply lines can be retrieved by the Customer organizations from the Customer channel. |
Update Weekly Supply-lines
Purpose
Update weekly supply-lines in Floriday.
Prerequisites
- The supplier application has the latest update of
[organizations](doc:organizations); - The supplier application has the latest update of trade items;
- The supplier application has the latest update of trade item availabilities;
- The weekly supply is not 'fixed' for sales within the channel;
- The user has inserted and updated his prices with indicative available quantity for a week in the supplier application.
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Update specific week price, weeknumber and indicative weekly available quantity for the trade item with customer organizations for customer specific supply | [EditWeeklySupplyLine](https://api.staging.floriday.io/suppliers-api-2024v1/swagger/index.html#/CatalogPrices/EditWeeklySupplyLine) |
| Weekly Supply lines will be updated in Floriday based on price conditions and delivery conditions. | ||
| 2 | Weekly Supply lines will be updated in the Customer channels. | |
| 3 | Weekly supply lines can be retrieved by the Customer organizations from the Customer channel. |
Updated 18 days ago