Skip to content

Documentation / Reference

REST API

Last updated

The React dashboard talks to WordPress through the REST API.

Core namespace

/wp-json/jwp-stk/v1/ — dashboard routes require manage_options.

  • GET /modules — list modules and active state
  • POST /modules/toggle — enable or disable a module
  • GET|POST /settings — global settings
  • GET|POST /modules/{slug}/settings — per-module settings
  • GET /blocks and POST /blocks/toggle — block toggles
  • GET|DELETE /jobs and DELETE /jobs/{id} — background jobs (jobs list delete requires a module arg)

Stock Manager

Requires manage_woocommerce. See Using the stock table.

  • GET /stock-manager/products
  • PATCH|POST /stock-manager/products/{id}

Store Reports

Requires manage_woocommerce except the public share download. See Running an export.

  • POST /store-reports/report, POST /store-reports/generate
  • GET|POST /store-reports/presets; DELETE|PATCH /store-reports/presets/{id}
  • GET /store-reports/options
  • GET|POST /store-reports/schedules; PATCH|DELETE /store-reports/schedules/{id}
  • GET /store-reports/jobs; GET /store-reports/jobs/{id}/download
  • POST|DELETE /store-reports/jobs/{id}/share
  • GET /store-reports/share/{token} — public file download

Extending

Modules can register extra routes on jwp_stk_register_rest_routes (namespace passed to the action).