View Categories

Offers REST API Reference

0:00 1:28
Table of Contents

Offers REST API #

Name Your Price: Make Your Own Offer for WooCommerce can expose price offers over the WooCommerce REST API so external systems can list, read, and update them. The REST API is free.

Enable the REST API #

Go to WPFactory > Price Offers (also reachable at WooCommerce > Settings > Price Offers), open the Advanced section, and enable REST API (alg_wc_po_rest_api_enabled, default off). The routes register under the WooCommerce wc/v3 namespace, so they use standard WooCommerce REST API authentication (consumer key and secret).

Routes #

Method Route Purpose
GET /wp-json/wc/v3/alg_wc_price_offers List all offers
GET /wp-json/wc/v3/alg_wc_price_offers/<id> Retrieve a single offer
PUT /wp-json/wc/v3/alg_wc_price_offers/<id> Update an offer

Example: list offers #

curl https://example.com/wp-json/wc/v3/alg_wc_price_offers \
  -u consumer_key:consumer_secret

Example: retrieve one offer #

curl https://example.com/wp-json/wc/v3/alg_wc_price_offers/123 \
  -u consumer_key:consumer_secret

Notes #

  • Offers are stored as a custom post type (alg_wc_price_offer) with statuses such as Open, Rejected, Accepted, Counter, Cancelled, and Completed.
  • Because the routes live in the wc/v3 namespace, the same keys and permissions you use for other WooCommerce REST calls apply here.
  • The REST controller only loads while the REST API option is enabled.

Related #

For actions, filters, and shortcodes, see the Developer hooks and filters reference.

Need help? #

Our team answers every ticket on the Name Your Price support forum.