GET
List a customer's store credit movements
Company space For: Cashier and seller, Manager, Accountant · Permission: customers.viewwallet Part of Pay back customers’ store credit.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer
string
required

Identifier of the customer (27-character KSUID string).

Query Parameters

per_page
integer | null

Number of movements per page, from 1 to 100. 15 when left out.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Only created_at is accepted, and it is the default.

Available options:
created_at
sort_order
enum<string> | null

desc (newest first) by default, or asc.

Available options:
asc,
desc
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, customer_id, type, direction, nature, amount, currency_code, currency_exponent, reference, source_activity_type, source_activity_id, register_payment_method_id, payment_method, cashier_id, cash_register_id, cash_account_id, reason, created_by, created_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

data
StoreCreditTransactionResource · object[]
required

Items of this page.

meta
object
required

Pagination details.