Get paginated merchant ledger entries.
GET
/api/usage/reports/merchant-ledger
deprecated
Requires: Usage.Reports, merchant scope.
Returns a continuation token in the response body for paging beyond the first page.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
MerchantId
required |
query | string (uuid) | The merchant ID. |
ResellerId
required |
query | string (uuid) | The reseller ID the merchant belongs to. |
SkuCode
required |
query | string | Optional SKU code filter. |
Period
required |
query | string | Period key (e.g., "202602"). Defaults to current period if null. |
MaxResultCount
required |
query | integer (int32) | Maximum number of results to return. |
ContinuationToken
required |
query | string | Continuation token from a previous page response. Null for the first page. |
IncludeDeleted
required |
query | boolean | Not used by this read-only endpoint — soft-deleted ledger entries are not surfaced. |
IncludeInactive
required |
query | boolean | Not used by this read-only endpoint. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.