Upsert item

PUT

/inventory/

Creates or updates an inventory item and returns its Internal ID.

Looks up an existing item by external ID, or by item code and item type
when no external ID is provided. If a match is found, updates it;
otherwise creates a new item, which requires an item type and a code.
Only the fields provided are changed; omitted fields remain unchanged.

Request

Body Params application/jsonRequired

Example

{
    "inv_type": "service",
    "code": "REF-410A",
    "sales": 0,
    "purchase": 0,
    "description": "R-410A refrigerant cylinder (10 kg).",
    "tax": "tax",
    "is_labour": false,
    "external_id": "ITEM-1001",
    "coverage_uom": {
        "id": null,
        "external_id": "",
        "name": ""
    },
    "klass": {
        "id": null,
        "external_id": "",
        "name": ""
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://app.fieldinsight.com/public-api//inventory/' \
--header 'Content-Type: application/json' \
--data '{
    "inv_type": "service",
    "code": "REF-410A",
    "sales": 0,
    "purchase": 0,
    "description": "R-410A refrigerant cylinder (10 kg).",
    "tax": "tax",
    "is_labour": false,
    "external_id": "ITEM-1001",
    "coverage_uom": {
        "id": null,
        "external_id": "",
        "name": ""
    },
    "klass": {
        "id": null,
        "external_id": "",
        "name": ""
    }
}'

Responses

🟢200OK

application/json

Successful response.

Bodyapplication/json

Example

"501"

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🟠422Parameter Error

🟠429

Modified at 2026-10-30 03:40:11

Patch item

Remove item