Request Type:
POST
API Endpoint:
<url>/api/inventory
Mandatory Headers Properties:
Authorization (type: string): the valid access token from the authentication.
Sample Request
{
"item": {
"quantity": 4,
"packages": 1,
"retailer_id": "58c889b67dcce40f000f08a1",
"name": "NEW_TEST_2021",
"sku": "NEW_TEST_2021",
"vendor": "adouglas",
"ref_order_number":"<po number>",
"record_reference":"<reference record / container number / etc>",
"serial_number": "item unique serial number",
"vendor_id": "59b6b08157bf22ae15611e35",
"weight": 10,
"cube": 10,
"retail_value": 10,
"designated_region":"54d1005de00b63c74dc428f0"
},
"geolocation": null
}
Response:
The created Inventory item. In the case that the quantity is more than 1 the response will include an array of the created items.
{
"status": "ok",
"data": [
{
"weight": 10,
"cube": 10,
"retail_value": 10,
"status": 1,
"vendor": "adouglas",
"vendor_id": "59b6b08157bf22ae15611e35",
"ref_order_number":"<po number>",
"record_reference":"<reference record / container number / etc>",
"packaged": false,
"condition": 1,
"serial_number": null,
"packages": 1,
"quantity": 1,
"commodity_class": 0,
"in_warehouse": null,
"designated_region": "54d1005de00b63c74dc428f0",
"received_at": null,
"require_pre_inspection": false,
"has_free_storage": false,
"_id": "605c6d970580041b1773bc8d",
"retailer_id": "58c889b67dcce40f000f08a1",
"name": "NEW_TEST_2021",
"sku": "NEW_TEST_2021",
"locations": [],
"payload": {},
"created_at": "2021-03-25T11:01:43.249Z",
"tracking": [],
"item_id": "I3946",
"__v": 0,
"total_cube_usage": -1,
"id": "605c6d970580041b1773bc8d"
}
]
}