Get supportRequest a Demo
  • Get Started
    • Welcome
  • Guides
    • Authentication
    • Patient Management
    • Order Management
    • Device Management
    • Webhook Management
  • Webhooks
  • API Reference
  • Resources
    • OpenAPI Spec
    • Mobile SDK
LogoLogo
Get supportRequest a Demo
API ReferenceItems

Create Item

POST
/api/v3/item
POST
/api/v3/item
1curl -X POST https://app.impiloplatform.com/api/v3/item \
2     -H "Impilo-API-Key: <Impilo-API-Key>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "name": "Blood Pressure Monitor",
6  "deviceIdentifierType": "serial",
7  "model": "iBloodPressureMonitor123"
8}'
Try it
This endpoint creates a new Item in the Impilo platform. This endpoint is only enabled for Customers that are also Manufacturer accounts. Items created via this endpoint will: - receive a generated SKU and ID - have a Manufacturer set to the requesting Customer - be set to an Orderable status of FALSE Items created with this endpoint are not able to be ordered until approved manually by an Impilo Admin. Items can still be procured and received within Impilo's system while the orderable parameter is false.
Was this page helpful?
Previous

Fetch Item

Next
Built with
Fetch Item

This endpoint creates a new Item in the Impilo platform. This endpoint is only enabled for Customers that are also Manufacturer accounts.

Items created via this endpoint will:

  • receive a generated SKU and ID
  • have a Manufacturer set to the requesting Customer
  • be set to an Orderable status of FALSE

Items created with this endpoint are not able to be ordered until approved manually by an Impilo Admin. Items can still be procured and received within Impilo’s system while the orderable parameter is false.

Authentication

Impilo-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequired
The name for this item.
deviceIdentifierTypeenumOptional
Allowed values:
modelstringOptional

The manufacturer-assigned model for this item.

Response

Created
deviceIdentifierTypeenum or null
Allowed values:
dimensionsobject or null
The physical dimensions of this item.
idlong or null
Unique identifier for the item, managed by Impilo.
itemCertificationslist of objects or null
itemClassenum or null
itemClassTypestring or null
The Class Type associated with this item.
manufacturerobject or null
The manufacturer for this item.
modelstring or null

The manufacturer-assigned model for this item.

namestring or null
The name for this item.
orderableboolean or null
Whether an Item is able to be ordered.
readingTypeenum or null
sizeenum or null
Allowed values:
skustring or null

The Impilo-assigned SKU for this item.