Order specific methods

The methods below are related to the marketing integrator orders created for each case/property.

Add integration status and state

Adds a new status and state to the order Status: Can be any string/internal status State: MarketingIntegratorOrderState

POST /flow/api/marketingintegrators/orders/{orderId}/updatestate

orderId: GUID Sent from Core/Flow when order is created against integrator

Body

  • Status: string
  • State: MarketingIntegratorOrderState

Response
MarketingIntegratorOrderModel image

Update order

Sets the metadata on the order, this will be displayed as “key - value” for the end-user in Core

PATCH /flow/api/marketingintegrators/orders/{orderId}

orderId: GUID sent from Core/Flow when order is created against integrator

Body:

Response
MarketingIntegratorOrderModel

image

Verify FlowToken

Used to verify a FlowToken that is sent during the ordering process. See the section above for more information.

POST /flow/api/MarketingIntegrators/VerifyToken

Body:
Token: string
Response - information about user that generated the token
MarketingIntegratorTokenModel

Model definitions

Customers can set up checklist items to automatically be checked-off based on MarketingIntegratorOrderState, this is something each individual customer sets up in their environment.

MarketingIntegratorOrderState

  • CreatedNotSent
    Default state. Is automatically set by the system when the user presses the order-button in Core (Core creates an order on its side).
  • InProcess
    When an order has been created and is being processed on the integrators side.
  • Error
    Set the state to error if there is a problem during connection. Should be set with a proper status-message as well, describing the error.
  • MissingInfo
    If there is not enough information available to confirm or process an order, use this. Should be set alongside a proper status-message, describing the missing info.
  • Completed
    The order has finished processing and the product has been delivered. Use proper status-messages if there are different outcomes.
  • Cancelled
    Use when the order has been canceled. Even though the order may be deleted on the integrator’s side, it is still desirable for the state to indicate that the order has been canceled.

MarketingIntegratorOrderState specific for insurance providers

  • Created
    Used by “Foreløbig polise”.
  • Activated
    When the insurance is activated when the property is sold

MarketingIntegratorOrderModel

  • Id: int
  • Guid: Guid
  • Title: string
  • ActionText: string
  • CaseBaseId: int
  • MarketingIntegratorId: int
  • CreatedDate: Date
  • ModifiedDate: Date
  • Metadata: string
  • OrderStatuses: List<MarketingIntegratorStatusModel>

MarketingIntegratorStatusModel

  • Id: int
  • Status: string
  • CreatedDate: date

MarketingIntegratorMetadataModel

  • Key: string
  • Value: string

MarketingIntegratorTokenModel

  • UserId: int
  • FullName: string
  • Email: string
  • BrokerCompanyName: string
  • OfficeId: int
  • OfficeName: string
  • Data: Dictionary<MarketingIntegratorTokenDataModel>

MarketingIntegratorTokenDataModel

OrderId: string

Expected sequence of events

image