Create item
Developing
POST
/v1/item
Request
Header Params
X-API-Key
string
required
Example:
{{APIKEY}}
Body Params application/json
name
string
required
image
string
required
sku
string
required
scannable
string
required
description
string
required
uom
string
required
base_unit
string
required
receiving_unit
string
optional
receiving_unit_base_conversion
string
optional
shipping_unit
string
optional
shipping_unit_base_conversion
string
optional
is_perishable
boolean
required
is_batch_controlled
boolean
required
is_tracked_by_serial_no
boolean
required
is_hazmat
boolean
required
hazmat_type
string
required
Example
{
"name": "bmw m1",
"image": "https://somecdn/image.jpeg",
"sku": "bmwm1",
"scannable": "bmwm1",
"description": "bmw m1 rwd",
"uom": "car",
"base_unit": "each",
"receiving_unit": "trailer",
"receiving_unit_base_conversion": "10",
"shipping_unit": "maersk-cargo-ship",
"shipping_unit_base_conversion": "100",
"is_perishable": false,
"is_batch_controlled": false,
"is_tracked_by_serial_no": false,
"is_hazmat": true,
"hazmat_type": "LIMITED_QUANTITY"
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://nova-sandbox.leanafywms.com/v1/item' \
--header 'X-API-Key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "bmw m1",
"image": "https://somecdn/image.jpeg",
"sku": "bmwm1",
"scannable": "bmwm1",
"description": "bmw m1 rwd",
"uom": "car",
"base_unit": "each",
"receiving_unit": "trailer",
"receiving_unit_base_conversion": "10",
"shipping_unit": "maersk-cargo-ship",
"shipping_unit_base_conversion": "100",
"is_perishable": false,
"is_batch_controlled": false,
"is_tracked_by_serial_no": false,
"is_hazmat": true,
"hazmat_type": "LIMITED_QUANTITY"
}'Responses
🟢200Success
application/json
Body
success
boolean
required
payload
object
required
_id
string
required
name
string
required
image
string
required
sku
string
required
scannable
string
required
description
string
required
is_perishable
boolean
required
is_batch_controlled
boolean
required
is_tracked_by_serial_no
boolean
required
is_hazmat
boolean
optional
hazmat_type
string
optional
uom
string
required
base_unit
string
required
divisions
array [object {2}]
required
quantity
integer
required
Example
{
"success": true,
"payload": {
"_id": "67bc1ffd2433307c7c094b07",
"name": "bmw m9",
"image": "https://somecdn/image.jpeg",
"sku": "bmwm9",
"scannable": "bmwm9",
"description": "bmw m9 rwd",
"is_perishable": false,
"is_batch_controlled": false,
"is_tracked_by_serial_no": false,
"is_hazmat": true,
"hazmat_type": "LIMITED_QUANTITY",
"uom": "car-bmwm9",
"base_unit": "each",
"divisions": [
{
"unit": "each",
"base_conversion": 1
},
{
"unit": "trailer",
"base_conversion": 10
},
{
"unit": "maersk-cargo-ship",
"base_conversion": 100
}
],
"quantity": 0
}
}🔴500Server Error
Modified at 2025-04-14 13:14:48