Supply lines
Supported supply lines scenarios
- Syncing modified supply lines.
- Receiving supply lines of a selected supplier.
- Receiving supply data of a selected supply line.
For all the types of supply lines and their business rules, please read [Supply]
(doc:supply-1).
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.
Syncing modified supply lines
Purpose:
Synchronise modified supply lines of all connected suppliers from Floriday in customer application.
Prerequisites:
- Known sequence numbers retrieved from Floriday are used for this scenario.
NR | Steps | API call / scenario |
---|---|---|
1 | Returns the maximum sequence number found in supply lines. | [GetSupplyLinesMaxSequence] (https://api.staging.floriday.io/customers-api-2024v1/swagger/index.html#/SupplyLines/GetSupplyLinesMaxSequence) |
2 | Receive supply lines from all the suppliers in your network based on the provided sequence number. | [_GetSupplyLinesBySequenceNumber_] (https://api.staging.floriday.io/customers-api-2024v1/swagger/index.html#/SupplyLines/GetSupplyLinesBySequenceNumber) |
Receiving supply lines of a selected supplier
Purpose:
Synchronise supply lines of specified supplier from Floriday in customer application.
Prerequisites:
- The specified supplier is a connection of the customer;
- There are valid supply lines available for the customer.
NR | Steps | API call / scenario |
---|---|---|
1 | Receive a maximum of 1000 supply lines which are valid in the given timeframe for the specified supplier. | [_GetSupplyLines_] (https://api.staging.floriday.io/customers-api-2024v1/swagger/index.html#/SupplyLines/GetSupplyLines) |
2 | Use filtering to restrict the amount of supply lines you will receive in one call to make sure it stays under 1000. |
Receiving supply data of a selected supply line
Purpose:
Synchronise supply lines of specified supplier from Floriday in customer application.
Prerequisites:
- A known supply line id retrieved from Floriday is specified for this scenario;
- The specified supply line is from a supplier which is a connection of the customer.
NR | Steps | API call / scenario |
---|---|---|
1 | Receive supply data based on a specified Supply ID. | [_GetSupplyLinesById_] (https://api.staging.floriday.io/customers-api-2024v1/swagger/index.html#/SupplyLines/GetSupplyLineById) |
Updated 18 days ago