Query a list of store credit entries

GET: /wp-json/wc-store-credits/v1/entries

Request

Requirements:

• Logged-in user

• user role with manage_woocommerce user capability

Method	Endpoint
GET	/wp-json/wc-store-credits/v1/entries

Query Parameters	Required	Type	Default value	Description
page	no	integer	1	Current page to load in query.
per_page	no	integer	10	Number of entries to load per page in query.
sort_by	no	string	date	Value to be based for sorting: user_id, date, type, action.
sort_order	no	string	desc	Order of sorting: desc or asc
user_id	no	integer	0	Load entries for a specific user.
is_admin	no	boolean	false	Flag to set the displayed action links to be either for admin or for the frontend.

Request Example

Get store credits entry for user with ID of 10

GET: http://example.com/wp-json/wc-store-credits/v1/entries?user_id=10

Response Example

Status: 200 OK

Headers:
{
...
X-TOTAL: 100
}

[
  {
    "key": "35",
    "id": 35,
    "amount_raw": 45,
    "amount": "$45.00",
    "type": "increase",
    "activity": "Refunded order",
    "user_id": 1,
    "date": "2021-11-16 13:12:10",
    "rel_link": "http://acfw.test/my-account/view-order/436/",
    "rel_label": "View Order",
    "note": ""
  },
  {
    "key": "34",
    "id": 34,
    "amount_raw": 10,
    "amount": "$10.00",
    "type": "increase",
    "activity": "Admin adjustment (increase)",
    "user_id": 1,
    "date": "2021-11-16 13:10:56",
    "rel_link": "",
    "rel_label": "-",
    "note": ""
  },
  ...
]

Status: 401 Unauthorized

{
    "code": "rest_forbidden_context",
    "message": "Sorry, you are not allowed access to this endpoint.",
    "data": {
        "status": 401
    }
}