curl --request POST \
--url https://api.example.com/v1/inventory/get-by-serial \
--header 'Content-Type: application/json' \
--data '
{
"serial_number": "<string>"
}
'{
"item": {
"id": "<string>",
"contact_id": "<string>",
"account_id": "<string>",
"product_code": "<string>",
"is_competitor_product": true,
"created_date": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"last_modified_date": "2023-11-07T05:31:56Z",
"last_modified_by_id": "<string>",
"name": "<string>",
"serial_number": "<string>",
"install_date": "2023-11-07T05:31:56Z",
"purchase_date": "2023-11-07T05:31:56Z",
"usage_end_date": "2023-11-07T05:31:56Z",
"lifecycle_start_date": "2023-11-07T05:31:56Z",
"lifecycle_end_date": "2023-11-07T05:31:56Z",
"status": "<string>",
"price": 123,
"quantity": "<string>",
"description": "<string>",
"owner_id": "<string>"
}
}Get Inventory Item By Serial
curl --request POST \
--url https://api.example.com/v1/inventory/get-by-serial \
--header 'Content-Type: application/json' \
--data '
{
"serial_number": "<string>"
}
'{
"item": {
"id": "<string>",
"contact_id": "<string>",
"account_id": "<string>",
"product_code": "<string>",
"is_competitor_product": true,
"created_date": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"last_modified_date": "2023-11-07T05:31:56Z",
"last_modified_by_id": "<string>",
"name": "<string>",
"serial_number": "<string>",
"install_date": "2023-11-07T05:31:56Z",
"purchase_date": "2023-11-07T05:31:56Z",
"usage_end_date": "2023-11-07T05:31:56Z",
"lifecycle_start_date": "2023-11-07T05:31:56Z",
"lifecycle_end_date": "2023-11-07T05:31:56Z",
"status": "<string>",
"price": 123,
"quantity": "<string>",
"description": "<string>",
"owner_id": "<string>"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.atonom.ai/llms.txt
Use this file to discover all available pages before exploring further.
Body
Serial number to resolve to an inventory item.
Response
OK
Hide child attributes
Hide child attributes
Unique id of the inventory record in the CRM.
Related contact id when linked.
Related account id when linked.
Manufacturer or internal product code.
True if the item is a competitor product.
When the record was created in the source system.
User id who created the record.
When the record was last modified.
User id who last modified the record.
Human-readable product or asset name.
Serial number used for lookup and identification.
When the item was installed at the customer.
When the item was purchased.
When usage, warranty, or entitlement ends.
Start of the supported lifecycle window.
End of the supported lifecycle window.
Status label from the CRM (e.g. active, retired).
Unit or list price when present.
Quantity on hand or under contract.
Long-form description or notes.
Owning user or team id in the CRM.