External APIs

The APIs use basic authorization, user and password will be provided by Flourish admins The TenantID for the URL is a Guid and will be provided by Flourish admins

Ecommerce

Customer Types

URL

api/External/Read/Ecommerce/CustomerType/[TenantID]

Object

IDValue, NameValue

Holidays

Returns holidays and Delivery Blackout Periods

URL

api/External/Read/Ecommerce/Holidays/[TenantID]/[Year]

Object

HolidayID, HolidayName, BlackOut, Date

Funerals

URL

api/External/Read/Ecommerce/Funerals/[TenantID]

Object

RecipientID, RecipientName, Salutation, EndDate, DateOfDeath, DateOfBirth, FuneralHomeResponsible

List <Calendar>
EventType, Location, LocationType, LocationAddressLine1, LocationAddressLine2, LocationCity, LocationState, LocationPostalZip, LocationCountry, LocationEmail, LocationPhoneNumber, LocationCellNumber, StartDateTime, EndDateTime, Private

List <Products>
ProductID, EcommerceID, ProductNumber, ProductName, SmallProductImage, SmallProductImageThumb, ProductImage, ProductImageThumb, LargeProductImage, LargeProductImageThumb

Delivery Postal Zip

URL

api/External/Read/Ecommerce/DeliveryPostalZip/[TenantID]

Object

PostalZip, Zone, Rate, AMRate, PMRate

Recurring Addresses

URL

api/Read/External/RecurringAddresses/[TenantID]

Object

RecurringAddressID, RecurringAddressNumber, RecurringAddressName, AddressLine1,
AddressLine2, City, StatesID, StatesName, CountriesID, CountriesName, PostalZip, Lat,
Lng, PhoneNumber, CellNumber, Email, RecurringAddressTypeID, RecurringAddressTypeName

Reports

MultiTenantDataset

URL

api/External/Read/Reports/MultiTenantDataset/[TenantID] ?[queryString]

Object

Depends on the dataset requested
Dataset

URL

api/External/Read/Reports/Dataset/[TenantID]?[queryString]

Object

Depends on the dataset requested

Available Datasets

see MultiTenantDatasetRepository
ReceivedQuantity
ReceivedQuantity_Summary
SalesQuantity
CustomerSalesAndCommission