Creation and Import of Externally-Managed Offers

Preliminary Remarks

Offers managed by third parties cannot be purchased via the Frisbii Media Checkout. An import via API can be used to place an order for an externally-managed offer.

Note:

An import creates both an order and an externally-managed subscription. Externally-managed subscriptions differ from regular subscriptions. A description can be found here.

Offer Creation

All offers that can be managed externally have a corresponding option in the offer creation.

The following steps are necessary to define an offer as externally managed:

• Open the menu item Products / Offers.

• Click on the "Create Offer" button.

• Select the desired offer type and click the "Create" button.

• Select the desired option in the "External Management" section of the form.
  Depending on the type of offer, the area can be found either at the end of the form or in the "Base data" tab

• Saving the offer creation

Importing an order

To place an order for an externally-managed offer, it is necessary to import the order via the API. The corresponding endpoint or request is described in the API documentation.  

Customer data To perform an import, the customer for whom the order is being created must already exist in Frisbii Media.

If this is not the case, the customer must be created via an additional request before the import. The following steps are necessary for this:

• POST request to create a customer data record

• Necessary data in the request are:

  • email
    the customer's email address as a unique identifier of the data record

  • language
    the language of the customer

• The other fields can be filled optionally

Import data Necessary data in the request for carrying out an import:  

• externalSystemId
  Unique ID from the leading third-party system. Is noted in Frisbii Media on the order and subscription.

• Frisbii MediaOfferId
  The Frisbii Media order number to be used

• invoiceCustomerId
  The Frisbii Media customer number

• quantity
  The desired quantity of the offer

• startDate
  The start date for subscriptions. Also determines the start date for the access rights in Frisbii Media.

• paymentMethod
  The payment method used for the order.

Other data fields are also available. A complete list can be found in the API documentation.  

All imports carried out are recorded in the Log.  

Note:

An order import is executed asynchronously. In the response to an import, a promiseId may be issued, which can be used for identification.

Updating an order

Externally-managed offers cannot be updated directly in the Frisbii Media backend. A new import with adjusted data is necessary for each update.  

Implementation of an update:  

• The same endpoint is used for the update as for the import.

  • Customization of the desired data in the requestbody

  • Setting the "endDate" field leads to the end of a subscription

  • Update the payment method by updating the "paymentMethod" field