Skip to main content
GET
Retrieve profit and loss per ASIN for a vendor channel

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, and the range must not exceed 31 calendar days in the request timezone.

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
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
searchText
string

Optional text to match product titles or ASINs.

sortKey
enum<string>

Field to sort by (default shippedCogs for SELL_OUT, netReceipts for SELL_IN). shippedCogs and shippedUnits are SELL_OUT only; netReceipts, receivedUnits, cancelledUnits, rejectedUnits, cancelledValue and rejectedValue are SELL_IN only. A key for the other sell type returns 400.

Available options:
shippedCogs,
shippedUnits,
netReceipts,
receivedUnits,
cancelledUnits,
rejectedUnits,
cancelledValue,
rejectedValue,
advertisingSpend,
inventoryQuantity,
chargebacks,
cogs,
deductions,
totalExpenses,
totalProfit
sortOrder
enum<string>
default:desc

Sort direction (default desc).

Available options:
asc,
desc
pageIndex
integer
default:0

Zero-based page index (default 0).

Required range: x >= 0
pageSize
integer
default:20

Number of ASINs per page (default 20, max 50).

Required range: 1 <= x <= 50

Response

Successful operation

data
object[]
required
pagination
object
required
meta
object
required