This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Get Item

GET

/v1/item

API to get item info including inventory count. Please note that the quantity will always be in base unit.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "payload": {
        "_id": "67b37e9d8c1c9726ec49d2a2",
        "name": "bmw m8",
        "image": "https://somecdn/image.jpeg",
        "sku": "bmwm8",
        "scannable": "bmwm8",
        "description": "bmw m8 rwd",
        "is_perishable": false,
        "is_batch_controlled": false,
        "is_tracked_by_serial_no": false,
        "is_hazmat": true,
        "hazmat_type": "LIMITED_QUANTITY",
        "uom": "car-bmwm8",
        "base_unit": "each",
        "divisions": [
            {
                "unit": "trailer",
                "base_conversion": 10
            },
            {
                "unit": "maersk-ship",
                "base_conversion": 100
            }
        ],
        "quantity": 0
    }
}

🔴500Server Error

Modified at 2025-05-04 14:32:36

Bulk Create Items

Get All Items