Get Transactions

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Dropship

Dropship API
Shipments
Products
Invoices
Connections
Inventory
Developer Guide
Returns
Orders

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

GET

earn

get-transaction

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

profileId

string

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync. profileId is generated as part of the Enroll Member endpoint - POST /members.

startTimestampUTC

string

Start date of the selected date range (UTC format)

endTimestampUTC

string

End date of the selected date range (UTC format)

transactionExternalReference

string

External reference (name or ID) of the transaction like POS Order Id or Ecommerce Order Id.

transactionType

enum<string>

Refers to the different type of transaction activities on a member account such as Earn Transaction, Burn Transaction, Earn Reverse Transaction and so on

Available options:

EARN,

BURN,

EXPIRY,

EARN_REVERSE,

BURN_REVERSE,

ADJUSTMENT,

DEDUCT,

TRANSFER,

MERGE,

FORFEITED,

CONVERT,

UNMERGE

transactionCode

string

Transaction Code

offset

integer

Indicates the starting record number (within the total number of records) in the response. When no value is provided, the default value is 0.

limit

integer

Indicates the final record number (from the offset number) in the response. When no value is provided, the default value is 20.

Response

200 - application/json

Details of member transactions

status

integer

Status code of the call

message

string

Message corresponding to the call

Minimum length: 1

errors

object

Dictionary of lists with different number of errors or exceptions

data

object[]

data.profileId

string

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

data.transactionExternalReference

string

Order ID or receipt ID for a transaction (received from the store). This is needed to cancel or return an order.

data.transactionEntityReference

string

Transaction entity reference

Minimum length: 1

data.transactionCode

string

Transaction Code of the transaction.

data.transactionTypeExternalReference

string

External reference for the transaction type such as purchase, return, or exchange. Supports any string value as configured by the store.

data.transactionType

enum<string>

Refers to the different types of transaction activities on a member account such as Earn Transaction, Burn Transaction, Earn Reverse Transaction and so on

Available options:

EARN,

BURN,

EXPIRY,

EARN_REVERSE,

BURN_REVERSE,

ADJUSTMENT,

DEDUCT,

TRANSFER,

MERGE,

FORFEITED,

CONVERT,

UNMERGE

data.transactionActivityType

string

Configurable alias for the transactionType

data.transactionDateTime

string

Transaction time (UTC format)

data.totalAmountPaid

number

Total amound paid for transaction

data.totalTax

number

Total tax on transaction

data.discounts

object[]

data.discountValue

number

Discount amount on the transaction

data.transactionNetAmount

number

Net amount for transaction, after discounts

data.points

number

Points earned in the transaction

data.currentPointsBalance

number

Total points balance after the transaction

data.basePoints

number

Base points balance after the transaction

data.bonusPoints

number

Bonus points balance after the transaction

data.promotionalPoints

number

Promotional points balance after the transaction

data.transactionItems

object[]

data.activityTimestamp

string

Activity timestamp (in UTC format). An activity could be enrolling a member, making a transaction, etc.

data.transactionNumber

string

Transaction number. It is same as the transactionExternalReference and indicates a unique order ID or receipt ID.

data.reasonCode

string

Reason-code for transaction, if provided

data.reasonDescription

string

Transaction reason, if provided

data.deviceId

string

Device ID used to capture the transaction

data.issueAuditUser

string | null

Representative who issued the transaction.

data.cancelAuditUser

string | null

Representative who cancelled the transaction.

data.rewards

object[]

Represents the variable rewards details

Was this page helpful?

Reverse Earned Points Update Member