Skip to main content
inventory

Create an inventory item

Creates a single inventory item in the studio the API key is issued for, and returns it once it exists. No Idempotency-Key header is required. If the request times out (504) or fails upstream (502) the item may still have been created, so the response returns an Idempotency-Key header: retrying with that value returns the item the first attempt created rather than creating a second. You may optionally send your own Idempotency-Key on the first request and that will be used.

POST
/v1/inventory
beam-api-keystringheaderrequired

Body

application/json
attributesstring[]
barcodestring
Minimum string length: 1
companiesstring[]
externalIdstring
Minimum string length: 1
fieldsobject
installDatestring
productobjectrequired

Supply the product id when the product is already known, or matching data (modelNumber, name, manufacturerName) to have it resolved.

purchasedDatestring
purchasedPricenumber
Required range: 0 <= x
serialstring
Minimum string length: 1
statusIdstring
tagsstring[]
vendorstring
Minimum string length: 1

Response

application/json

The created inventory item

inventoryobjectrequired