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
    • Retrieve customer by phone number
      GET
    • Search customers with optional filters
      GET
    • Retrieve customers based on address details.
      GET
    • Retrieve customer details by ID
      GET
  • CustomerAttachments
    • Upload a file attachment to a customer record
      POST
    • Retrieve attachments for a customer
      GET
  • CustomerNotes
    • Create a note on a customer record
      POST
    • Retrieve all notes for a customer
      GET
    • Update an existing customer note
      PATCH
  • CustomerTags
    • Associate a tag with a customer
      POST
    • Remove a tag from a customer
      DELETE
    • Create a reusable customer tag
      POST
    • Retrieve tags
      GET
  • Item
    • Creates a new inventory item
      POST
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Bulk update inventory items
      PATCH
    • Updates an existing inventory item
      PATCH
    • Retrieve an inventory item by ID
      GET
    • Retrieve availability of an item across one or more warehouses
      GET
  • ItemCategory
    • Retrieve list of item categories
    • Create a new item category
    • Retrieve item category by id.
    • Partially update an item category
  • SalesTaxCode
    • Retrieve list of sales tax codes
  • WorkOrder
    • Retrieve a paginated list of work orders
    • Retrieve a work order by ID
    • Retrieve work orders at a given address, most recent first
    • Create a new work order
    • Update an existing work order
    • Retrieve list of business units
    • Retrieve business unit by id.
    • Retrieve list of lead sources
    • Retrieve lead source by id.
  • Assignments
    • Retrieve all technician assignments for a work order
    • Assign a technician to a work order
  • Agreement
    • Retrieve list of agreements
    • Retrieve agreement by id.
  • Invoice
    • Retrieve a paginated list of invoices
    • Retrieve an invoice by ID
  • Quote
    • Retrieve a paginated list of quotes
    • Retrieve a quote by ID
  • Task
    • Retrieve a task bundle by ID
    • Retrieve a list of tasks
  • Warehouse
    • Create a new warehouse
    • Retrieve a paginated list of warehouses
    • Update an existing warehouse
    • Retrieve a warehouse by ID
  • Employee
    • Retrieve a paginated list of employees
    • Retrieve an employee by ID
  • Company
    • Retrieve company name by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Delete the registered webhook for the authenticated account.
    • Rotate the HMAC signing secret for the registered webhook.
  1. Item

Creates a new inventory item

POST
/v1/items
Creates a new inventory item with name, cost, rate, optional category, image, and tax information.
Required scope: items:write

Request

Authorization
Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Item created successfully
Bodyapplication/json

🟠400
🟠401
🟠403
🟠409
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dev.api.fieldedge.com/open-api/v1/items' \
--header 'Content-Type: application/json' \
--data '{
    "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 Response Example
201 - Item created successfully
{
    "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-08-27 11:27:54
Previous
Retrieve tags
Next
Retrieve a paginated list of inventory items with optional filters
Built with