Understanding API Sales

    This article provides a high-level summary of the API Sales process on the Powered by Jumbo (PBJ) Platform.

    An API also exists for automating the import of offline sales. For more information about this API, click here.

    Prerequisites

    • Access to the PBJ Admin platform
    • ‘Channel Report’ and ‘Supplier costs report’ capabilities enabled

    What Is An API?

    An application programming interface (API) regulates interactions between multiple software intermediaries. An API can be likened to a contract between two parties as it defines the kinds of requests that can be made, the process in which the requests are submitted, and the data formats the requests must satisfy. An API can be entirely custom, specific to a component, or it can be designed based on an industry standard to ensure interoperability.

    How Does This Apply To Sales On The PBJ Platform?

    For PBJ clients who resell on OzLotteries, an API can be implemented for sales. An API for sales across PBJ instances removes the reliance on flat/batch files in order to reconcile ticket sales between the PBJ instances.

    Key Business Outcomes

    The implementation of API Sales between Oz Lotteries and a PBJ instance will result in the following outcomes:

    • OzLotteries will purchase directly from a PBJ instance via API.
    • When OzLotteries sends a remote request structured in the desired format, the PBJ instance will respond.
    • The use of flat files will no longer be needed.
    • The OzLotteries website and the PBJ instance will share the same ticket allocation.
    • OzLotteries sales purchased from a PBJ via the API will appear in the accompanying PBJ admin ticket search.
      • These sales will be marked as OzLotteries.
    • The customer details are passed from OzLotteries to the accompanying PBJ and will appear in both PBJ Admin customer searches.
      • These customers will be marked as OzLotteries customers.
    • The Channel Report in the accompanying PBJ will show OzLotteries sales.

    Purchasing Flow

    Screen-Shot-2020-08-07-at-10.58.51-am-1024x763 (1).png

    Reconciliation Flow

    Screen-Shot-2020-08-07-at-1.48.23-pm-1024x564 (1).png

    Customer Scenarios For API Sales

    Oz Lotteries Only Customers:

    Scenario:
    A sale is made through Oz Lotteries and the customer does not exist in the PBJ instance.

    Answer:
    The customer is added in the PBJ instance along with the customer name, phone number and address and marked as an ‘offline’ customer with ‘Oz Lotteries API Sales’ affiliation. The customer profile in the PBJ instance will list the transaction amount as ‘accounts receivable for third-party sales of OZL’ in the customer’s transaction history on the PBJ instance.

    Scenario:
    A sale is made through Oz Lotteries and the customer already exists in the PBJ instance due to a previous Oz Lotteries purchase and has the same contact details.

    Answer:
    The purchase and third-party transaction will appear on the offline account with ‘Oz Lotteries API Sales’ affiliation that was created on the first API purchase.

    Scenario:
    A sale is made through Oz Lotteries and the customer already exists in the PBJ instance due to a previous Oz Lotteries purchase but has different contact details (e.g. they updated their contact details in Oz Lotteries since the previous purchase).

    Answer:
    Customer details are updated and a new record is not created.

    Existing PBJ Instance Customers Buying Through Oz Lotteries:

    Scenario:
    A sale is made through Oz Lotteries and the customer already exists in the PBJ instance due to a previous PBJ purchase and has the same contact details.

    Answer:
    An offline account is created with customer details passed from Oz Lotteries, excluding the email address.

    Scenario:
    A sale is made through Oz Lotteries and the customer already exists in the PBJ instance due to a previous PBJ purchase but has different contact details.

    Answer:
    An offline account is created with customer details passed from Oz Lotteries, excluding the email address.

    Existing Oz Lotteries Customers Buying Through A PBJ Instance:

    Scenario:
    A sale is made through a PBJ instance and the customer already exists as an ‘offline’ customer in the PBJ instance due to a previous Oz Lotteries purchase and has the same contact details.

    Answer:
    A new customer account for the PBJ instance would be created during the purchase flow:

    • Website – Creating an account to sign in and purchase via the website.
    • POS – Operator creating the customer account during the purchase flow.
    • Mail – Created during operator purchase on PBJ instance (customer would be prompted to create a password upon the first login).

    Scenario:
    A sale is made through a PBJ instance and the customer already exists in the PBJ instance due to a previous Oz Lotteries purchase and has different contact details.

    Answer:
    A new customer account for the PBJ instance would be created during the purchase flow:

    • Website – Creating an account to sign in and purchase via the website.
    • POS – Operator creating the customer account during the purchase flow.
    • Mail – Created during operator purchase on PBJ instance (customer would be prompted to create a password upon the first login).

    Two offline accounts can share the name, phone number and street address; but no account can share the same email address.

    What Do API Sales Look Like?

    OzLotteries Affiliation On The Customer’s Profile

    Screen_Shot_2020-08-07_at_1_52_29_pm (1).png

    Ticket Provider In Wager Information

    OzLotteries

    Screen-Shot-2020-08-12-at-11.07.25-am (1).png

    PBJ Instance

    Screen-Shot-2020-08-12-at-11.10.57-am (1).png

    Affiliated Deposit Listed In The Transaction History

    Screen-Shot-2020-08-07-at-1.58.53-pm-1024x36 (1).png

    Reports

    Channel Report

    Screen-Shot-2020-08-07-at-3.10.52-pm-1024x459 (1).png

    Supplier Costs Report

    Screen-Shot-2020-08-12-at-11.13.10-am-1024x403 (1).png

    If there is a desire to implement API Sales for your PBJ instance, contact Client Success or send an email to support@poweredbyjumbo.com.

    Was this article helpful?
    0 out of 0 found this helpful