Skip to content

Sortly API

The Sortly API lets you work with your inventory from your own systems: add and update items, keep stock levels in sync, and track what goes out on a job.

Available on the Sortly Enterprise Plan. All requests go to https://api.sortly.co over HTTPS and return JSON. Email dev-support@sortly.com with questions or issues.

New here? Start with Getting Started, then read Items and Folders so the vocabulary in the endpoint reference makes sense. Once you know what you're building, jump to the matching Use Case Guide.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
https://api.sortly.co

Getting Started

Make your first Sortly API call in about five minutes.

Guides

The mechanics every integration needs, whatever you are building: how to authenticate, how to page through results, what the rate limit costs you, and what Sortly sends back when something goes wrong.

Core Concepts

The vocabulary the endpoint reference assumes you already have. Read these once and the field names in the reference stop needing explanation.

Build Your Inventory

Goal: get your existing inventory into Sortly from a spreadsheet, database or another system.

Every command below runs as-is once you swap in your own secret key.

Manage Your Inventory

Goal: keep the inventory you have already loaded accurate as it changes: what it looks like, how much of it there is, and where it sits.

Track Stock Levels

Goal: be told when something is running low, instead of watching it yourself.

Sync Inventory

Goal: keep another system (an ERP, a warehouse tool, a dashboard) in step with Sortly.

Sync Jobs

Goal: keep Sortly jobs in step with the work orders in your external system, from the moment one is raised to the moment it closes, so field staff work against accurate inventory and nobody keys the same movement in twice.

A job is a work order. Creating one also creates a folder to hold the items assigned to it. Jobs move through three statuses: not_started, in_progress, completed.

Each subsection below maps to one event in your system. Your system owns the job lifecycle and drives each of these calls; where you need to see the state on the Sortly side, read it with GET /api/v1/jobs on whatever schedule suits you.

Sync Purchase Orders

Goal: keep Sortly purchase orders in step with the accounting or ordering system you buy through, so both sides agree on what was ordered, what it costs and where it has got to.

A purchase order records what you ordered from a vendor and on what terms, with a list of line items drawn from your inventory. You don't need to send amount, sub_total, total or line_number: Sortly works them out from the lines.

How an order moves:

  • draft, ready_for_review and approved can each move to one another, or on to ordered
  • From ordered you can request voided or closed
  • From ordered, receiving stock also moves the order to partially_received and then received, through the receive flow rather than a status call
  • From partially_received or received, the only status you can request is closed
  • voided and closed are final

For the transitions themselves, see Manage PO Statuses.

Manage PO Statuses

Goal: move a Sortly purchase order to match where it has got to in your own process, whether that decision was made in another system or over email.

Every transition uses the same endpoint and the same two fields: the target status and the version you got from your last read.

  • A stale version is rejected with 409. Read immediately before writing, and retry with the new one.
  • Sending a status the order already has changes nothing, so a retried delivery is safe.
FromCan move to
draft, ready_for_review, approvedeach other, or ordered
orderedvoided or closed
partially_received, receivedclosed
voided, closedfinal

Anything outside that returns 400. received and partially_received cannot be requested here at all: Sortly sets them when a delivery is recorded against the order, either in the app or through the receive endpoint.

Items

Items are the things you track: stock, tools, assets, supplies. Each one has a quantity and can carry a price, photos, tags and custom fields.

Items and folders share these endpoints; type is what tells them apart. Pass "type": "item" here. For the folder side of the same endpoints, see Folders.

Operations

Folders

Folders are how you organize inventory by location, category, job, or whatever fits how you work. They can be nested, and items live inside them.

Folders use the same endpoints as items, with "type": "folder" and no quantity or price. Nest one inside another by setting parent_id; leave it out for the top level. To list a folder's contents, pass its id as folder_id when listing items.

Operations

Custom Fields

The extra fields defined on your account. Fetch these to get the custom_attribute_id values you need when writing custom field values onto items.

Operations

Units of Measure

The units available for tracking quantity: weight, length, volume and count.

Operations

Alerts

Alerts tell your team when stock runs low, or when a date you're tracking is coming up. Two kinds: Quantity and DateReminder.

Operations

Purchase Orders

Purchase orders record what you have ordered from a vendor and on what terms. Each one carries vendor and ship-to details plus a list of line items drawn from your inventory.

How an order moves:

  • draft, ready_for_review and approved can each move to one another, or on to ordered
  • From ordered you can request voided or closed
  • Receiving stock moves an ordered order to partially_received and then received, through the receive flow rather than a status call
  • From partially_received or received, the only status you can request is closed
  • voided and closed are final

Use the status endpoint for these transitions rather than the update endpoint.

Operations

Jobs

Jobs are work orders. Create a job, assign items to it, move it through not_started, in_progress and completed, and return items when it's done.

Operations

Create a Job

Request

Creates a job and its Job folder. Starts in the not_started status. Name must be unique in the company.

Security
BearerAuth
Bodyapplication/json
namestringrequired

Name of the job. Must be unique within the company. Max 190 characters.

notesstring

Job notes. Max 4000 characters.

start_datestring(date)

Date the job starts, as YYYY-MM-DD.

Example: "2026-08-10"
end_datestring(date)

Date the job is expected to be finished by, as YYYY-MM-DD.

Example: "2026-08-14"
external_job_linkstring(uri)

Link to this job in an external system.

subfoldersArray of objects

Subfolders to create inside the job folder, up to 25. After creation, manage folders through the items endpoints.

custom_field_valuesArray of objects<= 2 items

Custom field values to set. A job holds at most 2.

curl -X POST 'https://api.sortly.co/api/v1/jobs' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Rooftop HVAC install", "start_date": "2026-08-10", "end_date": "2026-08-14", "notes": "Bring spare filters"}'

Responses

Created

Headers
Sortly-Rate-Limit-Maxstring
Sortly-Rate-Limit-Remainingstring
Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "id": 101,
    "name": "HVAC Repair - Unit 4B",
    "status": "not_started",
    "folder_id": 4200,
    "custom_field_values": [],
    "created_by": { … },
    "updated_by": { … },
    "created_at": "2026-07-31T07:50:21.524205Z",
    "updated_at": "2026-07-31T07:50:21.524222Z",
    "version": 1,
    "start_date": null,
    "end_date": null,
    "notes": "Check refrigerant levels before starting.",
    "external_job_link": null,
    "started_at": null,
    "completed_at": null
  }
}

Fetch a Job

Request

Returns a single Job by its ID, including its current status, metadata, assigned item counts, and custom field values.

Security
BearerAuth
Path
job_idnumberrequired

ID of the job

Example: 101
curl 'https://api.sortly.co/api/v1/jobs/678' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'Accept: application/json'

Responses

OK

Headers
Sortly-Rate-Limit-Maxstring
Sortly-Rate-Limit-Remainingstring
Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "id": 101,
    "name": "HVAC Repair - Unit 4B",
    "status": "not_started",
    "folder_id": 4200,
    "custom_field_values": [],
    "created_by": { … },
    "updated_by": { … },
    "created_at": "2026-07-31T07:50:21.524205Z",
    "updated_at": "2026-07-31T07:50:21.524222Z",
    "version": 1,
    "start_date": null,
    "end_date": null,
    "notes": "Check refrigerant levels before starting.",
    "external_job_link": null,
    "started_at": null,
    "completed_at": null
  }
}

Update a Job

Request

Updates the job's own details: name, dates, notes, external link and custom field values. It does not touch the job's inventory.

  • Any nullable field you omit or send as null is cleared, so fetch the job first and send it back with your changes.
  • Custom field values are the exception: the ones you send are set, and the rest keep their value. A job holds up to 2.
  • To add items to the job, use Pull Items into Job. To change status, use the status endpoint.
Security
BearerAuth
Path
job_idnumberrequired

ID of the job

Example: 101
Bodyapplication/json
namestringrequired

Name of the job. Must be unique within the company. Max 190 characters.

notesstring

Job notes. Omit or send null to clear. Max 4000 characters.

start_datestring(date)

Date the job starts, as YYYY-MM-DD. Omit or send null to clear.

end_datestring(date)

Date the job is expected to be finished by, as YYYY-MM-DD. Omit or send null to clear.

external_job_linkstring(uri)

Link to this job in an external system. Omit or send null to clear.

custom_field_valuesArray of objects<= 2 itemsrequired

Sets the values it carries. A job holds at most 2. Send value null to clear one field. Fields left out keep their current value, so an empty array changes nothing.

custom_field_values[].​custom_field_idnumberrequired

ID of the job custom field.

custom_field_values[].​valuestring

The value to store. Max 191 characters.

custom_field_values[].​versionnumber

Version of the stored value, from the last read of the job.

versionnumberrequired

The version returned by the last read of this job. A stale version is rejected with 409.

curl -X PUT 'https://api.sortly.co/api/v1/jobs/678' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Rooftop HVAC install", "version": 3, "custom_field_values": []}'

Responses

OK

Headers
Sortly-Rate-Limit-Maxstring
Sortly-Rate-Limit-Remainingstring
Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "id": 101,
    "name": "HVAC Repair - Unit 4B",
    "status": "not_started",
    "folder_id": 4200,
    "custom_field_values": [],
    "created_by": { … },
    "updated_by": { … },
    "created_at": "2026-07-31T07:50:21.524205Z",
    "updated_at": "2026-07-31T07:50:21.524222Z",
    "version": 1,
    "start_date": null,
    "end_date": null,
    "notes": "Check refrigerant levels before starting.",
    "external_job_link": null,
    "started_at": null,
    "completed_at": null
  }
}

Changelog

Aug 5, 2026. Added Purchase Orders: list, create, fetch, update and change status.

Jul 31, 2026. Added Jobs: list, create, fetch, update, change status and delete, plus adding items to a job and returning them.

Jun 17, 2021. Added yard and gallon units of measure.

Jun 5, 2021. Added support for item variants (Item Groups).

Jan 4, 2021. Renamed attribute_value to value on custom field values (attribute_value still works). Added tags to item reads and search.

Sep 1, 2020. Added the search endpoint.

Jun 15, 2020. Added alerts.

Mar 2, 2019. First release.

© Sortly Inc.