Updates an existing inventory item

PATCH

/v1/items/{itemId}

Updates an inventory item by itemId. Only mutable fields such as name, description, cost, rate, category, image, and tax information can be updated.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Item updated successfully

Body

🟠400

🟠401

🟠404

🟠409

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://dev.api.fieldedge.com/open-api/v1/items/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Premium Air Filter",
    "description": "Updated high efficiency air filter for HVAC systems.",
    "cost": 22.5,
    "rate": 38,
    "categoryId": "b3a41f9f-2c62-4f0b-b6aa-6e2a2dfb9a11",
    "category": "HVAC:Filters",
    "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "taxable": true,
    "salesTaxCode": "TAX",
    "Active": true
}'

Response Example

200 - response

{
    "data": {
        "itemId": "c4e8b7d2-9c63-4d88-bc6d-6d3c45fbc1c2",
        "externalId": "EXT-1001",
        "name": "Premium Air Filter",
        "description": "Updated high efficiency air filter for HVAC systems.",
        "cost": 22.5,
        "rate": 38,
        "categoryId": "b3a41f9f-2c62-4f0b-b6aa-6e2a2dfb9a11",
        "imageUrl": "https://cdn.company.com/items/premium-airfilter.png",
        "taxable": true,
        "salesTaxCode": "TAX",
        "salesTaxCodeId": "5c38b3b8-9e1a-4356-8f0a-fe626a9f67b1",
        "Active": true
    }
}

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

Retrieve a paginated list of inventory items with optional filters

Retrieve an inventory item by ID