CATAPULT Cognition™ API

Download OpenAPI specification:Download

ECRS Support: support@ecrs.com URL: https://www.ecrs.com

The CATAPULT Cognition™ API Suite describes endpoints for retrieving data from the Cognition data warehouse.

Authentication

API Key in Header

In order to utilize any API methods, an API Key needs to be sent in the header of the request. Keys are provided by ECRS.

Security Scheme Type	API Key
Header parameter name:	X-ECRS-APIKEY

Overview

This document describes API endpoints of CATAPULT Cognition
Note that while we attempt to maintain backwards compatibility whenever possible this API is subject to change.

Name Indication (SNI) Required
Clients connecting to this API must support SNI (Server Name Indication) in their TLS implementation. SNI allows the server to present the correct certificate for the requested hostname.

PII Excluded
The Cognition API does not return personally identifiable information (PII) in the response. PII is defined as any data that could potentially identify a specific individual. This includes, but is not limited to, names, addresses, phone numbers, and email addresses.

Media Types
CATAPULT Cognition API operations support these response content-types in the request accept: header:

application/xml
application/json
text/csv
- Note: Availability exclusive to the transactionhistory endpoint.
- Note: 400 Bad Request responses will return as JSON for text/csv

API response content-type is determined by agent-driven, or client-based, content negotiation. Response content-type will default to JSON data format if the incoming request header does not describe a specific accept value.

Encoding Types
CATAPULT Cognition API operations support the following encoding types in the request accept-encoding: header:

gzip
deflate

gzip encoding is recommended for all API requests to reduce the size of the response payload.

Unique Identifiers
All customer, store, worksheet, and item identifiers are 64-bit integers. Each identifier is formed by combining two 32-bit integers: the pk column and the cpk column. This 64-bit value uniquely identifies each entity in the system.

Data Availability

Predictive Endpoints

DF3 predictions are available exclusively to clients with an active subscription to Cognition DF3. All other predictive endpoints require an active subscription to Cognition Artemis AI.
transactionhistory

Data should not be pulled for the current day. Historical data is available for any previous days. For the previous day, data should only be retrieved after 9:00 AM EST.

DemandFill™ 3.0

DF3

Gives back DF3 predictions for a list of items

header Parameters

X-ECRS-Auth-Acct required	string <hex> Example: 24723 The headquarters (HQ) DCLAccountId. This value is the same as the subdomain of your HQ Web Office URL. https://24723.catapultweboffice.com
X-ECRS-APIKEY required	string The API key for the account.

Request Body schema:
application/json
application/json
application/xml

store required	integer The unique store identifier for which recommendations are being requested.
start required	string <date> The beginning date of the requested demand prediction time series.
end required	string <date> The concluding date of the requested demand prediction time series.
items required	array <integer> Array of unique item identifiers for which demand predictions are requested.

Responses

Response Schema:
application/json
application/json
application/xml

Array of objects (Df3Item)

Request samples

Payload
Shell + Curl
Java + Nethttp
Go + Native
Javascript + Axios

Content type

{"store": 4294967296001,
"start": "2024-04-03",
"end": "2024-04-04",
"items": [4294967299330,
4294967299331
]
}

Response samples

Content type

{"items": [{"id": 4294967299330,
"predictions": [{"date": "2024-04-03",
"predictedLower": 0.2,
"predictedDemand": 2.4,
"predictedUpper": 3.2,
"source": "df3",
"score": -3.03525
},
{"date": "2024-04-04",
"predictedLower": 0.1,
"predictedDemand": 2.3,
"predictedUpper": 4.4,
"source": "df3",
"score": -1.05231
}
]
},
{"id": 4294967299331,
"predictions": [{"date": "2024-04-03",
"predictedLower": 0.1,
"predictedDemand": 2.2,
"predictedUpper": 3.9,
"source": "df3",
"score": -0.52323
},
{"date": "2024-04-04",
"predictedLower": 0.5,
"predictedDemand": 1.9,
"predictedUpper": 2.2,
"source": "df3",
"score": -5.6971
}
]
}
]
}

Recommendations

Similar

Gives back a list of similar items, sorted by (PK) ID representation. Within the array, recommendations are sorted in rank order.

header Parameters

X-ECRS-Auth-Acct required	string <hex> Example: 24723 The headquarters (HQ) DCLAccountId. This value is the same as the subdomain of your HQ Web Office URL. https://24723.catapultweboffice.com
X-ECRS-APIKEY required	string The API key for the account.

Responses

Response Schema:
application/json
application/json
application/xml

Array of objects (RecommendedItems)

Request samples

Shell + Curl
Java + Nethttp
Go + Native
Javascript + Axios

curl --request GET \
  --url https://cognition.ecrs.com/api/v1/predictive/recsys/similar \
  --header 'X-ECRS-APIKEY: SOME_STRING_VALUE' \
  --header 'X-ECRS-Auth-Acct: 24723'

Response samples

Content type

{"items": [{"id": 4294967296001,
"predictions": [{"id": 4294967296003,
"rank": 1
},
{"id": 4299262263298,
"rank": 2
}
]
},
{"id": 4299262263298,
"predictions": [{"id": 4294967296001,
"rank": 1
}
]
}
]
}

Gives back a list of related items, sorted by (PK) ID representation. Within the array, recommendations are sorted in rank order.

header Parameters

X-ECRS-Auth-Acct required	string <hex> Example: 24723 The headquarters (HQ) DCLAccountId. This value is the same as the subdomain of your HQ Web Office URL. https://24723.catapultweboffice.com
X-ECRS-APIKEY required	string The API key for the account.

Responses

Response Schema:
application/json
application/json
application/xml

Array of objects (RecommendedItems)

Request samples

Shell + Curl
Java + Nethttp
Go + Native
Javascript + Axios

curl --request GET \
  --url https://cognition.ecrs.com/api/v1/predictive/recsys/related \
  --header 'X-ECRS-APIKEY: SOME_STRING_VALUE' \
  --header 'X-ECRS-Auth-Acct: 24723'

Response samples

Content type

{"items": [{"id": 4294967296001,
"predictions": [{"id": 4294967296003,
"rank": 1
},
{"id": 4299262263298,
"rank": 2
}
]
},
{"id": 4299262263298,
"predictions": [{"id": 4294967296001,
"rank": 1
}
]
}
]
}

Customer

Gives back a list of recommended items that are relevant to a customer, sorted by rank. Items are reported with their PK as the id returned.

header Parameters

X-ECRS-Auth-Acct required	string <hex> Example: 24723 The headquarters (HQ) DCLAccountId. This value is the same as the subdomain of your HQ Web Office URL. https://24723.catapultweboffice.com
X-ECRS-APIKEY required	string The API key for the account.
customer required	integer Example: 4307852204315 The unique identifier (Primary Key) for a customer in the system. Must be a valid customer ID that exists in the system.
page	integer Example: 5 Controls pagination by specifying which page of results to return. Pages are zero-based, meaning the first page is 0. Used in conjunction with the 'size' parameter to implement pagination for large result sets. If not specified, defaults to page 0 (first page).
size	integer Example: 32 Specifies the maximum number of items to return per page in the response. This parameter helps control the response payload size and improve performance. If not specified, defaults to 32 items per page.

Responses

Response Schema:
application/json
application/json
application/xml

Array of objects (CustomerItemRecommendations)

Request samples

Shell + Curl
Java + Nethttp
Go + Native
Javascript + Axios

curl --request GET \
  --url https://cognition.ecrs.com/api/v1/predictive/recsys/customer \
  --header 'X-ECRS-APIKEY: SOME_STRING_VALUE' \
  --header 'X-ECRS-Auth-Acct: 24723' \
  --header 'customer: 4307852204315' \
  --header 'page: 5' \
  --header 'size: 32'

Response samples

Content type

{"predictions": [{"id": 4294967311325
},
{"id": 4294967312895
},
{"id": 4294967312546
}
]
}

Promotion

Gives back a list of recommended on sale items that are relevant to a customer, sorted by rank.

header Parameters

X-ECRS-Auth-Acct required	string <hex> Example: 24723 The headquarters (HQ) DCLAccountId. This value is the same as the subdomain of your HQ Web Office URL. https://24723.catapultweboffice.com
X-ECRS-APIKEY required	string The API key for the account.
customer required	integer Example: 4307852204315 The unique identifier (Primary Key) for a customer in the system. Must be a valid customer ID that exists in the system.
store required	integer Example: 4294967296001 The unique identifier (Primary Key) for a store in the system. Must be a valid store ID that exists in the system.
page	integer Example: 5 Controls pagination by specifying which page of results to return. Pages are zero-based, meaning the first page is 0. Used in conjunction with the 'size' parameter to implement pagination for large result sets. If not specified, defaults to page 0 (first page).
size	integer Example: 32 Specifies the maximum number of items to return per page in the response. This parameter helps control the response payload size and improve performance. If not specified, defaults to 32 items per page.

Responses

Response Schema:
application/json
application/json
application/xml

Array of objects (CustomerItemRecommendations)

Request samples

Shell + Curl
Java + Nethttp
Go + Native
Javascript + Axios

curl --request GET \
  --url https://cognition.ecrs.com/api/v1/predictive/recsys/promotion \
  --header 'X-ECRS-APIKEY: SOME_STRING_VALUE' \
  --header 'X-ECRS-Auth-Acct: 24723' \
  --header 'customer: 4307852204315' \
  --header 'page: 5' \
  --header 'size: 32' \
  --header 'store: 4294967296001'

Response samples

Content type

{"predictions": [{"id": 4294967311325
},
{"id": 4294967312895
},
{"id": 4294967312546
}
]
}

eCircular

Gives back a list of customers and recommended on sale items that are relevant to that customer, sorted by rank.

header Parameters

X-ECRS-Auth-Acct required	string <hex> Example: 24723 The headquarters (HQ) DCLAccountId. This value is the same as the subdomain of your HQ Web Office URL. https://24723.catapultweboffice.com
X-ECRS-APIKEY required	string The API key for the account.
worksheet required	integer Example: 4307852254284 The unique identifier (Primary Key) for a promotional sale worksheet. This ID references a specific promotional planning worksheet.
page	integer Example: 5 Controls pagination by specifying which page of results to return. Pages are zero-based, meaning the first page is 0. Used in conjunction with the 'size' parameter to implement pagination for large result sets. If not specified, defaults to page 0 (first page).
size	integer Example: 32 Specifies the maximum number of items to return per page in the response. This parameter helps control the response payload size and improve performance. If not specified, defaults to 32 items per page.

Responses

Response Schema:
application/json
application/json
application/xml

Array of objects (eCircularCustomer)

Request samples

Shell + Curl
Java + Nethttp
Go + Native
Javascript + Axios

curl --request GET \
  --url https://cognition.ecrs.com/api/v1/predictive/recsys/ecircular \
  --header 'X-ECRS-APIKEY: SOME_STRING_VALUE' \
  --header 'X-ECRS-Auth-Acct: 24723' \
  --header 'page: 5' \
  --header 'size: 32' \
  --header 'worksheet: 4307852254284'

Response samples

Content type

{"customer": [{"id": 4294967311325,
"item": [{"id": 4294967311325
},
{"id": 4294967312895
}
]
},
{"id": 4294967320513,
"item": [{"id": 4294967312546
},
{"id": 4294967312547
},
{"id": 4294967312548
}
]
}
]
}

Coupon

Gives back a customer and recommended coupons that are relevant to that customer, sorted by rank.

header Parameters

X-ECRS-Auth-Acct required	string <hex> Example: 24723 The headquarters (HQ) DCLAccountId. This value is the same as the subdomain of your HQ Web Office URL. https://24723.catapultweboffice.com
X-ECRS-APIKEY required	string The API key for the account.
customer required	integer Example: 4307852204315 The unique identifier (Primary Key) for a customer in the system. Must be a valid customer ID that exists in the system.
page	integer Example: 5 Controls pagination by specifying which page of results to return. Pages are zero-based, meaning the first page is 0. Used in conjunction with the 'size' parameter to implement pagination for large result sets. If not specified, defaults to page 0 (first page).
size	integer Example: 32 Specifies the maximum number of items to return per page in the response. This parameter helps control the response payload size and improve performance. If not specified, defaults to 32 items per page.

Responses

Response Schema:
application/json
application/json
application/xml

Array of objects (CouponCustomer)

Request samples

Shell + Curl
Java + Nethttp
Go + Native
Javascript + Axios

curl --request GET \
  --url https://cognition.ecrs.com/api/v1/predictive/recsys/coupon \
  --header 'X-ECRS-APIKEY: SOME_STRING_VALUE' \
  --header 'X-ECRS-Auth-Acct: 24723' \
  --header 'customer: 4307852204315' \
  --header 'page: 5' \
  --header 'size: 32'

Response samples

Content type

{"customer": [{"id": 4307852204315,
"coupon": [{"provider": "Incomm",
"id": "65315325"
},
{"provider": "Incomm",
"id": "44161235"
},
{"provider": "Inmar",
"id": "274855"
}
]
}
]
}

All Customer Coupon

Gives back a list of customers and recommended coupons that are relevant to a customer, sorted by rank order of how relevant a coupon is to the customer.

header Parameters

X-ECRS-Auth-Acct required	string <hex> Example: 24723 The headquarters (HQ) DCLAccountId. This value is the same as the subdomain of your HQ Web Office URL. https://24723.catapultweboffice.com
X-ECRS-APIKEY required	string The API key for the account.
page	integer Example: 5 Controls pagination by specifying which page of results to return. Pages are zero-based, meaning the first page is 0. Used in conjunction with the 'size' parameter to implement pagination for large result sets. If not specified, defaults to page 0 (first page).
size	integer Example: 32 Specifies the maximum number of items to return per page in the response. This parameter helps control the response payload size and improve performance. If not specified, defaults to 32 items per page.

Responses

Response Schema:
application/json
application/json
application/xml

Array of objects (CouponCustomer)

Request samples

Shell + Curl
Java + Nethttp
Go + Native
Javascript + Axios

curl --request GET \
  --url https://cognition.ecrs.com/api/v1/predictive/recsys/allcustomercoupon \
  --header 'X-ECRS-APIKEY: SOME_STRING_VALUE' \
  --header 'X-ECRS-Auth-Acct: 24723' \
  --header 'page: 5' \
  --header 'size: 32'

Response samples

Content type

{"customer": [{"id": 4294967311325,
"coupon": [{"provider": "InComm",
"id": "65315325"
},
{"provider": "InComm",
"id": "44161235"
},
{"provider": "Inmar",
"id": "274855"
}
]
},
{"id": 4294967330526,
"coupon": [{"provider": "InComm",
"id": "34524234"
},
{"provider": "InComm",
"id": "34534232"
},
{"provider": "Inmar",
"id": "875421"
}
]
}
]
}

Transaction History

The transactionhistory endpoint enables you to obtain all available transaction details and reporting data for a range of transaction ingest times.

When an ingestionStartTime and ingestionEndTime are entered in the request parameters, the transactionhistory query uses the timestamp from the CognitionUploadTime field to determine if a transaction should be included in the response. This is an important distinction as the CognitionUploadTime defines when a transaction record is inserted in the Cognition Date Warehouse. As such, transactions with a CognitionUploadTime timestamp after the startTime, and before the endTime, will be returned.

query Parameters

ingestionStartTime required	string Example: ingestionStartTime=2025-01-20T12:00:00-05:00 This parameter contains the ingestion start time. Only transactions which were inserted into the data warehouse after this will be included in the output. This time should be in the following format: yyyy-MM-dd'T'HH:mm:ss.sss'Z' (ISO 8601).
ingestionEndTime	string Default: "current time" Example: ingestionEndTime=2025-01-21T12:00:00-05:00 This parameter contains the ingestion end time. Only transactions which were inserted into the data warehouse before this will be included in the output. This time should be in the following format: yyyy-MM-dd'T'HH:mm:ss.sss'Z' (ISO 8601). The maximum time range between `ingestionStartTime` and `ingestionEndTime` can only be 26 hours.
TransactionStatus	integer Default: 0 Example: TransactionStatus=10 This parameter specifies a desired (and eligible) Transaction Status to filter the transactions returned from the `transactionhistory` endpoint. The following Transaction Statuses can be specified with this parameter: `0` = Finalized Transactions `1` = Training Mode `3` = Suspended Transactions `6` = Web Order Paid `7` = Web Order `10` = Order Pick Picking `11` = Order Pick Ready `12` = Picking in Progress `13` = Fuel Pay Inside `14` = Web Order Editing `15` = Merged If this query parameter is used but no Transaction Status code is specified, `0` will be used by default, which means only "Finalized Transactions" will be included in the response.
AllVoid	integer Default: 0 Example: AllVoid=1 This parameter allows you to filter for "All Void" transactions using the following options: `0` = This option will exclude All Void transactions from the response. `1` = This option will cause All Void transactions to be the only ones included in the response. If this query parameter is used but neither option is specified, `0` will be used by default, which means "All Void" transactions will be excluded from the response.

header Parameters

X-ECRS-Auth-Acct required	string <hex> Example: 24723 The headquarters (HQ) DCLAccountId. This value is the same as the subdomain of your HQ Web Office URL. https://24723.catapultweboffice.com
X-ECRS-APIKEY required	string The API key for the account.

Responses

Response Schema:
application/json
application/json
application/xml
text/csv

Array

TRN_PK	integer The unique identifier for a transaction.
TRN_STO_FK	integer The unique identifier for the store where the transaction was completed.
TRN_StartTime	string <date-time> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}... The date and time a transaction was started. Note: For accuracy, use `TRN_EndTime` if the specific transaction time is needed.
TRN_EndTime	string <date-time> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}... The date and time a transaction was finalized. This is used as the transaction time in all reporting processes.
TRN_ReceiptNumber	integer The numeric Receipt Number value generated by the terminal that processed the transaction. This number is unique to a specific terminal. Receipt Numbers will roll over to 1 after reaching 999,999.
TRN_Type	integer
TRN_EMP_FK	integer The unique identifier for the Employee who finalized the transaction.
TRN_SequenceNumber	integer The numeric value of the transaction Sequence Number, per the terminal where it was processed.
TRN_TCF_FK	integer The unique identifier for the terminal record of the completed transaction.
TRN_CUS_FK	integer The unique identifier for the customer associated with this transaction. Only valid if a customer record was actually associated with the transaction.
TRN_AllVoid	integer Whether or not the transaction has been voided by an All Void action. `0` = Normal Transaction `1` = Voided Transaction
TRN_UploadTime	string <date-time> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}... The date and time this transaction record is sent from the POS Terminal where it was processed and uploaded into the Catapult database. Based on time received by database server.
CognitionUploadTime	string <date-time> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}... The date and time this transaction record is sent from the Catapult HQ Database into the Cognition data warehouse. Recorded when the record is received by the data warehouse. Recorded and returned in UTC time.
TRN_Status	integer Returns the transaction status/state. Completed Transactions: `0` = Normal Sales Transaction `1` = Training Mode Transaction Pending Transactions: `2` = Checkpoint `3` = Suspended Sale `4` = Parked `5` = Resumed `6` = Web Order Paid `7` = Web Order `8` = Recalled `9` = Delete Pending `10` = Order Pick Picking `11` = Order Pick Ready `12` = Picking in Progress `13` = Fuel Pay Inside `14` = Web Order Editing `15` = Merged
TCF_Description	string <= 30 characters Name of the terminal that completed the transaction.
TCF_Number	integer Number of the terminal that completed the transaction.
TCF_TerminalId	string <= 8 characters The unique identifier of terminal where the transaction was completed.
EMP_Number	integer The Employee ID for the user (i.e. cashier) logged in to the terminal when the transaction was completed.
EMP_FirstName	string <= 30 characters The First Name of the user (i.e. cashier) logged in to the terminal when the transaction was completed.
EMP_LastName	string <= 30 characters The Last Name of the user (i.e. cashier) logged in to the terminal when the transaction was completed.
CUS_AccountNumber	string <= 16 characters The Customer ID of the customer record associated with the transaction. Only valid if a customer record was actually associated with the transaction.
CUS_FirstName	string <= 25 characters The First Name of the customer record associated with the transaction. Only valid if a customer record was actually associated with the transaction. Contains PII (Personally Identifiable Information) and is not available in Cognition.
CUS_LastName	string <= 25 characters The Last Name of the customer record associated with the transaction. Only valid if a customer record was actually associated with the transaction. Contains PII (Personally Identifiable Information) and is not available in Cognition.
CUS_Company	string <= 50 characters The Company from the customer record associated with the transaction. Only valid if a customer record was actually associated with the transaction.
TLI_PK	integer The itemized, sequenced identifier of an item in a transaction.
TLI_LIT_FK	integer Defines the type of line item referenced in a transaction line. TLI Type 32 Contains PII (Personally Identifiable Information) and is not available in Cognition. TLI Type definitions: 1 - Inventory Item (Normal Sale of any Inventory Item ) 2 - Tender (Tender associated with a Transaction) 3 - Tax 4 - Discount 5 - Item Correct (Item removed from sale) 6 - No Sale 7 - All Void 8 - No Tax 9 - Tax Mod Total 10 - Suspend 11 - Resume 12 - Tax Mod Indicator 13 - Recovered Transaction 14 - Totals Entry 15 - Return Merchandise (Return Transaction, identical to type 1) 16 - Customer Payment (Payment on House Charge Accounts) 17 - Change Tender 18 - Receipt Block 19 - Tender Correct (Tender removed from transaction) 20 - No Tax Total 21 - Reconciliation Action 22 - Tender Loan 23 - Tender Safe Drop 24 - Tender Mod Indicator 25 - Discount Total 26 - Discount Total Correct 27 - Paid Out 28 - Paid In 29 - Paid Out Correct 30 - Age Verification 31 - Vendor Coupon 32 - Credit Card Soft Check 33 - POS Prompt 34 - Salesperson (The Salesperson associated with a Transaction) 35 - Combo Total 36 - Combo Item 37 - Combo Removed 38 - WIC ID 39 - WIC Voucher Number 40 - WIC Voucher First Date 41 - WIC Voucher Last Date 42 - WIC Date Valid 43 - WIC Voucher Amount 44 - Prescription Info 45 - Signature Capture 46 - Electronic Gift Card 47 - Electronic Gift Card Info 48 - Buy Down Correct 49 - Buy Down 50 - Safe Drop Warning 51 - Loyalty 52 - Auto Transaction 53 - Paid In Correct 54 - Prepaid Cards 55 - Receipt Plug-in 56 - Cash Back 57 - Fuel Info 58 - Do Not Use / Type Not Used By Transaction Server 59 - Rewards 60 - Special Order 61 - Transaction Merge 62 - Return Limit Info 63 - Discount Card
TLI_StartTime	string <date-time> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}... This field contains the line item start time. Note: For accuracy, use `TRN_EndTime` as the indicator of a particular transaction time.
TLI_EndTime	string <date-time> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}... This field contains the line item end time. Note: For accuracy, use `TRN_EndTime` as the indicator of a particular transaction time.
TLI_Amount	number <double> The dollar amount for a line item of the transaction.
TLI_ReceiptAlias	string <= 33 characters The Receipt Alias for a line item of the transaction.
TLI_Quantity	number <double> The Quantity of a particular line item on the transaction.
TLI_ScanCode	string <= 14 characters The scancode/UPC of a line item on the transaction. Only valid for line items defined as Inventory Items. Conditionally returns either a base Item ID or an Alternate ID.
TLI_TaxDifference	number <double> Not currently recommended as reliable source of data.
ExtendedPrice	number <double> The extended price for a particular base line item sold in the transaction. Note: For accuracy, use `ExtendedBasePrice` instead.
ExtendedBasePrice	number <double> The extended base price of a particular line item sold in the transaction. Field Formula: `Base Price` × `Alternate ID Item Count in Pkg` × `Unit Quantity Sold`.
CTI_CMB_FK	integer
CTI_DiscountAmount	number <double>
CTI_SellingAmount	number <double>
CTI_TLI_FK_Item	integer The relational link between a combo and line item, where applicable.
CMB_Name	string <= 128 characters The name of a combo associated with a line item on the transaction, where applicable.
CPT_Void	integer Whether or not the charge payment, if used in the transaction, was accepted or voided. Only valid when `TLI_LIT_FK = 16` (Charge Payment). `0` = Charge Payment is not voided. `1` = Charge Payment is voided.
DLI_TypeDollar	integer Whether or not the line item discount, if applied in the transaction, was a dollar-based reduction. Only valid when `TLI_LIT_FK = 4` (Discount Line Item). `0` = Discount is not a dollar reduction. `1` = Discount is a dollar reduction.
DLI_TypePercent	integer Whether or not the line item discount was a percentage-based reduction. Only valid when `TLI_LIT_FK = 4` (Discount Line Item). `0` = Discount is not a percent reduction. `1` = Discount is a percent reduction.
DLI_LineItem	integer
DLI_DIS_FK	integer The unique identifier for the discount applied in the transaction, where applicable.
DLI_Void	integer Whether or not the particular discount line item was voided. Only valid when `TLI_LIT_FK = 4` (Discount Line Item). `0` = Discount Line Item is not voided. `1` = Discount Line Item is voided.
DLI_ApplyBeforeTax	integer Whether or not the discount is calculated before or after tax(es). Only valid when `TLI_LIT_FK = 4` (Discount Line Item). `0` = Discount is applied before tax. `1` = Discount is applied after tax. See also: Discount Generator (Applying Taxes).
DLI_Return	integer Whether or not the discount is a return. Only valid when `TLI_LIT_FK = 4` (Discount Line Item). `0` = Discount is applied in a normal sale. `1` = Discount is applied in a return.
DLI_INV_FK	integer The unique identifier for the particular base item on which the discount was applied. Only valid when `TLI_LIT_FK = 4` (Discount Line Item).
DLI_Automatic	integer Whether the discount is Manual or Automatic. Only valid when `TLI_LIT_FK = 4` (Discount Line Item). `0` = Manual Discount `1` = Automatic Discount
DLI_ASC_FK	integer The unique identifer of the Alternate ID of the item on which the discount was applied. Only valid when `TLI_LIT_FK = 4` (Discount Line Item). If applied to an Alternate ID line item, this returns the respective AdditionalScanCodes identifier particular to that Alternate ID item. If applied to a Base ID line item, this returns a `null` value.
DLI_InventoryLineItem	integer The transaction line item record which the discount applies to. Only valid when `TLI_LIT_FK = 4` (Discount Line Item).
DLI_ReportConsolidated	integer Whether or not the discount is to be consolidated in reports. Only valid when `TLI_LIT_FK = 4` (Discount Line Item). `0` = Discount is not consolidated. `1` = Discount is consolidated.
ITI_AverageCost	number <double> The average cost of the base item at the time of the transaction. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item).
ITI_EntryMethod	integer The method by which the line item was entered onto the transaction. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item). `1` = Item was manually entered. `2` = Item was scanned. `3` = Item was selected from Item Group Menu.
ITI_Return	integer Whether or not the line item is a return. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item). `0` = Line item was not a return (normal sale). `1` = Line item was a return.
ITI_INV_FK	integer The unique identifier of the base item that was sold/returned in the transaction. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item).
ITI_Void	integer Whether or not the sale of a particular base item was voided. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item). `0` = Sale of base item is not voided. `1` = Sale of base item is voided.
ITI_SellingPrice	number <double> The actual selling price of the base item after automatic discounts are applied. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item). Note: Does not include manual discounts, combos, promotions, etc.
ITI_BasePrice	number <double> The price of the base item before any automatic discounts or taxes are applied. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item).
ITI_ASC_FK	integer The unique identifer of the Alternate ID of the item that was sold/returned in the transaction. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item). For Alternate ID items, this returns the respective AdditionalScanCodes creator identifier particular to a Alternate ID line item. For Base ID line item, this returns a `null` value.
ITI_ASCQuantity	number <double> The item count within the defined package for an Alternate ID line item in the transaction, where applicable. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item).
ITI_PriceLevel	integer The Price Level of the item at the time of transaction sale. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item).
ITI_DiscountPriceOverride	integer
DPT_Name	string <= 30 characters The Department Name associated with the line item at the time of transaction sale. Only valid when `TLI_LIT_FK = 1` or `TLI_LIT_FK = 15` (Inventory Item).
DPT_Number	integer The Department ID for the department associated with a line item at the time of transaction sale.
DPT_OmitFromSales	integer `0` = Sales Department. `1` = Omit from Sales Department.
TTI_TAX_FK	integer The unique identifier for the applied tax record. Only valid when `TLI_LIT_FK = 3`.
TTI_ReturnTax	integer Whether the tax was applied in a normal sale or return. Only valid when `TLI_LIT_FK = 3`. `0` = Tax applied to normal sale item. `1` = Tax applied to a return item.
TTI_TaxableAmount	number <double> The taxable dollar amount of the transaction subtotal. Only valid when `TLI_LIT_FK = 3`.
NTI_TEN_FK	integer The unique identifier for the tender used on the transaction. Only valid when `TLI_LIT_FK = 2` (Tender Record).
NTI_AuthorizationCode	string <= 20 characters The authorization code for the tender used on the transaction, where applicable.
TRN_ETI_AccountName	string <= 40 characters The cardholder name, where applicable. Contains PII (Personally Identifiable Information) and is not available in Cognition.
TRN_ETI_AccountNumber	string <= 4 characters The last 4 digits of the card number used on the transaction.
TRN_ETI_CardType	string <= 5 characters The Card Type used on the transaction.
TRN_ETI_TenderAmount	number <double> The amount tendered to the card in the transaction.
NTI_TenderType	integer Defines the type of tender received as payment in the transaction. Only valid when `TLI_LIT_FK = 2` (Tender Record).
NTI_Amount	number <double> The amount tendered. Only valid when `TLI_LIT_FK = 2` (Tender Record).
NTI_Void	integer Whether the tendered transaction was voided. Only valid when `TLI_LIT_FK = 2` (Tender Record). `0` = Tender was not voided. `1` = Tender was voided.
NTI_SafeDrop	integer Whether or not this line item is a safe drop. Only valid when `TLI_LIT_FK = 23` (Safe Drop). `0` = No. `1` = Yes. Note: This will always return `1` when the line item type is set to safe drop. All other line item types return either `0` or `NULL`.
NTI_Loan	integer Whether or not this line item is a drawer loan. Only valid when `TLI_LIT_FK = 22` (Drawer Loan). `0` = No. `1` = Yes. Note: This will always return `1` when the line item type is set to drawer loan. All other line item types return either `0` or `NULL`.
NTI_FCExchangeRate	number <double> The Foreign Currency Exchange Rate at the time of sale.
NTI_FCTenderAmount	number <double> The Foreign Currency Amount tendered.
NTI_ForeignCurrency	integer Whether or not the transaction was tendered with a foreign currency. `0` = Not Foreign Currency. `1` = Foreign Currency.
TEN_PK	integer The unique identifier of the tender received for the transaction. References the Tenders table. Only valid when `TLI_LIT_FK = 2`.
TEN_Description	string <= 30 characters The description of the tender received for the transaction. Only valid when `TLI_LIT_FK = 2`.
CTI_BonusAmount	number <double> The total amount deducted from a line item by a vendor coupon. Only valid when `TLI_LIT_FK = 31` (Vendor Coupon).
CTI_EntryMethod	integer Whether the vendor coupon was keyed in as a POS function or scanned at the time of transaction. How Only valid when `TLI_LIT_FK = 31` (Vendor Coupon). `1` = Vendor Coupon POS Function. `2` = Scan. `3` = Coupon from a Third-Party provider, such as Inmar®.
CTI_Void	integer Only valid when `TLI_LIT_FK = 31` (Vendor Coupon). `0` = Coupon was not voided. `1` = Coupon was voided.
CTI_ManufacturerCode	string <= 5 characters The Coupon Manufacturer Code. Only valid when `TLI_LIT_FK = 31` (Vendor Coupon).
CTI_FamilyCode	string <= 3 characters The Coupon Family Code. Only valid when `TLI_LIT_FK = 31` (Vendor Coupon).
CTI_CouponCode	string <= 2 characters The Coupon Code. Only valid when `TLI_LIT_FK = 31` (Vendor Coupon).
SalespersonFK	integer The unique identifer for the employee designated as the the salesperson associated with the sale or return of an item, where applicable. Applies to normal sales, returns, and on associated discount lines items. Only valid when `TLI_LIT_FK = 1`, `TLI_LIT_FK = 4`, or `TLI_LIT_FK = 15`.
GCT_Void	integer `0` = Gift Card is not voided. `1` = Gift Card is voided.
LTN_Start1	string <= 32 characters This field contains the starting value for Lot Number range 1.
LTN_End1	string <= 32 characters This field contains the ending value for Lot Number range 1.
LTN_Start2	string <= 32 characters This field contains the starting value for Lot Number range 2.
LTN_End2	string <= 32 characters This field contains the ending value for Lot Number range 2.
LTN_Start3	string <= 32 characters This field contains the starting value for Lot Number range 3.
LTN_End3	string <= 32 characters This field contains the ending value for Lot Number range 3.
LTN_Start4	string <= 32 characters This field contains the starting value for Lot Number range 4.
LTN_End4	string <= 32 characters This field contains the ending value for Lot Number range 4.
LTN_Start5	string <= 32 characters This field contains the starting value for Lot Number range 5.
LTN_End5	string <= 32 characters This field contains the ending value for Lot Number range 5.
LTN_Start6	string <= 32 characters This field contains the starting value for Lot Number range 6.
LTN_End6	string <= 32 characters This field contains the ending value for Lot Number range 6.
LTN_AddtlRanges	string This field contains values for any additional Lot Number ranges.
TRN_Total	number <double> The transaction sales amount.
TRN_NetSales	number <double> The transaction sales amount after any modifiers.
TRN_ItemQuantity	number <double>
TRN_ItemCorrects	number <double>
TRN_Negatives	number <double>
StoreNumber	string <= 10 characters The store number where the transaction was completed.
TRN_ETI_Approval	string <= 20 characters
TRN_ETI_Reference	string <= 20 characters
TRN_ETI_RemainingBalance	number <double>
TRN_ETI_CvvResult	string <= 1 characters
TRN_ETI_AvsResult	string <= 1 characters
TRN_ETI_Bin	string <= 6 characters
TRN_ETI_AuthorizationDate	string <= 8 characters
TRN_ETI_AuthorizationTime	string <= 8 characters
TRN_ETI_AuthorizationType	string <= 20 characters
TRN_ETI_AuthorizationStan	string <= 6 characters
CTI_ApplyToFoodstamps	integer
CTI_ApplyToFSA	integer
CTI_CouponBarcode	string <= 100 characters
CTI_ProviderId	string <= 32 characters
CTI_FaceValue	number <double>
NTI_CHG_FK	integer
NTI_TLI_CashBack	integer
TLI_Divider	integer
ITI_BasePriceDivider	integer
ITI_PL1BasePriceDivider	integer
ITI_WeightEntryMethod	integer
ITI_TareEntryMethod	integer
ITI_Pl1BasePrice	number <double>
ITI_Pl1PromptForPrice	integer
ITI_TareWeight	number <double>
ITI_EmbeddedPrice	number <double>
ITI_SpecialPricing	integer
ITI_Variation	string <binary> Does not return at this time.
ITI_LinkType	integer
ITI_ModQuantity	number <double>
ITI_ModPrice	number <double>
ITI_EmbeddedDiscount	number <double>
ITI_FSA	integer
ITI_SNAP	integer
ITI_WeightUnit	integer
PromptName	string <= 30 characters The name of the cashier prompt activated in the transaction, where applicable.
PromptResponse	string <= 30 characters
PromptItem	integer The relational link between a prompt and line item, where applicable.
CTI_Expiration	string <date> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
ITI_MarkdownBarCode	string <= 64 characters
ITI_TLI_LinkLineItem	integer
ComboTotalLoyaltyProgram	string <= 32 characters
ComboTotalStoreCouponName	string <= 30 characters
CTH_Voided	integer
CTH_EarnedLoyalty	number <double>
LoyaltyTransactionLoyaltyProgram	string <= 32 characters
LoyaltyTransactionStoreCouponName	string <= 30 characters
LTI_Expiring	number <double>
LTI_ExpirationDate	string <date-time> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}...
CTI_ComboTotalLineItem	integer
ComboOmitFromSales	integer
CMB_ApplyAfterTaxes	integer
STI_Status	integer
EMD_SequenceNumber	integer
EMD_TransactionSequenceNumber	integer
EMD_Time	string <date-time> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}...
EMD_Tender	string <= 60 characters
EMD_TLI_FK	integer
EMD_5A	string <= 10 characters
EMD_82	string <= 4 characters
EMD_84	string <= 20 characters
EMD_9A	string <= 6 characters
EMD_9F21	string <= 6 characters
EMD_9C	string <= 2 characters
EMD_5F34	string <= 2 characters
EMD_5F2A	string <= 3 characters
EMD_9F02	string <= 12 characters
EMD_9F03	string <= 12 characters
EMD_9F08	string <= 4 characters
EMD_9F09	string <= 4 characters
EMD_9F1A	string <= 3 characters
EMD_9F33	string <= 32 characters
EMD_9F34	string <= 6 characters
EMD_9F35	string <= 2 characters
EMD_9F36	string <= 4 characters
EMD_9F37	string <= 10 characters
EMD_9F0D	string <= 10 characters
EMD_9F0E	string <= 10 characters
EMD_9F0F	string <= 10 characters
EMD_TACD	string <= 10 characters
EMD_TACO	string <= 10 characters
EMD_TACF	string <= 10 characters
EMD_95_1GEN	string <= 10 characters
EMD_9F10_1GEN	string <= 32 characters
EMD_9F26_1GEN	string <= 16 characters
EMD_9F27_1GEN	string <= 2 characters
EMD_91	string <= 20 characters
EMD_95_2GEN	string <= 10 characters
EMD_9F26_2GEN	string <= 16 characters
EMD_9F27_2GEN	string <= 2 characters
EMD_8A	string <= 4 characters
EMD_9B	string <= 4 characters
EMD_AppName	string <= 60 characters
EMD_CardEntryMethod	string <= 10 characters
EMD_CardVerMethod	string <= 10 characters
EMD_Mode	string <= 30 characters
EMD_9F06	string <= 32 characters
ITI_RetailAccountingPrice	number <double>
ITI_RetailAccountingReportCode	string <= 30 characters
GCT_GCP_FK	integer
GCT_Code	string <= 3 characters
GCT_Account	string <= 16 characters
GCT_SendDate	string <date-time> /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}... Date the gift card is sent to the recipient.
GCT_Print	integer
GCT_RecipientEmail	string <= 254 characters The gift card recipient e-mail address. Contains PII (Personally Identifiable Information) and is not available in Cognition.
GCT_RecipientPhoneNumber	string <= 14 characters The gift card recipient phone number. Contains PII (Personally Identifiable Information) and is not available in Cognition.
GCT_RecipientName	string <= 64 characters The gift card recipient full name. Contains PII (Personally Identifiable Information) and is not available in Cognition.
GCT_SenderName	string <= 64 characters The gift card sender first name. Contains PII (Personally Identifiable Information) and is not available in Cognition.
TRN_WTR_FK	integer
TRN_ETI_ExpDate	string <= 5 characters
TRN_ETI_CardSwiped	integer
TRN_ETI_Processor	string <= 20 characters
BaseItemID	string <= 14 characters
PriceChangeWorksheetName	string <= 40 characters
PriceChangeWrksheetSavings	number <double>
PriceChangeWrksheetLineSavings	number <double>

Request samples

Shell + Curl
Java + Nethttp
Go + Native
Javascript + Axios

curl --request GET \
  --url 'https://cognition.ecrs.com/api/v1/transactionhistory?ingestionStartTime=2025-01-20T12%3A00%3A00-05%3A00&ingestionEndTime=2025-01-21T12%3A00%3A00-05%3A00&TransactionStatus=10&AllVoid=1' \
  --header 'X-ECRS-APIKEY: SOME_STRING_VALUE' \
  --header 'X-ECRS-Auth-Acct: 24723'

Response samples

Content type

[{"TRN_PK": 4303557248640,
"TRN_STO_FK": 4294967296003,
"TRN_StartTime": "2016-01-06 10:37:20.870",
"TRN_EndTime": "2016-01-06 10:37:20.870",
"TRN_ReceiptNumber": 16029,
"TRN_Type": 0,
"TRN_EMP_FK": 4294967296004,
"TRN_SequenceNumber": 16029,
"TRN_TCF_FK": 4303557230594,
"TRN_CUS_FK": 4294967296002,
"TRN_AllVoid": 0,
"TRN_UploadTime": "2016-01-06 10:37:20.870",
"CognitionUploadTime": "2016-01-06 15:37:20.870",
"TRN_Status": 0,
"TCF_Description": "Terminal 1",
"TCF_Number": 1,
"TCF_TerminalId": "07325795",
"EMP_Number": 99,
"EMP_FirstName": "Self",
"EMP_LastName": "Checkout",
"CUS_AccountNumber": "4012345678900",
"CUS_FirstName": "Exempt - Contains PII",
"CUS_LastName": "Exempt - Contains PII",
"CUS_Company": "ECRS",
"TLI_PK": 1,
"TLI_LIT_FK": 1,
"TLI_StartTime": "2016-01-06 10:37:20.870",
"TLI_EndTime": "2016-01-06 10:37:20.870",
"TLI_Amount": 1.29,
"TLI_ReceiptAlias": "Widget",
"TLI_Quantity": 1,
"TLI_ScanCode": "212345678901",
"TLI_TaxDifference": 1.29,
"ExtendedPrice": 1.29,
"ExtendedBasePrice": 1.29,
"CTI_CMB_FK": 4294967296001,
"CTI_DiscountAmount": 1,
"CTI_SellingAmount": 2.29,
"CTI_TLI_FK_Item": 1,
"CMB_Name": "Dynamic Promotion",
"CPT_Void": 0,
"DLI_TypeDollar": 1,
"DLI_TypePercent": 0,
"DLI_LineItem": 3,
"DLI_DIS_FK": 4294967296001,
"DLI_Void": 0,
"DLI_ApplyBeforeTax": 0,
"DLI_Return": 0,
"DLI_INV_FK": 4294967296001,
"DLI_Automatic": 0,
"DLI_ASC_FK": 4294967296001,
"DLI_InventoryLineItem": 3,
"DLI_ReportConsolidated": 0,
"ITI_AverageCost": 1.29,
"ITI_EntryMethod": 1,
"ITI_Return": 0,
"ITI_INV_FK": 4294967296001,
"ITI_Void": 0,
"ITI_SellingPrice": 1.29,
"ITI_BasePrice": 1.29,
"ITI_ASC_FK": 4294967296001,
"ITI_ASCQuantity": 1,
"ITI_PriceLevel": 1,
"ITI_DiscountPriceOverride": 1,
"DPT_Name": "Grocery",
"DPT_Number": 99,
"DPT_OmitFromSales": 0,
"TTI_TAX_FK": 4294967296001,
"TTI_ReturnTax": 0,
"TTI_TaxableAmount": 1.29,
"NTI_TEN_FK": 4294967296001,
"NTI_AuthorizationCode": "02107D",
"TRN_ETI_AccountName": "Exempt - Contains PII",
"TRN_ETI_AccountNumber": "6825",
"TRN_ETI_CardType": "DEBIT",
"TRN_ETI_TenderAmount": 1.29,
"NTI_TenderType": 2,
"NTI_Amount": 1.29,
"NTI_Void": 0,
"NTI_SafeDrop": 0,
"NTI_Loan": 0,
"NTI_FCExchangeRate": 0.76,
"NTI_FCTenderAmount": 1.29,
"NTI_ForeignCurrency": 0,
"TEN_PK": 4294967296001,
"TEN_Description": "Cash",
"CTI_BonusAmount": 1.29,
"CTI_EntryMethod": 1,
"CTI_Void": 0,
"CTI_ManufacturerCode": "43300",
"CTI_FamilyCode": "243",
"CTI_CouponCode": "54",
"SalespersonFK": 4294967296001,
"GCT_Void": 0,
"LTN_Start1": "L100",
"LTN_End1": "L103",
"LTN_Start2": "L200",
"LTN_End2": "L203",
"LTN_Start3": "L300",
"LTN_End3": "L303",
"LTN_Start4": "L400",
"LTN_End4": "L403",
"LTN_Start5": "L500",
"LTN_End5": "L503",
"LTN_Start6": "L600",
"LTN_End6": "L603",
"LTN_AddtlRanges": "L700-L703 L800-L803 L900-L903",
"TRN_Total": 1.29,
"TRN_NetSales": 1.29,
"TRN_ItemQuantity": 1,
"TRN_ItemCorrects": 1,
"TRN_Negatives": 1,
"StoreNumber": "Store 1",
"TRN_ETI_Approval": "07357D",
"TRN_ETI_Reference": "0001001752412",
"TRN_ETI_RemainingBalance": 1.29,
"TRN_ETI_CvvResult": "S",
"TRN_ETI_AvsResult": "S",
"TRN_ETI_Bin": "425103",
"TRN_ETI_AuthorizationDate": "200415",
"TRN_ETI_AuthorizationTime": "092812",
"TRN_ETI_AuthorizationType": "SALE",
"TRN_ETI_AuthorizationStan": "015263",
"CTI_ApplyToFoodstamps": 1,
"CTI_ApplyToFSA": 0,
"CTI_CouponBarcode": "8110009921004560028011000090000",
"CTI_ProviderId": "gc:54524",
"CTI_FaceValue": 1,
"NTI_CHG_FK": 4294967296001,
"NTI_TLI_CashBack": 1,
"TLI_Divider": 1,
"ITI_BasePriceDivider": 1,
"ITI_PL1BasePriceDivider": 1,
"ITI_WeightEntryMethod": 1,
"ITI_TareEntryMethod": 1,
"ITI_Pl1BasePrice": 1.29,
"ITI_Pl1PromptForPrice": 1,
"ITI_TareWeight": 1,
"ITI_EmbeddedPrice": 1.35,
"ITI_SpecialPricing": 0,
"ITI_Variation": "0xff8c10af4a73f331e5b2dfd7eeef3530861c811f511699dd2330f2d3fbfc2a87",
"ITI_LinkType": 1,
"ITI_ModQuantity": 1,
"ITI_ModPrice": 1.29,
"ITI_EmbeddedDiscount": 0.1,
"ITI_FSA": 1,
"ITI_SNAP": 0,
"ITI_WeightUnit": 1,
"PromptName": "Terminal Prompt Name",
"PromptResponse": "999",
"PromptItem": 5,
"CTI_Expiration": "2017-01-06",
"ITI_MarkdownBarCode": "561631205656151",
"ITI_TLI_LinkLineItem": 3,
"ComboTotalLoyaltyProgram": "Default Program",
"ComboTotalStoreCouponName": "Store Coupon",
"CTH_Voided": 0,
"CTH_EarnedLoyalty": 1.2,
"LoyaltyTransactionLoyaltyProgram": "Default Program",
"LoyaltyTransactionStoreCouponName": "Store Coupon",
"LTI_Expiring": 124.02,
"LTI_ExpirationDate": "2017-01-06 10:37:20.870",
"CTI_ComboTotalLineItem": 12,
"ComboOmitFromSales": 1,
"CMB_ApplyAfterTaxes": 1,
"STI_Status": 0,
"EMD_SequenceNumber": 3,
"EMD_TransactionSequenceNumber": 1,
"EMD_Time": "2017-01-06 10:37:20.870",
"EMD_Tender": "Credit Card",
"EMD_TLI_FK": 1,
"EMD_5A": "1275",
"EMD_82": "5328",
"EMD_84": "A0000000480840",
"EMD_9A": "200617",
"EMD_9F21": "117522",
"EMD_9C": "00",
"EMD_5F34": "00",
"EMD_5F2A": "842",
"EMD_9F02": "000000211610",
"EMD_9F03": "000000000000",
"EMD_9F08": "4534",
"EMD_9F09": "008C",
"EMD_9F1A": "846",
"EMD_9F33": "E0B8C8",
"EMD_9F34": "1D0002",
"EMD_9F35": "22",
"EMD_9F36": "00DF",
"EMD_9F37": "5F197DA0",
"EMD_9F0D": "45145",
"EMD_9F0E": "5564",
"EMD_9F0F": "54344",
"EMD_TACD": "2345",
"EMD_TACO": "564",
"EMD_TACF": "3425",
"EMD_95_1GEN": "2345",
"EMD_9F10_1GEN": "06010C03A01000",
"EMD_9F26_1GEN": "2343",
"EMD_9F27_1GEN": "34",
"EMD_91": "6EA349FB35449BC53030",
"EMD_95_2GEN": "8010018800",
"EMD_9F26_2GEN": "41763C452C0E0566",
"EMD_9F27_2GEN": "80",
"EMD_8A": "5640",
"EMD_9B": "6400",
"EMD_AppName": "US DEBIT",
"EMD_CardEntryMethod": "CR",
"EMD_CardVerMethod": "01",
"EMD_Mode": "Issuer",
"EMD_9F06": "A0000000510840",
"ITI_RetailAccountingPrice": 1.29,
"ITI_RetailAccountingReportCode": "13",
"GCT_GCP_FK": 4294967296001,
"GCT_Code": "624",
"GCT_Account": "8512385156",
"GCT_SendDate": "2017-01-06 10:37:20.870",
"GCT_Print": 1,
"GCT_RecipientEmail": "Exempt - Contains PII",
"GCT_RecipientPhoneNumber": "Exempt - Contains PII",
"GCT_RecipientName": "Exempt - Contains PII",
"GCT_SenderName": "Exempt - Contains PII",
"TRN_WTR_FK": 4294967296001,
"TRN_ETI_ExpDate": "0219",
"TRN_ETI_CardSwiped": 3,
"TRN_ETI_Processor": "Card Processor",
"BaseItemID": "4011",
"PriceChangeWorksheetName": "Promo Worksheet",
"PriceChangeWrksheetSavings": 2,
"PriceChangeWrksheetLineSavings": 1
}
]

CATAPULT Cognition™ API

Authentication

API Key in Header

Overview

DemandFill™ 3.0

DF3

header Parameters

Request Body schema: application/jsonapplication/jsonapplication/xml

Responses

Response Schema: application/jsonapplication/jsonapplication/xml

Request samples

Response samples

Recommendations

Similar

header Parameters

Responses

Response Schema: application/jsonapplication/jsonapplication/xml

Request samples

Response samples

Related

header Parameters

Responses

Response Schema: application/jsonapplication/jsonapplication/xml

Request samples

Response samples

Customer

header Parameters

Responses

Response Schema: application/jsonapplication/jsonapplication/xml

Request samples

Response samples

Promotion

header Parameters

Responses

Response Schema: application/jsonapplication/jsonapplication/xml

Request samples

Response samples

eCircular

header Parameters

Responses

Response Schema: application/jsonapplication/jsonapplication/xml

Request samples

Response samples

Coupon

header Parameters

Responses

Response Schema: application/jsonapplication/jsonapplication/xml

Request samples

Response samples

All Customer Coupon

header Parameters

Responses

Response Schema: application/jsonapplication/jsonapplication/xml

Request samples

Response samples

Transaction History

Transaction History

query Parameters

header Parameters

Responses

Response Schema: application/jsonapplication/jsonapplication/xmltext/csv

Request samples

Response samples

Request Body schema:
application/json
application/json
application/xml

Response Schema:
application/json
application/json
application/xml

Response Schema:
application/json
application/json
application/xml

Response Schema:
application/json
application/json
application/xml

Response Schema:
application/json
application/json
application/xml

Response Schema:
application/json
application/json
application/xml

Response Schema:
application/json
application/json
application/xml

Response Schema:
application/json
application/json
application/xml

Response Schema:
application/json
application/json
application/xml

Response Schema:
application/json
application/json
application/xml
text/csv