GetPayoutStatus

Returns sales and order metric for a specified period.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The repsponse contains the following fields:

StatementNumberStringStatement Identifier
CreatedAtDateTimeWhen the statement was created.
UpdatedAtDateTimeWhen the statement was last updated.
OpeningBalanceDecimalThe opening balance.
ItemRevenueDecimalThe revenue generated by the item.
ShipmentFeeDecimalCost of shipping.
ShipmentFeeCreditDecimalShipping credit, if any.
OtherRevenueTotalDecimal?
FeesTotalDecimalSum of Payment Fee & Return to Seller
Fee
Subtotal1Decimal(Sum of Item Revenue, Other Revenue) -
Fees(Total)
RefundsDecimalSum of all refunds, if any.
FeesOnRefundsTotalDecimalAccumulated fees on refunds issued.
Subtotal2Decimal(Sum of Subtotal1) - Refunds
ClosingBalanceDecimalClosing Balance
GuaranteeDepositDecimalGuarantee Deposit
PayoutDecimalAmount to be Paid Out to Seller for Statement
PaidBooleanPayout Status of Statement. 1 is Paid. 0 is Not Paid

Errors

Error codeMessage
4E004: Invalid Timestamp format
62E062 No seller was found by e-mail %s
Query Params
string
Defaults to GetPayoutStatus

Name of the function that is to be called. Mandatory and must be 'GetPayoutStatus' in this case. If omitted, an 'E001: Parameter Action is mandatory' error is returned. If an unknown function string is supplied, an 'E008: Invalid Action' error message is returned.

string
Defaults to XML

If supplied, must be either 'JSON' or 'XML'. If not supplied, 'XML' is assumed.

date

The current time in ISO8601 format relative to UTC (e.g., Timestamp=2015-04-01T10:00:00+02:00 for Berlin), so that calls cannot be replayed by an eaves-dropping third party (i.e., those calls too far into the past or future yield an error message). Mandatory. If not supplied, an 'E001: Parameter Timestamp is mandatory' error message results. If the timestamp is too old or in the future, an 'E003: Timestamp has expired' error message is returned.

string

The ID of the user making the call. The list of authorized users is maintained in Seller Center web interface under Settings/Manage Users.

string

The API version against which this call is to be executed, in major-dot-minor format. Must currently be 1.0, even though the actual version of the API is 2.6.20. If omitted, an ‘E001: Parameter Version is mandatory’ error message is returned.

string

The cryptographic signature, authenticating the request. A caller must create this value by computing the SHA256 hash of the request, using the API key of the user specified in the UserID parameter. Mandatory. If omitted, an ‘E001: Parameter Signature is mandatory’ error message is returned. If the signature is incorrect, an ‘E007: Login failed. Signature mismatch’ error message is returned.

date

Filter statements created after the provided date. Mandatory.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/xml
application/json