Transaction Log API

GET https://services.onlinesales.ai/osBillingServiceV2/marketplace/transactions

Request Body

Name	Type	Description
token*	String	Valid app token shared by Onlinesales.ai *note: do not use this token in any application on the client side.
merchantType*	String	Merchant type of the merchant for which the transaction is being carried out. Expected Values: brand seller.
merchantId*	String	Merchant id of seller / brand. Merchant should be a valid merchant in OS systems.
marketplaceClientId*	Integer	Unique client id defined by OS for the marketplace. It will be different for staging and production. Expected Values: Shared by OS
filters*	String	Includes the date range and the transaction type to fetch the transaction logs

Request Body

{
    "token": <token> <Token shared by onlinesales>,
    "merchantType" : "seller",
    "merchantId" : "8979879123",
    "marketplaceClientId": <Marketplace Client Id>,
    "filters" : {
        "fromDate" : "",
        "toDate" : "",
        "transactionTypes" : ["CREDIT","SPEND"],
    }
}

Sample Response

{
    "clientId": 372253,
    "merchantId" : "",
    "offset": 0,
    "limit": 500,
    "results": [
        {
            "transactionId": "414364981_xq",
            "currency": "USD",
            "amount": 100.0,
            "transactionDate": 1653921708000,
            "transactionType": "CREDIT"
        },
        {
            "transactionId": "wgev414364988dfwe9",
            "currency": "USD",
            "amount": 1.108421,
            "transactionDate": 1658102400000,
            "transactionType": "SPEND"
        }
    ]
}

Response Field Description

Field	Data Type	Description
client ID	Integer	OS ID created for merchant
merchant ID	Integer	Marketplace merchant ID
offset	Integer	Retrieve a subset of transactions starting with the offset value.
limit	Integer	The number of transactions that have to be fetched.
transaction ID	String	Transaction ID for the transaction at the marketplace side. OS will handle duplicates using this ID.
currency	String	Currency in which the transaction has taken place
amount	Double	Amount of the transaction that has taken place.
transactionDate	Epoch time (Date and Month)	Date on which the transaction has taken place.
transactionType	String	Type of transaction taking place. For example :- Credit, Debit, Spend etc.