Query a list of store credit entries

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

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

integer

Current page to load in query.

per_page

integer

Number of entries to load per page in query.

sort_by

string

date

Value to be based for sorting: user_id, date, type, action.

sort_order

string

desc

Order of sorting: desc or asc

user_id

integer

Load entries for a specific user.

is_admin

boolean

false

Flag to set the displayed action links to be either for admin or for the frontend.

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
    }
}

PreviousEntries NextCreate a store credit entry

Last updated 3 years ago

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

hashtag

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