Professional Documents
Culture Documents
Passport Services Transaction Journal
Passport Services Transaction Journal
0
Passport Services API
Transaction Journal
Table of Contents
Passport Services 2
API Methods 2
Overview 2
WebOffice Access 2
Set Employee API Key 2
Example URL for GET Request 2
Transaction Journal 3
GET or POST Method 3
Sample Return Value: 3
Field Descriptions 5
1
Passport Services
ECRS Passport Services allows businesses to use their own third-party sources to input Customer, Store
Coupon, and Membership information into CATAPULT. Passport Services provides endpoints for:
● Exporting transaction data via Transaction Journal
● Creating new Customer records
● Managing and applying Store Coupons
● Creating and maintaining Membership Profiles
This API guide provides standard parameters for data being imported into and exported from CATAPULT.
API Methods
Overview
This manual covers the use of the Transaction Journal endpoint of ECRS Passport Services as well as
notes on accessing and controlling Employee access to Passport Services using WebOffice.
WebOffice Access
Reference the following notes on accessing API using WebOffice and providing API access to Employees:
● API access is only available at HQ
● API keys are used to authenticate access (set to individual Employees in WebOffice)
● API access will not be permitted from the internet; only requests from non-routable RFC1918
addresses
Set Employee API Key
CATAPULT 5.5 and Higher
In order to make any adjustments to data in CATAPULT, an API Key needs to be assigned to an Employee
through WebOffice. API Keys provide access to CATAPULT API programs, and allow employees to move
data in and out of CATAPULT. Select +Create New and WebOffice will automatically create a new API
Key for this Employee Record.
Any API Keys that were created in previous versions of CATAPULT using Advanced Settings will be
preserved and automatically applied to Employee Records.
Warning: API Keys DO NOT replicate between stores. If an employee has several API Keys assigned at
the HQ WebOffice, separate API Keys will need to be created at the Remote Stores in order to access
API programs.
CATAPULT 5.4 and Older
In order to make any adjustments to data in CATAPULT, an API Key needs to be assigned to an Employee
through an Advanced Setting. Once an API Key has been assigned to an Employee in CATAPULT, the
specified key may be used by multiple personnel to access Passport Services.
To provide an Employee with an API Key for authentication, create an Advanced Setting at the
Headquarters store with the following parameters:
2
Key: “Employee nn API KEY” (with no quotations and ensure to replace nn with the desired Employee ID
Number).
Value: (Desired API KEY)
Whatever you’ve entered in the “Value” field is now set as the specified employee’s API Key, and will be
used in all Passport Services.
Example URL for GET Request
Ensure that m
ethod-name is replaced with the desired API Method (Customer, TransactionJournal, etc):
https://myecrsid. catapultweboffice.com/api/method-name?
apikey=api-key¶meter1=value1
¶meter2=value2...
Note:
The Customer Method is not available in CATAPULT 5.4 or 5.4.1 by default.
Warning:
Passport Services are incompatible with cloud systems, and should only be used with systems inside the
Cardholder Environment due to security concerns.
Transaction Journal
The Transaction Journal endpoint enables you to obtain all available T-Log detail reporting data for a
range of transaction upload times by using the GET or POST method.
The field trn_uploadtime is used for both start and end time.This is useful if a site has a terminal that was
offline today, when the TLOG API is run tonight transactions at this terminal will not be pulled. If the API
used start/end time offline transactions would be missed. (We use this same functionality in GL as well to
prevent lost data).
GET or POST Method
Parameters (required parameters in bold)
string apikey This field contains a valid API key for an Employee who is not marked inactive
or terminated.
datetime startTime This field contains the start time. Only transactions which were inserted into
the HQ T-Log database after this will be included in the output. This time should
be in the following format: 2015-03-25T12:00:00 (ISO 8601).
datetime endTime This field contains the end time. Only transactions which were inserted into the
HQ T-Log database before this will be included in the output. This time should
be in the following format: 2015-03-25T12:00:00 (ISO 8601).
3
4
/>
<row TRN_PK="18049" TRN_CPK="1002" TRN_STO_FK="3"
TRN_STO_CFK="1000" TRN_StartTime="2016-01-06 10:44:05.990"
TRN_EndTime="2016-01-06 10:44:14.212"
TRN_ReceiptNumber="16030" TRN_Type="0"
TRN_EMP_FK="4" TRN_EMP_CFK="1000" TRN_SequenceNumber="16030"
TRN_TCF_FK="2" TRN_TCF_CFK="1002" TRN_AllVoid="0"
TRN_UploadTime="2016-01-06 10:44:14.317"
TRN_Status="0" TCF_Description="Flex"
TCF_Number="2" TCF_TerminalID="07325795"
EMP_Number="99" EMP_FirstName="Self "
EMP_LastName="Checkout " TLI_PK="1" TLI_LIT_FK="1"
TLI_StartTime="2016-01-06 10:44:05.981"
TLI_EndTime="2016-01-06 10:44:05.981"
TLI_Amount="1.1900" TLI_ReceiptAlias="Eternal Artesian Water"
TLI_Quantity="1.0000" TLI_ScanCode="608883000027"
TLI_TaxDifference=".0800" ExtendedPrice="1.1900"
ExtendedBasePrice="1.1900" CPT_Void="0"
DLI_Void="0" DLI_INV_FK="23" DLI_INV_CFK="1000"
ITI_AverageCost=".7600" ITI_EntryMethod="2"
ITI_Return="0" ITI_INV_FK="23" ITI_Void="0"
ITI_INV_CFK="1000" ITI_SellingPrice="1.1900"
ITI_BasePrice="1.1900" ITI_PriceLevel="1"
ITI_DiscountPriceOverride="1" DPT_Name="Beverage "
DPT_Number="5" DPT_OmitFromSales="0"
NTI_Void="0" CTI_Void="0" GCT_Void="0"
/>
Field Descriptions
Field Name Data Type Description
TRN_PK,
TRN_CPK Integer This is the unique identifier for all Transactions
TRN_STO_FK, This field points to the record for the Store in which the Transaction
TRN_STO_CFK Integer was completed.
5
This field contains the Date/Time the Transaction was finalized. This
field is used as the Transaction Time for all reporting purposes for the
TRN_EndTime Timestamp current Transaction
This field contains the Numeric value for Receipt Number from the
Terminal.This number is unique only to the specific Terminal where
TRN_ReceiptNu the Transaction was completed. This value rolls over to 1 when it
mber Integer reaches 999,999.
TRN_EMP_FK, This field points to the record for the Employee who finalized the
TRN_EMP_CFK Integer Transaction.
TRN_Sequence
Number Integer This field contains the numeric value for the Sequence Number
TRN_TCF_FK, This field points to the record for the Terminal where the Transaction
TRN_TCF_CFK Integer was completed.
This field is only valid if a Customer was associated with the current
TRN_CUS_FK, Transaction.This field points to the record for the Customer that was
TRN_CUS_CFK Integer associated with this Transaction.
TRN_UploadTim This field contains the Date and Time that the current record is sent
e Timestamp from the POS Terminal into the store database, based on Server time.
6
12 = Picking in Progress
TCF_Descriptio This field contains the name of the Terminal that the Transaction was
n Char(30) completed on
This field contains the number of the Terminal that the Transaction
TCF_Number Integer was completed on
This field contains the Unique identifier for the Terminal that the
TCF_TerminalID Char(8) Transaction was completed on
This field contains the Employee ID of the Cashier that was logged in
EMP_Number Integer when the Transaction was completed.
This field contains the First Name of the Cashier that was logged in
EMP_FirstName Char(30) when the Transaction was completed.
This field contains the Last Name of the Cashier that was logged in
EMP_LastName Char(30) when the Transaction was completed.
TLI_PK Integer This field contains the order of the Transaction items.
TLI_Amount Numeric(16,4) This field contains the dollar amount of the Transaction Line Item
TLI_ReceiptAlia
s varchar(50) This field contains the Receipt Alias for the Transaction Line Item
TLI_Quantity Numeric(12,3) This field contains the Quantity of each Line Item in the Transaction.
7
This field is only valid for Line Item types that refer to Inventory Items,
TLI_ScanCode varchar(50) using either the Item ID or Alternate ID.
TLI_TaxDifferen
ce Numeric (16,4) Field is currently not reliable data.
This field contains the Extended Price of Base Item that is sold.
ExtendedPrice Numeric (16,4) Note: U
se ExtendedBasePrice instead.
This field contains the Extended Base Price of the Base Item that is
sold.
Field Formula:
ExtendedBaseP
rice Numeric (16,4) Base Price × Alternate ID Item Count in Pkg × Unit Quantity Sold.
CTI_LIT_FK Integer This field is the link between Combo and Line Item
8
This field is only valid when TLI_LIT_FK = 4 for Discount Line Item.
0 or 1 value
0 = Don’t Consolidate
DIS_ReportCons
olidated Tiny Integer 1 = Consolidate
9
ITI_DiscountPric
eOverride Tiny Integer This field always contains a value of 1.
10
This field contains the Department ID for the current Inventory Item.
This will be the Department ID that was defined at the time the Item
DPT_Number Integer was sold.
0 or 1 value
0 = Sales Department
DPT_OmitFrom
Sales Tiny Integer 1 = Omit From Sales Department
NTI_Authorizati
onCode varchar(20) If applicable this field contains the authorization code for the Tender.
TRN_ETI_Accou
ntName Char(40) This field contains the Cardholder Name.
TRN_ETI_Accou
ntNumber Char(4) This field contains the last 4 digits of the card number.
TRN_ETI_CardT
ype Char(5) This field contains the Card Type.
TRN_ETI_Tende
rAmount Numeric(14,4) This field contains the amount Tendered to the Card.
11
NTI_FCExchang This field contains the Foreign Currency Exchange Rate at the time of
eRate Numeric(14,4) sale.
NTI_FCTenderA
mount Numeric (16,4) This field contains the Foreign Currency Amount tendered.
0 or 1 value
0 = Not Foreign Currency
NTI_ForeignCurr
ency Tiny Integer 1 = Foreign Currency
CTI_BonusAmo
unt Numeric (16,4) This field is valid when TLI_LIT_FK = 31 Vendor Coupon.
12
0 or 1 value
0 = Gift Card Line is Good
GCT_Void Tiny Integer 1 = Gift Card Line is Voided
LTN_Start1 varchar(32) This field contains the starting value for Lot Number range 1.
LTN_End1 varchar(32) This field contains the ending value for Lot Number range 1.
LTN_Start2 varchar(32) This field contains the starting value for Lot Number range 2.
LTN_End2 varchar(32) This field contains the ending value for Lot Number range 2.
LTN_Start3 varchar(32) This field contains the starting value for Lot Number range 3.
LTN_End3 varchar(32) This field contains the ending value for Lot Number range 3.
LTN_Start4 varchar(32) This field contains the starting value for Lot Number range 4.
LTN_End4 varchar(32) This field contains the ending value for Lot Number range 4.
LTN_Start5 varchar(32) This field contains the starting value for Lot Number range 5.
LTN_End5 varchar(32) This field contains the ending value for Lot Number range 5.
LTN_Start6 varchar(32) This field contains the starting value for Lot Number range 6.
LTN_End6 varchar(32) This field contains the ending value for Lot Number range 6.
LTN_AddtlRang
es long varchar This field contains values for any additional Lot Number ranges.
13
Changelog
14