Skip to main content
POST
json

Body

application/json
DistributorId
string
required

Distributor ID (DID) to run the inventory report for.

Example:

"DID-1e24785ab-3f3c-7db1-89d7-956d80fdnn5"

Filter
enum<string>

Status of the numbers to include in the report. Case-insensitive; common synonyms (for example cancel, canceled, deactivate) are also accepted.

Available options:
active,
pending,
swapped,
parked,
cancelled,
deactivated
Example:

"active"

Response

Accepted — the report is generated in the background and emailed to the distributor's admin email. No response body is returned.