Introduction

It is possible for an integrator to create a new order for a case on behalf of a customer.

Note that this functionality is only meant to be used by Integrators who wants to automate the process of placing orders through Marketing Integrator in Core. Without this functionality, a broker can still place Marketing Integrator orders manually through the UI in Core.

Prerequisites

In order for an integrator to create a new order, the following steps must have been completed as a prerequisite:

• You have requested and received a Client ID and Client Secret for access to Core as an API user.
• Contacted Visma to setup a Marketing Integrator service on your behalf.
• Contacted Visma to enable creating a new order as an integrator for that Marketing Integrator service.
• Your API user have the following permission: Marketing Integrator - WRITE

For information on how you can request a new API user or any of the other steps that requires contacting Visma, please see the FAQ section.

Creating a new order as an Integrator

After authenticating yourself, send the following request:

Endpoint:

POST /flow/api/MarketingIntegrators/Cases/{caseId}/CreateOrderAsIntegrator

Payload:

The payload should be empty.

Response:

{
  "Id": 0,
  "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Title": "string",
  "ActionText": "string",
  "CaseBaseId": 0,
  "MarketingIntegratorId": 0,
  "CreatedDate": "2023-08-07T13:00:39.296Z",
  "ModifiedDate": "2023-08-07T13:00:39.296Z",
  "Metadata": "string",
  "OrderStatuses": [
    {
      "Id": 0,
      "Status": "string",
      "OrderStateType": "Unknown",
      "CreatedDate": "2023-08-07T13:00:39.296Z"
    }
  ]
}

The id returned (not the id under OrderStatuses) in the response can be used as an orderId for other order specific methods.

Limitations

It is only possible to enable creating a new order as an integrator for a single Marketing Integrator service per API user.