Delivery Types: Transactions

Download as pdf or txt
Download as pdf or txt
You are on page 1of 3

Delivery Types Page 1 of 3

The Enabler SDK Reference

Delivery Types
Collapse All

Getting Started with the API > Delivery Types

Enabler assigns each Fuel Transaction (Delivery) a DeliveryType to indicate:

l How the delivery was authorised.


l The current status of the delivery (e.g. cleared or not).
l How the delivery was cleared (sold).

Refer to the Transactions topic for guidance on writing application code to handle or classify fuel transactions.

As well as being visible in the Enabler API, the Delivery Type is also used in the Enabler Database (Hose_Delivery table) to
indicate the type of each delivery recorded.

Seen Situation this


Name Value Description
Where Occurs
CURRENT_DELIVERY 1 An unsold delivery, visible on the pump icon API + Normal delivery
as the "current delivery". Database has completed
but not yet sold.

STACKED_DELIVERY 2 An unsold delivery, pushed into the stack on API + Current delivery
the pump icon. Database that has been
stacked.

AVAILABLE_PREAUTH_DELIVERY 3 An unsold preauth delivery, visible on the API + When using


pump icon Database Legacy Preauths.

AVAILABLE_PREPAY_REFUND_DELIVERY 4 An available prepay refund, visible at the API + When a Prepay


API/Icon. This is a "virtual" delivery Database is done but less
representing the amount of fuel not delivered than the full
in a prepay, i.e. the amount to be refunded to amount was
the customer. delivered at the
pump.
A prepay refund delivery object will have the
following property values:

   Value = Money value of prepay 
that was not delivered
  Volume = 1.0
   Price = Value

This type changes to


PREPAY_REFUND_DELIVERY once cleared
(refunded to the customer).

POSTPAY_DELIVERY 5 A completed delivery cleared in the Enabler Database A post-pay


V4 API by calling: delivery is
marked as
Transaction.Clear( Normal ); cleared.
or using the ActiveX API method:

Delivery.Clear()

ms-its:C:\Enabler\SDK\Doc\Enabler Developers Reference.chm::/Delivery Types.html 4/16/2020


Delivery Types Page 2 of 3

MONITOR_DELIVERY 6 A delivery automatically authorised and Database If you setup a


cleared by the Pump Server. Site Mode using
"Monitor"
mode.

PREAUTH_DELIVERY 7 A delivery cleared by calling the ActiveX Database If you use


method: Legacy Preauths.

Delivery.ClearPreauth()

PREPAY_DELIVERY 8 A delivery authorised using the ActiveX Database If you use


method: Legacy Prepay.

Pump.AuthorisePrepay()

Deliveries of this type are cleared


automatically by the Pump Server.

PREPAY_REFUND_DELIVERY 9 A prepay refund that has been cleared - Database If you use
marked as paid back to the customer. Legacy Prepay.

PREPAY_REFUND_LOST_DELIVERY 10 A prepay refund that was cleared Database If you use


automatically by Pump Server after the Legacy Prepay.
configured timeout period. The Enabler API
considers this a 'lost' refund because the
customer did not receive their refund.

TEST_DELIVERY 11 A delivery cleared in the Enabler V4 API by Database Pump deliveries


calling: cleared/makred
as unsold - the
Transaction.Clear( Test ); pump delivered
Or using the ActiveX API method: was a test and
returned to the
Delivery.ClearTestDelivery storage tank.

DRIVEOFF_DELIVERY 12 A delivery cleared in the Enabler V4 API by Database Deliveries


calling: cleared/marked
as unsold - the
Transaction.Clear( DriveOff ); customer drove
Or using the ActiveX API method: off without
paying.
Delivery.ClearDriveOff

ATTENDANT_DELIVERY 13 A cleared delivery that was authorised for an Database If you use
attendant (automatically based on Site Mode Enabler's
and an Attendant logon), or by a client Attendant
application calling: functionality.

Pump.Authorise

With a an AttendantID.

OFFLINE_DELIVERY 14 This type indicates an unexpected change in Database Pump meter


electronic totals. One cause of this is if the totals changed
pump was changed to stand-alone unexpectedly
(disconnected) mode and then deliveries were when Enabler is
done; when the pump is reconnected an restarted or

ms-its:C:\Enabler\SDK\Doc\Enabler Developers Reference.chm::/Delivery Types.html 4/16/2020


Delivery Types Page 3 of 3

offline delivery for the total of the standalone communication


deliveries will be logged. resumes after
the pump was
It may also be caused by the pump having offline.
totals are only accurate to the nearest while
number instead of matching the volume
display format, or bugs in the pump or
Enabler system. This should not normally
occur. If it happens regularly, please contact
ITL support for help.

REINSTATED_DELIVERY 15 A previously cleared delivery that has been API + If you reinstate a
returned to the API/Icon for refund/resale. Database previously
cleared delivery.
Enabler V4 clients can use the new lookup
transaction facility instead:

Forecourt.GetTrasactionById

Forecourt.GetTranasctionByReference

Happens when you call the ActiveX API


method:

Pump.ReinstateDelivery

See Also
.NET FuelTransaction.DeliveryType Property
.NET DeliveryTypes Enumeration
COM DeliveryTypes Enumeration
COM Tranasction.DeliveryType Property
.NET Transaction Class

Send Feedback

ms-its:C:\Enabler\SDK\Doc\Enabler Developers Reference.chm::/Delivery Types.html 4/16/2020

You might also like