Orders

 

Foreword

AT Internet’s SDK allows you to tag orders placed by your users while using your application.

 

Get off to a good start

Once your tag is initialised, you can add order information to your screen hit.

If you want to use variables, be sure to import ATInternet, Tracker, Screen and Order classes in your Activity (If you wish to send cart information, please also remember to import Cart).

 

Tagging

The Screen object makes an Order method available. This method takes two parameters :

  • orderId of type String indicates order identifier
  • turnover of type double indicates order turnover

This method sends back an Order-type object.

 

Tagging examples

  1. Tagging an order and a main goal screen

    Without the SalesTracker option

    Even without the SalesTracker option enabled, you can measure the order confirmation screen (main goal) and insert the order total (turnover) as well as the order number (orderId).

    With SalesTracker option

  2. Tagging an order with cart information

    For more information on tagging your cart, please visit this page: Cart (SalesTracker)

  3. Tagging an order confirmation screen on an app or external site

    The goal here is to be able to measure completed orders and reservations, despite the fact that the confirmation screen is hosted by an app or on an external site (like banking platforms, PayPal…).

    The tag must be placed on the screen preceding the user’s detour toward the banking or payment platform (the screen containing all information about the order/reservation and its content).

  4. Tagging an order with the addition of custom variables

 

Order class

 

Properties

Name Type Default value Description
orderId String Empty string Gets or sets the order ID
turnover Double -1.0 Gets or sets the order revenue/turnover
status Int -1 Gets or sets the order status
discount OrderDiscount null Gets or sets discount information
amount OrderAmount null Gets or sets total amount information
delivery OrderDelivery null Gets or sets delivery information
customVariables OrderCustomVars null Gets or sets custom variables
isNewCustomer Boolean false Gets or sets if the user is a new customer or not
paymentMethod Int -1 Gets or sets the payment method
isConfirmationRequired Boolean false Gets or sets whether the order is awaiting confirmation from an external site (bank, PayPal…)
 

Classe OrderAmount

 

Properties

Name Type Default value Description
amountTaxFree Double -1.0 Gets or sets the order total (without tax)
amountTaxIncluded Double -1.0 Gets or sets the order total (with tax)
taxAmount Double -1.0 Gets or sets the tax amount
 

Methods

Name Return type Description
set Order Includes information about the order total
 

Classe OrderDiscount

 

Properties

Name Type Default value Description
discountTaxFree Double -1.0 Gets or sets the discount total (without tax)
discountTaxIncluded Double -1.0 Gets or sets the discount total (with tax)
promotionalCode String null Gets or sets the promotional code used by the user
 

Methods

Name Default value Description
set Order Includes information about the discount total
 

Classe OrderDelivery

 

Properties

Name Type Default value Description

shippingFeesTaxFree

Double -1.0 Gets or sets the shipping total (without tax)

shippingFeesTaxIncluded

Double -1.0 Gets or sets the shipping total (with tax)

deliveryMethod

String null Gets or sets the shipping mode
 

Methods

Name Return type Description
set Order Includes shipping information
 

Classe OrderCustomVar

 

Properties

Name Type Default value Description

varId

Int 0 Gets or sets the variable ID

value

String null Gets or sets the variable value
 

Appendix

 

Identifiers for payment methods and order statuses

Below label/identifier correspondences for payment methods.
It is possible to enrich this list with your own payment methods in configuration part of your interface.

Identifier Label Category
1 Credit card Bank cards
2 Visa Bank cards
3 MasterCard Bank cards
4 Cheque Cheque
5 Store credit cards Credit cards
6 Financing Credit cards
7 Wire transfer Bank transfer
8 Direct debit Direct debit
9 PayPal Electronic money

Below label/identifier correspondences for order statuses.

Identifier Label
0 No information
1 Pending
2 Cancelled
3 Approved
4 Returned
Was this post helpful?
Yes
No
Last update: 05/04/2018