Creates a new inventory item

POST

/v1/items

Creates a new inventory item with name, cost, rate, optional category, image, and tax information.

Request

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Item created successfully

Body

🟠400

🟠401

🟠409

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://dev.api.fieldedge.com/open-api/v1/items' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Type": "Inventory",
    "ExternalId": "EXT-1001",
    "name": "Air Filter",
    "description": "High efficiency air filter suitable for HVAC systems.",
    "cost": 20.5,
    "rate": 35,
    "categoryId": "b3a41f9f-2c62-4f0b-b6aa-6e2a2dfb9a11",
    "category": "HVAC:Filters",
    "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "taxable": true,
    "salesTaxCode": "TAX"
}'

Response Example

201 - response

{
    "data": {
        "itemId": "c4e8b7d2-9c63-4d88-bc6d-6d3c45fbc1c2",
        "externalId": "EXT-1001",
        "type": "Inventory",
        "name": "Air Filter",
        "description": "High efficiency air filter",
        "cost": 20.5,
        "rate": 35,
        "categoryId": "b3a41f9f-2c62-4f0b-b6aa-6e2a2dfb9a11",
        "imageUrl": "https://cdn.company.com/items/airfilter.png",
        "taxable": true,
        "salesTaxCode": "TAX",
        "salesTaxCodeId": "5c38b3b8-9e1a-4356-8f0a-fe626a9f67b1"
    }
}

Modified at 2026-03-19 11:30:01

Registers a new webhook endpoint to receive event notifications.

Retrieve a paginated list of inventory items with optional filters