Sales ยท Statistics
Get inventory usage
Returns the list value of the inventory with how much of it is sold, committed, or reserved, counted like the product list, the list value of what the invoices of a period sold and of the period of the same length right before it, and the five best-selling products. All amounts are in cents
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readproduct.readinventory.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Query parameters
-
fromDatestringrequired -
toDatestringrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/sales/statistics/inventoryUsage' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/sales/statistics/inventoryUsage", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/sales/statistics/inventoryUsage', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
inventoryValuenumberat least 0
-
usageobject3 properties
-
soldValuenumberat least 0
-
committedValuenumberat least 0
-
reservedValuenumberat least 0
-
-
productCountintegerat least 0
-
soldValuenumberat least 0
-
previousSoldValuenumberat least 0
-
topProductsobject[]4 properties
-
productIdid -
namestring -
soldQuantitynumberat least 0
-
soldValuenumberat least 0
-
Response200
{
"inventoryValue": 0,
"usage": {
"soldValue": 0,
"committedValue": 0,
"reservedValue": 0
},
"productCount": 0,
"soldValue": 0,
"previousSoldValue": 0,
"topProducts": [
{
"productId": "000000000000000000000001",
"name": "string",
"soldQuantity": 0,
"soldValue": 0
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.