API Guides

Ready-to-use client libraries for popular programming languages.

API Center Menu

Find Item By Item ID

Request Type: 

GET

API Endpoint:

<url>/api/inventory/item/:item_id 

Mandatory Headers Properties:

  • Authorization (type: string): the valid access token from the authentication. 

Mandatory Query parameters:

  • item_id (type: string): The requested inventory item ID 

Return an inventory object 

Response

{

    "status": "ok",

    "data": {

        "weight": 11,

        "cube": 11,

        "retail_value": 11,

        "status": 3,

        "vendor": "Feather",

        "vendor_id": "5c65a6501c272100216b3aed",

        "packaged": false,

        "condition": 1,

        "serial_number": null,

        "source_app_id": "haim-local",

        "packages": 1,

        "quantity": 1,

        "commodity_class": 0,

        "in_warehouse": "58d1e4582bdebd0f0025de72",

        "designated_region": "58d1e4582bdebd0f0025de72",

        "received_at": "2021-03-07T19:36:44.389Z",

        "require_pre_inspection": false,

        "has_free_storage": false,

        "_id": "604529840f8a2f604c14b2eb",

        "retailer_id": "5c65a4821c272100216b3ae5",

        "name": "TEST456",

        "sku": "TEST456",

        "locations": [

            {

                "geolocation": {

                    "coords": {},

                    "timestamp": "2021-03-07T19:36:44.433Z"

                },

                "is_actual": true,

                "date": "2021-03-07T19:36:44.433Z",

                "_id": "60452b4c0f8a2f604c14b33d",

                "location_id": "5fd0f0e9a5cf51c7b025fe15",

                "user": "531114ba4231c0d02f3a2163"

            }

        ],

        "payload": {},

        "created_at": "2021-03-07T19:29:08.563Z",

        "tracking": [

            {

                "geolocation": {

                    "coords": {},

                    "timestamp": "2021-03-07T19:29:09.286Z"

                },

                "event_type_id": 163,

                "reference_record": null,

                "date": "2021-03-07T19:29:09.286Z",

                "_id": "604529850f8a2f604c14b2f5",

                "description": "Inventory item created item id: I3862",

                "user": "531114ba4231c0d02f3a2163"

            },

            {

                "geolocation": {

                    "coords": {},

                    "timestamp": "2021-03-07T19:36:44.415Z"

                },

                "event_type_id": 5,

                "reference_record": null,

                "date": "2021-03-07T19:36:44.415Z",

                "_id": "60452b4c0f8a2f604c14b33c",

                "description": "item received",

                "user": "531114ba4231c0d02f3a2163"

            }

        ],

        "item_id": "I3862",

        "__v": 0,

        "updated_at": "2021-03-07T19:36:44.431Z",

        "total_cube_usage": 187,

        "id": "604529840f8a2f604c14b2eb"

    }

}