Skip to main content
POST
/
profitability
/
storeProfitAndLoss
Get a store profit and loss
curl --request POST \
  --url https://mm-api.merchantspring.io/profitability/storeProfitAndLoss \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "channelId": "<string>",
  "merchantId": "<string>",
  "reportOptions": {
    "fromDate": 123,
    "toDate": 123,
    "timezone": "<string>",
    "includeTax": true
  }
}
'
{
  "totalRevenue": 123,
  "totalExpenses": 123,
  "sales": 123,
  "advertisingSpend": 123,
  "sellingFees": 123,
  "shippingFees": 123,
  "refunds": 123,
  "reimbursements": 123,
  "otherIncome": 123,
  "promotions": 123,
  "refundsAndReturnsOverheads": 123,
  "cogs": 123,
  "otherExpenses": 123
}

Authorizations

x-api-key
string
header
required

Body

application/json

Store profit and loss criteria

Fetch a stores profit and loss in raw json

channelId
string
required
merchantId
string
required
reportOptions
object
required

Response

Successful operation

Fetch a store's profit and loss in raw json

totalRevenue
number
totalExpenses
number
sales
number
advertisingSpend
number
sellingFees
number
shippingFees
number
refunds
number
reimbursements
number
otherIncome
number
promotions
number
refundsAndReturnsOverheads
number
cogs
number
otherExpenses
number