Contents
On this page

List Product Costs - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/product-costs

Cost prices, used for margins and stock values.

Needs a user with the plugixa_pos_purchase capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Unlike the other capabilities, Pro gives this one to administrators and to the WooCommerce Shop manager role.

Request

GET https://your-site.example/wp-json/plugixa-pos/v1/product-costs?missing=1

Query parameters

Field Type Required Description
search string No Words to look for.
missing boolean No Only products without a cost.
page integer No Page to return, from 1. Defaults to 1.
per_page integer No Rows per page, 1 to 100. Defaults to 25.

Responses

200 OK.

{
  "success": true,
  "data": [
    {
      "id": 3827,
      "name": "Bamboo toothbrush",
      "sku": "BEA-BRUSH",
      "price": "4.50",
      "stock": 80,
      "cost": "1.1000"
    }
  ],
  "meta": {
    "total": 47,
    "pages": 47
  }
}
Field Type Meaning
meta.total integer Rows matching the filters
meta.pages integer Pages at this per_page

Errors

This endpoint has no errors of its own.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-pos/v1/product-costs?missing=1" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/product-costs?missing=1');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-pos/v1/product-costs?missing=1', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share