Exports / Imports
      Back to home
      1. Swiftpos Help Guides
      2. 3rd Party Integrations
      3. Exports / Imports

      Swiftpos Sales

      3rd Party Integration with swiftpos NetPOS

      Refer HERE for Support information.

      Subjects      ▲ ▼

       

       

      About      ▲ ▼

       

      What Is It?      ▲ ▼

      Used as a generic export of swiftpos sales transaction data to a 3rd Party Integrator provided endpoint URL. Once configured and implemented the NetPOS Swiftpos Sales interface will send sales transactions at intervals depending on the Processing Interval configured HERE.

       

      What Is Required?      ▲ ▼

      • Swiftpos v10.76.15+
      • A NetPOS registration that includes the Swiftpos Sales interface.
      • Single Transaction Sales Mode. 

       

      When Is It Used?      ▲ ▼

      Used when 3rd Party Integrators may want to import generic swiftpos sales transaction data instead of making use of swiftpos API calls. 

       

      How To?      ▲ ▼

       

      How To GET STARTED?      ▲ ▼

      This outlines the information and steps that are needed to familiarise oneself with, when implementing the NetPOS Swiftpos Sales integration at a Venue. Do as follows:

       

      intf-swiftpos-sales-2

       

      • In NetPOS
        • Obtain the 3rd Party's Callback URL and authentication credentials and enter them as is appropriate in the Swiftpos Sales Settings screen.
        • Configure the remaining setting as is appropriate for the Venue and save the changes.

       

      How To Use It?      ▲ ▼

      Once configured, it is pretty much set and forget. Going forward all sale transaction data will automatically be sent to the 3rd Party Integrator's provided endpoint (Callback URL).

       

      Sample Of Exported Sales Data      ▲ ▼

      Data is exported will appear similar to the sample below:

       

      [
        {
          Id: 123,
          ExternalId: "ABC123",
          TransactionType: 123, -- 0 Normal | 100 Cancelled | etc...
          ReceiptDateTime: "YYYY-MM-DDTHH24:MM:SS:F",
          SaleType: "EatIn",
          Venue: "Venue",
          Location: "Location",
          Terminal: 123,
          Clerk: 123,
          Items: [
            {
              PLU: "123",
              Quantity: 1.0,
              Price: 2.22,
              TotalExcludingGst: 1.998,
              TotalIncludingGst: 2.22
            }
          ],
          Media: [
            {
              Id: 123,
              Amount: 2.22,
              RoundedAmount: 2.20
            }
          ]
        }
      ]

       

      Screens      ▲ ▼

       

      Swiftpos Sales Settings Screen      ▲ ▼

       

      intf-swiftpos-sales-1-1

       

      This screen is accessed from HERE and is used to configure the NetPOS Swiftpos Sales interface.

      • NetPOS Access Code - Displays/Enter the access code.
      • Callback URL - Displays/Enter the URL to post the sales transactions to.
      • Authentication Mode - Select from the following:
        • Basic
          • Username / Password - Displays/Enter the username and password required when the Basic option is selected. The username and password is provided by the 3rd Party Integrator to ensure authentication and access to the Callback URL provided.
        • Bearer
          • Token - Displays/Enter the token required when the Bearer option is selected. The Token is provided by the 3rd Party Integrator to ensure authentication and access to the Callback URL provided.
      • Back Office Interface - Select the appropriate SwiftPOS Back Office option from the drop-down list.

       

      Notes ...

       

      If a Venue has more than one Back Office applications installed, then ensure the correct one is selected. For Venues running one Back Office application, then the SwiftPOS Back Office option MUST always be selected.

       

      • Send Sales - Select one of the following:
        • Individually - Select to ensure sales transactions are individually sent.
        • In Batch - Select to ensure sales transactions are batched before sending. 

       

      Notes ...

       

      A batch consists of a maximum of 50 sales transactions. However, if there is only 20 transactions ready to send, it will send 20 in the batch. If there is 75 transactions ready to send, it will send two batches. One consisting of 50 and one of 25.

       

      • Retry Failed Transactions - Select to resend failed transactions.
      • Remove Failed Transactions - Select to remove failed transactions from the NetPOS database.

       

      End of article      ▲