FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. Item
  • Lead
    • Creates a new lead with customer details, appointment preferences, and service information.
      POST
    • Fetches lead details based on the provided lead identifier.
      GET
  • Customer
    • Creates a new customer
      POST
    • Updates an existing customer
      PUT
    • Search customers with optional filters
      GET
    • Retrieve customer details by ID
      GET
    • Retrieve customers based on address details.
      GET
    • Retrieve customer by phone number
      GET
  • Item Category
    • Retrieve list of item categories
      GET
    • Retrieve item category by id.
      GET
    • Create a new item category
      POST
    • Partially update an item category
      PATCH
  • Item
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Retrieve an inventory item by ID
      GET
    • Creates a new inventory item
      POST
    • Updates an existing inventory item
      PATCH
    • Bulk update inventory items
      PATCH
  • Warehouse
    • Create a new warehouse
      POST
    • Retrieve a paginated list of warehouses
      GET
    • Update an existing warehouse
      PATCH
    • Retrieve a warehouse by ID
      GET
  • Employee
    • Retrieve a paginated list of employees
      GET
    • Retrieve an employee by ID
      GET
  • Company
    • Retrieve company name by ID
  • WorkOrder
    • Retrieve a work order by ID
    • Retrieve a paginated list of work orders
    • Retrieve work orders at a given address
  • Invoice
    • Retrieve an invoice by ID
    • Retrieve a paginated list of invoices
  • Task
    • Retrieve a list of tasks
    • Retrieve a task bundle by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Rotate the HMAC signing secret for the registered webhook.
    • Delete the registered webhook for the authenticated account.
  1. Item

Bulk update inventory items

PATCH
/v1/items
Updates up to 50 inventory items in a single request. Items are fetched, patched in memory, and written to FieldEdge in a single batch call. Partial success is possible — the response always returns 207 Multi-Status with a per-item result for every submitted item.
Required scope: items:write

Request

Body Params application/jsonRequired

Examples

Responses

🟢207
application/json
Per-item results returned. Partial success is possible.
Bodyapplication/json

🟠400
🟠401
🟠403
🔴500
Request 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 '{
    "items": [
        {
            "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "Premium Filter",
            "cost": 12.5,
            "rate": 25,
            "active": true
        },
        {
            "itemId": "7cb92a11-1234-4321-abcd-0f1e2d3c4b5a",
            "category": "HVAC:Filters",
            "taxable": "true",
            "salesTaxCode": "TAX"
        }
    ]
}'
Response Response Example
207 - response
{
    "total": 3,
    "succeeded": 1,
    "failed": 2,
    "results": [
        {
            "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "status": 200,
            "data": {
                "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "externalId": "EXT-1001",
                "name": "Premium Filter",
                "description": "High efficiency HVAC filter",
                "cost": 12.5,
                "rate": 25,
                "categoryId": "b3a41f9f-2c62-4f0b-b6aa-6e2a2dfb9a11",
                "imageUrl": "https://cdn.company.com/items/premium-filter.png",
                "taxable": true,
                "salesTaxCode": "TAX",
                "salesTaxCodeId": "5c38b3b8-9e1a-4356-8f0a-fe626a9f67b1",
                "active": true
            },
            "error": null
        },
        {
            "itemId": "7cb92a11-1234-4321-abcd-0f1e2d3c4b5a",
            "status": 404,
            "data": null,
            "error": {
                "code": "INVALID_ITEM",
                "message": "One or more fields failed validation",
                "errors": [
                    {
                        "field": "itemId",
                        "code": "INVALID_ITEM",
                        "message": "Item Not Found"
                    }
                ]
            }
        },
        {
            "itemId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
            "status": 422,
            "data": null,
            "error": {
                "code": "INVALID_INPUT",
                "message": "One or more fields failed validation",
                "errors": [
                    {
                        "field": "name",
                        "code": "ALREADY_EXISTS",
                        "message": "item already exists for this account."
                    }
                ]
            }
        }
    ]
}
Modified at 2026-07-01 10:25:15
Previous
Updates an existing inventory item
Next
Create a new warehouse
Built with