Skip to main content
GET
Retrieve a vendor channel's profit and loss

Authorizations

x-api-key
string
header
required

Query Parameters

channelId
string
required

Channel (store) ID. Must be an Amazon Vendor channel.

merchantId
string
required

Merchant ID that owns the channel. URL-encode values containing spaces or '@'.

fromDate
integer

Start of the range as Unix epoch seconds. Defaults to 30 days before now.

toDate
integer

End of the range as Unix epoch seconds. Defaults to now. Must not be before fromDate or more than 3 months after it.

timezone
string
required

IANA timezone string, for example Australia/Sydney.

sellType
enum<string>
required

SELL_OUT reports Amazon's sales of your products to its customers. SELL_IN reports your sales to Amazon through purchase orders.

Available options:
SELL_IN,
SELL_OUT
groupBy
enum<string>

month (SELL_IN or SELL_OUT) adds a months array with one entry per calendar month the range touches. vendorCode (SELL_IN only) adds a vendorCodes array with one entry per vendor code.

Available options:
month,
vendorCode
includeBreakdown
boolean
default:false

When true, adds deductionBreakdown and chargebackBreakdown (amounts by type) to the totals and to each months or vendorCodes entry.

snsUnitsInterval
enum<string>
default:week

Reporting period for snsUnits. Amazon reports Subscribe & Save units by whole week or whole month. Only affects snsUnits, so it is ignored for SELL_IN.

Available options:
week,
month

Response

Successful operation

data
object
required

Profit and loss figures for one sell type. Fields marked SELL_OUT only or SELL_IN only are omitted for the other sell type.

meta
object
required