Base items
Supported scenarios
- Receive base items;
- Sync base items;
- Create base items;
- Delete base items;
- Update base items.
For the business rules concerning organizations, please read Business Rules - Base items.
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.
Receive base items
Purpose
- Receive base items from Floriday in supplier application.
Prerequisites
- The user has added base items to the Floriday catalog.
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Get organization details with Floriday base item id | GetBaseItemById |
| 2 | The retrieved base item details will be added or updated in the supplier application. |
Sync base items
Purpose
- Synchronise base-items from Floriday in supplier application.
Prerequisites
- The user has inserted base-items in the Floriday catalog.
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 A | Returns the maximum sequence number found in organizations. | GetBaseItemsMaxSequence |
| 1 B | Get changed base items since last sequence number. Repeat step until all base items are synchronised | GetBaseItemsBySequenceNumber |
| 2 | Process the retrieved base items with the base items in the supplier application with their unique baseItemId and base item details including an imageURL.The base items will be added, updated or deleted in the supplier application. | |
| 3 | Get base item images by imageURL. | |
| 4 | Process the retrieved images. |
Create base items
Purpose
- Create base items from supplier application in Floriday.
Prerequisites
- The user has inserted base items in the Floriday catalog.
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Create an image. | AddImage |
| 2 | Create a new base item with an unique baseItemId and base item details including an imageURL. | AddBaseItem |
| The new base item is validated by Floriday and will be added to the Supplier organization catalog in Floriday. |
Delete base items
Purpose
Deleting base items from supplier application in Floriday.
Prerequisites
- The supplier application has the latest update of base items;
- The user is deleting a base item in the supplier application.
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Delete an existing base item with an unique baseItemId | DeleteBaseItem |
| The base item will be deleted from the Supplier organization catalog in Floriday. |
Update base items
Purpose
- Updating base items from supplier application in Floriday.
Prerequisites
- The supplier application has the latest update of base items;
- The user has updated the base item in the supplier application.
Process steps
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Update a base item with an unique baseItemId. | EditBaseItem |
| The base item will be updated in the Supplier organization catalog in Floriday. |
Updated about 1 month ago