Skip to main content
POST
/
report
/
inventory
cURL
curl --request POST \
  --url https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1/report/inventory \
  --header 'Content-Type: <content-type>' \
  --header 'access_token: <access_token>' \
  --header 'client_id: <client_id>' \
  --data '
{
  "email": "[email protected]",
  "locale": "pt",
  "id": 0,
  "contractAssetNumber": "string",
  "showContracted": true,
  "operator": "ALGAR TELECOM",
  "connectedOperator": "TIM",
  "subOperator": "ALGAR 3OP",
  "nickname": "Device nickname",
  "observation": "Observation about device",
  "msisdn": [
    "5516981818181"
  ],
  "iccid": [
    "89553203000003920000"
  ],
  "imsi": [
    "724373198034943"
  ],
  "status": "ACTIVE",
  "stock": true,
  "franchise": 20,
  "customerName": "Customer name",
  "customerDocumentNumber": "351316040684",
  "customerId": 15010,
  "online": true,
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "lastConnectionFrom": "2025-08-11T17:33:27.358Z",
  "lastConnectionTo": "2025-08-11T17:33:27.358Z",
  "consumptionPercentFrom": 18.5,
  "consumptionPercentTo": 83.5,
  "consumptionFrom": 18151355,
  "consumptionTo": 83344468486,
  "automaticBlocking": true,
  "networkBlockStatus": "NONE",
  "blockedByDefault": true,
  "accountId": 0,
  "accountDesc": "string",
  "loyaltyType": 0,
  "loyaltyTime": 0,
  "cancellationFeeFrom": 0,
  "cancellationFeeTo": 0,
  "activationPriceFrom": 0,
  "activationPriceTo": 0,
  "priceFrom": 0,
  "priceTo": 0,
  "megabyteExcPriceFrom": 0,
  "megabyteExcPriceTo": 0,
  "simcardCreditFrom": 0,
  "simcardCreditTo": 0,
  "tradeInMonths": 0,
  "preActivationDays": 0,
  "preActivationEndDateFrom": "2025-08-11T17:33:27.358Z",
  "preActivationEndDateTo": "2025-08-11T17:33:27.358Z",
  "sharingType": "NONE",
  "brokerContractId": 131351,
  "brokerContractDesc": "Shared contract ACDUEB123",
  "sharedContractCreditFrom": 5,
  "sharedContractCreditTo": 20,
  "sharedContractFranchiseFrom": 10,
  "sharedContractFranchiseTo": 20,
  "apn": "example.br",
  "hostname": "172.217. 22.14",
  "technology": "5G",
  "imei": "516761813114869",
  "imeiLocked": true,
  "activationDateFrom": "2025-08-11T17:33:27.358Z",
  "activationDateTo": "2025-08-11T17:33:27.358Z",
  "cancellationDateFrom": "2025-08-11T17:33:27.358Z",
  "cancellationDateTo": "2025-08-11T17:33:27.358Z",
  "suspensionEligibility": true,
  "suspensionStartDateFrom": "2025-08-11T17:33:27.358Z",
  "suspensionStartDateTo": "2025-08-11T17:33:27.358Z",
  "suspensionEndDateFrom": "2025-08-11T17:33:27.358Z",
  "suspensionEndDateTo": "2025-08-11T17:33:27.359Z"
}
'
{
  "id": 56865,
  "message": "Request created successfully! An email will be sent to: [email protected] with the download link"
}

Headers

​
Content-Type
string
default:application/json
required

Define o formato da requisição.

🔹 Valor padrão:

application/json

📌 Dica: Copie e cole esse valor no campo Content-Type.

Example:

"application/json"

​
client_id
string
required

Identificador do client id do sensedia

Example:

"123"

​
access_token
string
required

Token gerado

Example:

"Basic MzQ4OSozNDMyLTMOMzItMTIz"

Body

application/json

Informações necessárias para fazer a solicitação do relatório.

​
email
string
​
locale
string
Example:

"pt"

​
id
integer
Example:

0

​
contractAssetNumber
string
Example:

"string"

​
showContracted
boolean
Example:

true

​
operator
string
Example:

"ALGAR TELECOM"

​
connectedOperator
string
Example:

"TIM"

​
subOperator
string
Example:

"ALGAR 3OP"

​
nickname
string
Example:

"Device nickname"

​
observation
string
Example:

"Observation about device"

​
msisdn
array
Example:
["5516981818181"]
​
iccid
array
Example:
["89553203000003920000"]
​
imsi
array
Example:
["724373198034943"]
​
status
string
Example:

"ACTIVE"

​
stock
boolean
Example:

true

​
franchise
integer
Example:

20

​
customerName
string
Example:

"Customer name"

​
customerDocumentNumber
string
Example:

"351316040684"

​
customerId
integer
Example:

15010

​
online
boolean
Example:

true

​
city
string
Example:

"string"

​
state
string
Example:

"string"

​
postalCode
string
Example:

"string"

​
lastConnectionFrom
string
Example:

"2025-08-11T17:33:27.358Z"

​
lastConnectionTo
string
Example:

"2025-08-11T17:33:27.358Z"

​
consumptionPercentFrom
number
Example:

18.5

​
consumptionPercentTo
number
Example:

83.5

​
consumptionFrom
integer
Example:

18151355

​
consumptionTo
integer
Example:

83344468486

​
automaticBlocking
boolean
Example:

true

​
networkBlockStatus
string
Example:

"NONE"

​
blockedByDefault
boolean
Example:

true

​
accountId
integer
Example:

0

​
accountDesc
string
Example:

"string"

​
loyaltyType
integer
Example:

0

​
loyaltyTime
integer
Example:

0

​
cancellationFeeFrom
integer
Example:

0

​
cancellationFeeTo
integer
Example:

0

​
activationPriceFrom
integer
Example:

0

​
activationPriceTo
integer
Example:

0

​
priceFrom
integer
Example:

0

​
priceTo
integer
Example:

0

​
megabyteExcPriceFrom
integer
Example:

0

​
megabyteExcPriceTo
integer
Example:

0

​
simcardCreditFrom
integer
Example:

0

​
simcardCreditTo
integer
Example:

0

​
tradeInMonths
integer
Example:

0

​
preActivationDays
integer
Example:

0

​
preActivationEndDateFrom
string
Example:

"2025-08-11T17:33:27.358Z"

​
preActivationEndDateTo
string
Example:

"2025-08-11T17:33:27.358Z"

​
sharingType
string
Example:

"NONE"

​
brokerContractId
integer
Example:

131351

​
brokerContractDesc
string
Example:

"Shared contract ACDUEB123"

​
sharedContractCreditFrom
integer
Example:

5

​
sharedContractCreditTo
integer
Example:

20

​
sharedContractFranchiseFrom
integer
Example:

10

​
sharedContractFranchiseTo
integer
Example:

20

​
apn
string
Example:

"example.br"

​
hostname
string
Example:

"172.217. 22.14"

​
technology
string
Example:

"5G"

​
imei
string
Example:

"516761813114869"

​
imeiLocked
boolean
Example:

true

​
activationDateFrom
string
Example:

"2025-08-11T17:33:27.358Z"

​
activationDateTo
string
Example:

"2025-08-11T17:33:27.358Z"

​
cancellationDateFrom
string
Example:

"2025-08-11T17:33:27.358Z"

​
cancellationDateTo
string
Example:

"2025-08-11T17:33:27.358Z"

​
suspensionEligibility
boolean
Example:

true

​
suspensionStartDateFrom
string
Example:

"2025-08-11T17:33:27.358Z"

​
suspensionStartDateTo
string
Example:

"2025-08-11T17:33:27.358Z"

​
suspensionEndDateFrom
string
Example:

"2025-08-11T17:33:27.358Z"

​
suspensionEndDateTo
string
Example:

"2025-08-11T17:33:27.359Z"

Response

Request created successfully

​
Accepted
string
Example:
{
  "id": 56865,
  "message": "Request created successfully! An email will be sent to: [email protected] with the download link"
}