Advanced Coupons API
  • REST API
  • coupons/v1
    • Virtual Coupons (Premium)
      • Query a list of virtual coupons
      • Fetch virtual coupon stats
      • Create a virtual coupon
      • Retrieve a virtual coupon
      • Update a virtual coupon
      • Delete a virtual coupon
      • Bulk create virtual coupons
      • Bulk delete virtual coupons
    • Search Customers (Premium)
    • Settings
  • loyalty-program/v1
    • Dashboard
    • Customers
    • Settings
    • My Points
  • wc-loyalty-program/v1
    • Dashboard
    • Customers
    • Settings
  • wc-store-credits/v1
    • Entries
      • Query a list of store credit entries
      • Create a store credit entry
      • Fetch a single store credit entry
      • Update store credit entry
      • Delete store credit entry
    • Customers
      • Get dashboard statistics data
      • Query list of customers with store credits balance
      • Get single customer statistics and sources
Powered by GitBook
On this page

Was this helpful?

  1. wc-store-credits/v1
  2. Entries

Fetch a single store credit entry

GET: /wp-json/wc-store-credits/v1/entries‌/{entry_id}

Requirements:

  • Logged-in user

  • user role with manage_woocommerce user capability

Method

Endpoint

GET

/wp-json/wc-store-credits/v1/entries‌/{entry_id}

Query Parameters

Required

Type

Default

Description

​date_format

​no

​string

F j, Y g:i a

Date format of virtual coupon response date values.

context

no

string

edit

Context of data being fetched: view or edit

Get store credit entry with id 35

GET: http://example.com/wp-json/wc-store-credits/v1/entries/‌35

Get store credit entry with id 35, with custom date format

GET: http://example.com/wp-json/wc-store-credits/v1/entries/‌35?date_format=Y-m-d 

Status: 200 OK

Get store credit entry with id 35

{
  "key": "35",
  "id": 35,
  "amount_raw": 45,
  "amount": "$45.00",
  "type": "increase",
  "activity": "Refunded order",
  "user_id": 1,
  "date": "November 16, 2021 1:12 pm",
  "rel_link": "http://acfw.test/my-account/view-order/436/",
  "rel_label": "View Order",
  "note": ""
}

Get store credit entry with id 35 and with custom date format

{
  "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": ""
}

Status: 403 Forbidden

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

PreviousCreate a store credit entryNextUpdate store credit entry

Last updated 3 years ago

Was this helpful?