API ReferenceItems

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

For more information see the ItemRequest Model.

Headers

Impilo-API-KeystringRequired

Request

This endpoint expects an object.
namestringRequired

The name for this item.

modelstringOptional

The manufacturer-assigned model for this item.

deviceIdentifierTypeenumOptional
Allowed values:

Response

This endpoint returns an object.
idlongOptional

Unique identifier for the item, managed by Impilo.

manufacturerobjectOptional

The manufacturer for this item.

namestringOptional

The name for this item.

modelstringOptional

The manufacturer-assigned model for this item.

skustringOptional

The Impilo-assigned SKU for this item.

orderablebooleanOptional

Whether an Item is able to be ordered.

deviceIdentifierTypeenumOptional
Allowed values:
itemClassenumOptional
itemClassTypestringOptional

The Class Type associated with this item.

sizeenumOptional
Allowed values:
dimensionsobjectOptional

The physical dimensions of this item.

readingTypeenumOptional