Trade item availabilities
Supported scenarios
- Sync Trade item availabilities;
- Get Trade item availabilities;
- Toggle Trade item availabilities.
For the business rules concerning trade item availabilities, please read Business Rules - Trade item availabilities.
Continuous stock to be called Trade item availabilities
We decided to rename the term Continuous Stock to Trade item availabilities. We feel this change better describes the purpose of the feature. For now, this change will only be made in the API Documentation.
The endpoints GetContinuousStock and EditContinuousStock will remain unchanged for now. Once a functional change is planned for these endpoints, we will rename the endpoints to match the new term. We will communicate the changes to these endpoints well in advance.
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 Trade item availabilities
Purpose
Synchronize Trade Item Availabilities from Floriday in supplier application.
Prerequisites
- The supplier application has the latest update of organizations;
- The supplier application has the latest update of trade-items;
- The user has set or changed its current Trade item availability in Floriday.
Process steps
NR | Process step | API call / scenario |
---|---|---|
1 | Return the maximum sequence number found in trade item availabilities. | GetTradeItemAvailabilitiesMaxSequence |
2 | Sync all trade item availabilities with a result limit. | GetTradeItemAvailabilitiesBySequenceNumber |
Get Trade item availabilities
Purpose
Get Trade item availability of a trade item from Floriday in supplier application.
Prerequisites
- The supplier application has the latest update of organizations;
- The supplier application has the latest update of trade-items;
- The user has set or changed its current Trade item availability in Floriday.
Process steps
NR | Process step | API call / scenario |
---|---|---|
1 | Get current Trade item availability of trade items with or without excluded customers. | GetContinuousStock |
2 | The retrieved Trade item availability is processed in the supplier application. |
Toggle Trade item availability
Purpose
Set Trade item availability on available or not available in Floriday.
Prerequisites
- The supplier application has the latest update of organizations;
- The supplier application has the latest update of trade-items;
- The user has set or changed its current Trade item availability in the supplier application.
Process steps
NR | Process step | API call / scenario |
---|---|---|
1 | Toggle current availability (true or false) of an existing trade item with an unique tradeItemId with or without excluded customers. | EditContinuousStock |
The Trade item availability is set to available (true) or not available (false) in Floriday. |
Set Trade item availability for excluded customers
An exception for the Trade item availability can be set by adding specific customers to
excludedCustomerOrganizationIds
.For instance, if
available
is set to False, but a customerOrganzationId has been added toexcludedCustomerOrganizationIds
, the Trade item availability for that specific customer will be set to True.
- This means that the supply line will only be available for that specific customer.
- You can also exclude certain customers by setting
available
to True in a similar manner.- More than one customerOrganizationId may be added to
excludedCustomerOrganizationIds
.
Updated 2 months ago