List COD wallets

COD Wallet ledger endpoint with pagination, status/type filtering, multiple date filters, sorting, and total amount calculation.

💡

Authentication

Bearer token authentication is required.
Only COD wallet records belonging to the authenticated merchant are returned.
The token must be obtained using POST /api/auth/login and sent as Authorization: Bearer {token}.

💡

Filtering

Filter by COD wallet status using
?status=in_progress|paid|accepted.

Filter by COD wallet type using
?type=cod|bank|wallet.

Filter by COD wallet creation date using
?created_at_from=YYYY-MM-DD, ?created_at_to=YYYY-MM-DD, or both combined.

Filter by order creation date using
?order_created_at_from=YYYY-MM-DD, ?order_created_at_to=YYYY-MM-DD, or both combined.

Filter by order delivery date using
?order_delivered_at_from=YYYY-MM-DD, ?order_delivered_at_to=YYYY-MM-DD, or both combined.

Filter by shipment pickup date using
?shipment_picked_at_from=YYYY-MM-DD, ?shipment_picked_at_to=YYYY-MM-DD, or both combined.

📌

Pagination & Sorting

Results are paginated using Laravel’s pagination.

Use ?page= to select the page.

Use ?per_page= to control the number of results per page (maximum 200).

The data field contains the list of COD wallet records.

Pagination metadata includes current_page, per_page, total, last_page, from, to, next_page_url, prev_page_url, etc.

Use ?sort_by= to sort the results by fields such as amount, status, type, created_at, updated_at, order_created_at, order_number, order_delivered_at, payment_method, shipment_reference, or order_grand_total.

Use ?sort_dir=asc|desc to control the sorting direction. The default direction is desc.

📌

Amount

The amount field in each COD wallet row is returned in cents.
For example, 11500 represents 115.00 SAR.
filtered_total_amount represents the Total Amount for the current filters and is returned in SAR.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://app.gotreek.com/api/auth/login

curl --location 'https://api.gotreek.com/api/cod-wallets?page=undefined&per_page=undefined&status=undefined&type=undefined&created_at_from=undefined&created_at_to=undefined&order_created_at_from=undefined&order_created_at_to=undefined&order_delivered_at_from=undefined&order_delivered_at_to=undefined&shipment_picked_at_from=undefined&shipment_picked_at_to=undefined&sort_by=undefined&sort_dir=undefined' \ --header 'Authorization: Bearer <token>'

Request

Responses