Skip to content
campaiDeveloper
campai.com

Sales · Inventory

POST/{organizationId}/{mandateId}/sales/inventory/activity/listReads only

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.read
  • product.read
  • inventory.read
  • receipt.read
Required for some requests, where input is what the request sends
  • salesPeriod.read, if input.includePeriods

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • productIdid
  • includePeriodsboolean

    default false

  • searchTermstring
  • statusstring
    reserved committed sold returned
  • sortobject of string

    default {"createdAt":"desc"}

    asc desc
    Keys: one of 8 values
    productName scopeKey receiptNumber accountName status quantity expiresOn createdAt
  • limitinteger

    1–100 · default 50

  • offsetinteger

    at least 0 · default 0

  • returnCountboolean

    default 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'

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
    • productNamestring

      1–80 characters

    • scopeKeystring
    • periodobjectnullable
      4 properties
      • _idid
      • namestring
      • startsAtstring
      • endsAtstring
    • receiptIdid
    • receiptTypestringnullable
      offer confirmation invoice
    • receiptNumberstringnullable
    • accountnumbernullable
    • accountNamestringnullable
    • quantitynumber
    • statusstring
      reserved committed sold returned
    • expiresOnstringnullable
    • createdAtstring · date-timenullable
  • countinteger

    at 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.