Sales · Inventory
List inventory activity
Lists paginated reserved, committed, sold, and returned inventory
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.readreceipt.read
Required for some requests, where input is what the request sends
salesPeriod.read, ifinput.includePeriods
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
productIdid -
includePeriodsbooleandefault
false -
searchTermstring -
statusstringreservedcommittedsoldreturned -
sortobject of stringdefault
{"createdAt":"desc"}ascdescKeys: one of 8 values
productNamescopeKeyreceiptNumberaccountNamestatusquantityexpiresOncreatedAt -
limitinteger1–100 · default
50 -
offsetintegerat least 0 · default
0 -
returnCountbooleandefault
false
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/sales/inventory/activity/list' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/sales/inventory/activity/list", {
method: "POST",
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' => 'POST',
'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/inventory/activity/list', 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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
activitiesobject[]15 properties
-
idstring -
mandateIdid -
productIdid -
productNamestring1–80 characters
-
scopeKeystring -
periodobjectnullable4 properties
-
_idid -
namestring -
startsAtstring -
endsAtstring
-
-
receiptIdid -
receiptTypestringnullableofferconfirmationinvoice -
receiptNumberstringnullable -
accountnumbernullable -
accountNamestringnullable -
quantitynumber -
statusstringreservedcommittedsoldreturned -
expiresOnstringnullable -
createdAtstring · date-timenullable
-
-
countintegerat least 0
Response200
{
"activities": [
{
"id": "string",
"mandateId": "000000000000000000000001",
"productId": "000000000000000000000001",
"productName": "string",
"scopeKey": "string",
"period": {
"_id": "000000000000000000000001",
"name": "string",
"startsAt": "string",
"endsAt": "string"
},
"receiptId": "000000000000000000000001",
"receiptType": "offer",
"receiptNumber": "string",
"account": 1,
"accountName": "string",
"quantity": 1,
"status": "reserved",
"expiresOn": "string",
"createdAt": "2026-06-15T22:30:00Z"
}
],
"count": 0
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.