REST API

​

Presets

​

Listing parameters

• search also looks inside a preset: product and variation names, SKUs, and custom item names.
• sort takes name, status, items, price, revenue, orders or publish, with dir as asc or desc.
• filters takes the fields price, revenue, items, orders, date and product, among others. It takes at most 8 rows, and at most 3 of them from product, product_name and stock_problem together, the rows that look inside a preset’s items. More is a 400 saying which limit it passed. The same limits apply to a bulk query and to export.

curl -s 'https://yourstore.com/wp-json/cartpresets/v1/presets?status=active&sort=price&dir=asc&per_page=5' \
  -H 'X-WP-Nonce: <nonce>' \
  --cookie 'wordpress_logged_in_...=<cookie>'

​

What a preset carries

​

Saving

• more than 100 items in one preset;
• a quantity, qty_min or qty_max over 9,999, or one that isn’t a whole number;
• a custom_price or disc_value that isn’t a finite number of at most 1,000,000,000;
• a variation_id that isn’t a variation of the item’s product_id.

​

Bulk actions

• ids: the presets you ticked.
• query: { search, status, filters }, validated the way the listing validates them, for every preset that matches. This is the listing’s Select all across pages. Send expect with it: the count the merchant confirmed. If the query matches a different number by the time it runs, nothing changes and the answer is a 409 (cartpresets_bulk_changed) with the new count in data.total.

​

Export and import

• imported lists { index, id, name } for each preset written.
• skipped_presets lists { index, name, errors } for each one that wasn’t, with errors keyed by field path like a failed save’s data.fields.
• index is the preset’s position in the document, from 0.
• stopped is true when the import ran out of its time or memory budget and stopped between presets. The budget is half the request’s time limit, up to 20 seconds, and four fifths of PHP’s memory limit. The presets it didn’t reach are in skipped_presets. At least one preset is always imported.

​

Settings

​

Supporting routes

• type: WooCommerce’s own, such as simple, variable, subscription or variable-subscription.
• subscription: null unless the product bills as a subscription, otherwise { period, interval, length, trial_period, trial_length, sign_up_fee }. A variable subscription’s variations each carry their own.

​

Reporting

​

Licensing

​

Pro routes on the free version

if ( ! \SmartWP\CartPresets\Support\Tier::is_pro() ) {
	// Do not call /sales here — it will 404.
}

​

Adding your own routes

add_action( 'cartpresets_register_rest_routes', function () {
	register_rest_route( 'cartpresets/v1', '/my-thing', array(
		'methods'             => 'GET',
		'callback'            => 'my_plugin_handler',
		'permission_callback' => function () {
			return current_user_can( 'manage_woocommerce' );
		},
	) );
} );