Connections
Supported connection scenarios
- Receiving connections
- Creating supplier connections
- Removing supplier connections
For the business rules concerning connections, please read [Connections]
(doc:connections-1).
Receiving connections
Purpose:
Receiving connections from Floriday.
Prerequisites:
- Customer has active connections on Floriday.
NR | Process step | API call / scenario |
---|---|---|
1 | Returns list of all active connections. | [GetConnections] (https://api.staging.floriday.io/customers-api-2024v1/swagger/index.html#/Connections/GetConnections) |
2 A | Returns the maximum sequence number found in connections. | [GetConnectionsMaxSequence] (https://api.staging.floriday.io/customers-api-2024v1/swagger/index.html#/Connections/GetConnectionsMaxSequence) |
2 B | Returns a list of max 1000 connections starting from a specified sequence number. | [GetConnectionsBySequenceNumber] (https://api.staging.floriday.io/customers-api-2024v1/swagger/index.html#/Connections/GetConnectionsBySequenceNumber) |
Creating a new supplier connection
Purpose:
Creating a new supplier connection on Floriday.
NR | Process step | API call / scenario |
---|---|---|
1 | Creates a new connection based on SupplierOrganisationId. | [CreateConnectionBySupplierOrganizationId] (https://api.staging.floriday.io/customers-api-2024v1/swagger/index.html#/Connections/CreateConnectionBySupplierOrganizationId) |
2 | Supplier will be notified on Floriday of a new connection. |
Deleting a connection on Floriday
Purpose:
Delete a specific connection with a supplier on Floriday.
Prerequisites:
- Customer has an active connection with the specified supplier on Floriday.
NR | Process step | API call / scenario |
---|---|---|
1 | Removes a connection with a specified supplier based on SupplierOrganisationId. | [DeleteConnection] (https://api.staging.floriday.io/customers-api-2024v1/swagger/index.html#/Connections/DeleteConnection) |
2 | Specified supplier will no longer have the customer as a connection but will not actively be notified by Floriday. |
Updated 18 days ago