EZOfficeInventory API

https://ezo.io/ezofficeinventory/developers/
Admin
The EZOfficeInventory API allows paying clients to build custom integrations for managing fixed...
Tokens:86,962
Snippets:583
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example: Create a Bundle with Multiple Asset Types

Source: https://ezo.io/ezofficeinventory/developers

Example command demonstrating the creation of a bundle with a mix of fixed assets, stock assets, and inventory assets, specifying quantities and prices where applicable.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "bundle[name]=<bundle_name>" \
      -d "bundle[location_id]=<location_id>"
      -d "bundle[identification_number]=<identification_number>" \
      -d "bundle[description]=<Description>" \
      -d "asset_ids=1,2,3,4,5,6" \
      -d "asset_attributes[3][quantity]=2" \
      -d "asset_attributes[4][quantity]=2" \
      -d "asset_attributes[5][quantity]=2" \
      -d "asset_attributes[5][price]=10" \
      -d "asset_attributes[6][quantity]=2" \
      -d "asset_attributes[6][price]=30" \
      "https://<SUBDOMAIN>.ezofficeinventory.com/bundles.api?"


```

--------------------------------

### Start a Project

Source: https://ezo.io/ezofficeinventory/developers

This endpoint marks a project as in progress. It requires the project's unique identifier.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X PATCH \
      https://<SUBDOMAIN>.ezofficeinventory.com/projects/<PROJECT#>/mark_in_progress.api
```

--------------------------------

### Start a Project

Source: https://ezo.io/ezofficeinventory/developers

Marks a project as in progress. This action updates the project's status to indicate that it has begun.

```APIDOC
## Start a Project

### Description
Initiates a project by marking it as in progress.

### Method
PATCH

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/projects/<PROJECT#>/mark_in_progress.api

### Parameters
#### Path Parameters
- **PROJECT#** (integer) - Required - The unique identifier of the project to start.

### Request Example
(No request body required)

### Response
#### Success Response (200)
Confirmation of the project status update.

#### Response Example
(Response structure not provided in source)
```

--------------------------------

### Start Work Order

Source: https://ezo.io/ezofficeinventory/developers

Marks a specified work order as 'in progress'.

```APIDOC
## PATCH /tasks/<Work_Order#>/mark_in_progress.api

### Description
Marks a specified work order as being in progress.

### Method
PATCH

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/tasks/<Work_Order#>/mark_in_progress.api

### Parameters
#### Path Parameters
- **Work_Order#** (string) - Required - The unique identifier of the work order to start.

### Response
#### Success Response (200)
- **status** (string) - Confirmation of the status update.

#### Response Example
[Example of the success response]
```

--------------------------------

### Start Work Order

Source: https://ezo.io/ezofficeinventory/developers

Mark a specific work order as 'in progress' using its Work_Order#.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X PATCH \
      https://<SUBDOMAIN>.ezofficeinventory.com/tasks/<Work_Order#>/mark_in_progress.api?
```

--------------------------------

### Retrieve Reservation Requests Starting Today

Source: https://ezo.io/ezofficeinventory/developers

Get all reservation requests for assets, inventory, stock assets, and baskets that are starting today. Supports pagination.

```curl
curl -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/checkout_requests/filter.api? \
      all=true&start_date=mm/dd/yyyy&page=<PAGE_NUM | DEFAULT = 1>
        

```

--------------------------------

### Retrieve All Carts

Source: https://ezo.io/ezofficeinventory/developers

Get a list of all available carts in the system.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/baskets.api
```

--------------------------------

### Schedule Service for Asset

Source: https://ezo.io/ezofficeinventory/developers

Schedule a service for an asset. This requires service start and end dates, description, start and end times, and service type name. Optionally, set 'service[make_item_unavailable]' to true to make the item unavailable during the service period.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \
              -d "service[make_item_unavailable]=true"
              -d "service[end_date]=<Expected_Completion_Date>" \
              -d "service_end_time=<Expected_Completion_time>" \
              -d "service[start_date]=<Expected_start_Date>" \
              -d "service_start_time=<Expected_start_time>" \
              -d "service_type_name=<Service_Type>" \
              -d "service[description]=<Description>" \
              http://<SUBDOMAIN>.ezofficeinventory.com/assets/<ASSET#>/services.api?service_type=scheduled_service
        
```

--------------------------------

### Retrieve Assets in Service

Source: https://ezo.io/ezofficeinventory/developers

Retrieve a list of all assets currently in service. You can optionally include 'show_document_urls=true' to get document links. Specify the page number to paginate through results, with 25 assets per page.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \
              -d "show_document_urls=true" \
              "https://<SUBDOMAIN>.ezofficeinventory.com/assets/filter.api?for_service=true&status=assets_being_serviced&page=<PAGE_NUM | DEFAULT = 1>" 
        
```

--------------------------------

### Retry-After Header Example

Source: https://ezo.io/ezofficeinventory/developers

This header indicates the number of seconds to wait before retrying a request after receiving a 429 Too Many Requests response.

```text
Retry-After: 3600
```

--------------------------------

### Retrieve Stock Quantity by Location

Source: https://ezo.io/ezofficeinventory/developers

Get the stock quantity of a specific asset at a particular location. Requires the asset ID and location ID.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \
       -d "asset_id=<ASSET_ID>" \
       -d "location_id=<LOCATION_ID>" \
       https://<SUBDOMAIN>.ezofficeinventory.com/locations/get_quantity_by_location.api
```

--------------------------------

### Create reservation request

Source: https://ezo.io/ezofficeinventory/developers

Creates a new reservation request for a specific asset. Requires specifying the start and end dates, an optional note, and the user ID.

```APIDOC
## POST /assets/<ASSET#>/reservation_requests.api

### Description
Creates a new reservation request for a specific asset.

### Method
POST

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/assets/<ASSET#>/reservation_requests.api

### Parameters
#### Request Body
- **reservation_request[from]** (string) - Required - The start date for the reservation (mm/dd/yyyy).
- **reservation_request[to]** (string) - Required - The end date for the reservation (mm/dd/yyyy).
- **reservation_request[note]** (string) - Optional - Comments or notes for the reservation request.
- **user[id]** (string) - Required - The ID of the user making the reservation request.

### Request Example
```json
{
  "reservation_request[from]": "mm/dd/yyyy",
  "reservation_request[to]": "mm/dd/yyyy",
  "reservation_request[note]": "<COMMENTS>",
  "user[id]": "<USER_ID>"
}
```
```

--------------------------------

### Create Reservation Request

Source: https://ezo.io/ezofficeinventory/developers

Use this endpoint to create a new reservation request for an asset. Ensure to provide the start date, end date, and any relevant notes.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "reservation_request[from]=mm/dd/yyyy" \
      -d "reservation_request[to]=mm/dd/yyyy" \
      -d "reservation_request[note]=<COMMENTS>" \
      -d "user[id]=<USER_ID>"
      https://<SUBDOMAIN>.ezofficeinventory.com/assets/<ASSET#>/reservation_requests.api

```

--------------------------------

### Retrieve reservation requests starting today

Source: https://ezo.io/ezofficeinventory/developers

Retrieves all reservation requests for assets, inventory, stock assets, and baskets that are starting on the specified date.

```APIDOC
## GET /checkout_requests/filter.api

### Description
Retrieves all reservation requests for assets, inventory, stock assets, and baskets that are starting on the specified date.

### Method
GET

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/checkout_requests/filter.api

### Parameters
#### Query Parameters
- **all** (boolean) - Required - Set to `true` to retrieve all reservation requests.
- **start_date** (string) - Required - The date to filter reservation requests by (mm/dd/yyyy).
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1. Each page contains up to 25 reservation requests.

### Response
#### Success Response (200)
- **reservation_requests** (array) - A list of reservation request objects.
  - Each object contains details of a reservation request.
```

--------------------------------

### Create a Bundle

Source: https://ezo.io/ezofficeinventory/developers

Create a new bundle. `bundle[name]` and `asset_ids` are mandatory. For Asset Stock, `asset_attributes[Asset#][quantity]` is mandatory. For Inventory Asset, `asset_attributes[Asset#][quantity]` and `asset_attributes[Asset#][price]` are mandatory. Optional fields include `bundle[identification_number]`, `bundle[description]`, and `bundle[location_id]`.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "bundle[name]=<bundle_name>" \
      -d "bundle[location_id]=<location_id>"
      -d "bundle[identification_number]=<identification_number>" \
      -d "bundle[description]=<Description>" \
      -d "asset_ids=<Asset#><Asset#>" \
      -d "asset_attributes[<Asset#>][quantity]=<quantity>" \
      -d "asset_attributes[<Asset#>][price]=<price>" \
      "https://<SUBDOMAIN>.ezofficeinventory.com/bundles.api"


```

--------------------------------

### Create Package

Source: https://ezo.io/ezofficeinventory/developers

Use this endpoint to create a new package. Mandatory fields include package name and asset IDs. An optional description can also be provided.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "package[name]=<name>" \
      -d "package[description]=<description>" \
      -d "asset_ids=<Asset#> <Asset#>" \
      http://<SUBDOMAIN>.ezofficeinventory.com/packages.api
```

--------------------------------

### Create Project

Source: https://ezo.io/ezofficeinventory/developers

Creates a new project. The 'name' field is mandatory. Optional fields include 'identifier', 'description', 'expected_start_date', 'expected_end_date', 'user_ids', and 'contract_id'. Project settings for items, checkouts, reservations, purchase orders, tasks, baskets, and locations can also be configured.

```APIDOC
## Create Project

### Description
Creates a new project with specified details and settings.

### Method
POST

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/projects.api

### Parameters
#### Request Body
- **project[name]** (string) - Required - The name of the project.
- **project[identifier]** (string) - Optional - A unique identifier for the project.
- **project[description]** (string) - Optional - A description of the project.
- **project[expected_start_date]** (string) - Optional - The expected start date in 'mm/dd/yyyy' format.
- **project[expected_end_date]** (string) - Optional - The expected end date in 'mm/dd/yyyy' format.
- **project[project_setting_attributes][items_enabled]** (boolean) - Optional - Enable or disable item tracking for the project.
- **project[project_setting_attributes][checkouts_enabled]** (boolean) - Optional - Enable or disable checkout functionality for the project.
- **project[project_setting_attributes][reservations_enabled]** (boolean) - Optional - Enable or disable reservation functionality for the project.
- **project[project_setting_attributes][purchase_orders_enabled]** (boolean) - Optional - Enable or disable purchase order tracking for the project.
- **project[project_setting_attributes][tasks_enabled]** (boolean) - Optional - Enable or disable task management for the project.
- **project[project_setting_attributes][baskets_enabled]** (boolean) - Optional - Enable or disable basket functionality for the project.
- **project[project_setting_attributes][locations_enabled]** (boolean) - Optional - Enable or disable location tracking for the project.
- **user_ids** (string) - Optional - Comma-separated list of user IDs to associate with the project.
- **contract_id** (string) - Optional - Comma-separated list of contract IDs to associate with the project.

### Request Example
```json
{
  "project[name]": "<project_name>",
  "project[identifier]": "<identifier>",
  "project[description]": "<Description>",
  "project[expected_start_date]": "mm/dd/yyyy",
  "project[expected_end_date]": "mm/dd/yyyy",
  "project[project_setting_attributes][items_enabled]": true,
  "project[project_setting_attributes][checkouts_enabled]": true,
  "project[project_setting_attributes][reservations_enabled]": true,
  "project[project_setting_attributes][purchase_orders_enabled]": true,
  "project[project_setting_attributes][tasks_enabled]": true,
  "project[project_setting_attributes][baskets_enabled]": true,
  "project[project_setting_attributes][locations_enabled]": true,
  "user_ids": "<USER_ID>,<USER_ID>",
  "contract_id": "<CONTRACT_ID>,<CONTRACT_ID>"
}
```

### Response
#### Success Response (200)
Details of the created project.

#### Response Example
(Response structure not provided in source)
```

--------------------------------

### Retrieve Location-Based Thresholds

Source: https://ezo.io/ezofficeinventory/developers

Get location-specific threshold details for a given inventory item.

```APIDOC
## GET /inventory/<Inventory#>/location_based_thresholds.api

### Description
Retrieves the threshold details for an inventory item, broken down by specific locations.

### Method
GET

### Endpoint
`https://<SUBDOMAIN>.ezofficeinventory.com/inventory/<Inventory#>/location_based_thresholds.api`

### Parameters
#### Path Parameters
- **Inventory#** (string) - Required - The unique identifier of the inventory item.

### Response
#### Success Response (200)
- **thresholds** (object) - An object where keys are location IDs and values are the threshold quantities for that location.

#### Response Example
```json
{
  "thresholds": {
    "LOC456": 10,
    "LOC789": 5
  }
}
```
```

--------------------------------

### Create Package

Source: https://ezo.io/ezofficeinventory/developers

Creates a new package by specifying its name and associated assets. The package description is optional.

```APIDOC
## POST /packages.api

### Description
Creates a new package with a name, optional description, and a list of asset IDs.

### Method
POST

### Endpoint
`http://<SUBDOMAIN>.ezofficeinventory.com/packages.api`

### Parameters
#### Request Body
- **package[name]** (string) - Required - The name of the package.
- **package[description]** (string) - Optional - A description for the package.
- **asset_ids** (string) - Required - A space-separated list of asset IDs.

### Request Example
```json
{
  "package[name]": "<name>",
  "package[description]": "<description>",
  "asset_ids": "<Asset#> <Asset#>"
}
```

### Response
#### Success Response (200)
(Response details not provided in source)

#### Response Example
(Response example not provided in source)
```

--------------------------------

### Create a Bundle

Source: https://ezo.io/ezofficeinventory/developers

Creates a new bundle with specified assets and attributes. Requires bundle name and assets. Supports stock and inventory asset types with different mandatory fields.

```APIDOC
## Create a Bundle

### Description
Creates a new bundle with specified assets and attributes. Requires bundle name and assets. Supports stock and inventory asset types with different mandatory fields.

### Method
POST

### Endpoint
`https://<SUBDOMAIN>.ezofficeinventory.com/bundles.api`

### Parameters
#### Request Body
- **bundle[name]** (string) - Required - The name of the bundle.
- **bundle[location_id]** (integer) - Optional - The ID of the location for the bundle.
- **bundle[identification_number]** (string) - Optional - The identification number for the bundle.
- **bundle[description]** (string) - Optional - A description for the bundle.
- **asset_ids** (string) - Required - A comma-separated list of asset IDs to include in the bundle.
- **asset_attributes[Asset#][quantity]** (integer) - Required for Asset Stock. The quantity of the asset.
- **asset_attributes[Asset#][price]** (float) - Required for Inventory Asset. The price of the asset.

### Request Example (Mixed Asset Types)
```
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "bundle[name]=<bundle_name>" \
      -d "bundle[location_id]=<location_id>" \
      -d "bundle[identification_number]=<identification_number>" \
      -d "bundle[description]=<Description>" \
      -d "asset_ids=1,2,3,4,5,6" \
      -d "asset_attributes[3][quantity]=2" \
      -d "asset_attributes[4][quantity]=2" \
      -d "asset_attributes[5][quantity]=2" \
      -d "asset_attributes[5][price]=10" \
      -d "asset_attributes[6][quantity]=2" \
      -d "asset_attributes[6][price]=30" \
      "https://<SUBDOMAIN>.ezofficeinventory.com/bundles.api?"
```
```

--------------------------------

### Retrieve Reserved Dates for Inventory

Source: https://ezo.io/ezofficeinventory/developers

Get the reserved dates for a specific inventory item.

```APIDOC
## GET /assets/<Inventory#>/reserved_dates.api

### Description
Retrieves a list of dates for which a specific inventory item has been reserved.

### Method
GET

### Endpoint
`https://<SUBDOMAIN>.ezofficeinventory.com/assets/<Inventory#>/reserved_dates.api`

### Parameters
#### Path Parameters
- **Inventory#** (string) - Required - The unique identifier of the inventory item.

### Response
#### Success Response (200)
- **reserved_dates** (array) - A list of dates (in YYYY-MM-DD format) when the inventory item is reserved.

#### Response Example
```json
{
  "reserved_dates": [
    "2023-10-26",
    "2023-11-15"
  ]
}
```
```

--------------------------------

### Create a New Project

Source: https://ezo.io/ezofficeinventory/developers

Use this endpoint to create a new project. Mandatory fields include the project name, and optional fields allow for identifiers, descriptions, dates, and various project settings. User IDs and contract IDs can also be associated.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "project[name]=<project_name>" \
      -d "project[identifier]=<identifier>" \
      -d "project[description]=<Description>" \
      -d "project[expected_start_date]=mm/dd/yyyy" \
      -d "project[expected_end_date]=mm/dd/yyyy" \
      -d "project[project_setting_attributes][items_enabled]=<BOOLEAN>" \
      -d "project[project_setting_attributes][checkouts_enabled]=<BOOLEAN>" \
      -d "project[project_setting_attributes][reservations_enabled]=<BOOLEAN>" \
      -d "project[project_setting_attributes][purchase_orders_enabled]=<BOOLEAN>" \
      -d "project[project_setting_attributes][tasks_enabled]=<BOOLEAN>" \
      -d "project[project_setting_attributes][baskets_enabled]=<BOOLEAN>" \
      -d "project[project_setting_attributes][locations_enabled]=<BOOLEAN>" \
      -d "user_ids=<USER_ID>,<USER_ID>" \
      -d "contract_id=<CONTRACT_ID>,<CONTRACT_ID>" \
      https://<SUBDOMAIN>.ezofficeinventory.com/projects.api
```

--------------------------------

### Link StockAsset/Inventory Reservation with Project

Source: https://ezo.io/ezofficeinventory/developers

Use this cURL command to link a stock asset or inventory reservation to a project. Ensure you specify the project_id and other reservation details.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "inventory_reservation[from]=<mm/dd/yyyy>" \
      -d "inventory_reservation[to]=<mm/dd/yyyy>" \
      -d "inventory_reservation[quantity]=<QUANTITY>" \
      -d "inventory_reservation[price]=<PRICE>" \
      -d "inventory_reservation[location_number]=<LOCATION#>" \
      -d "inventory_reservation[reserved_to_location_number]=<LOCATION#>" \
      -d "inventory_reservation[project_id]=<PROJECT_ID>" \
      -d "user[id]=<USER_ID>" \
      https://<SUBDOMAIN>.ezofficeinventory.com/stock_assets/<ASSET#>/inventory_reservations.api

```

--------------------------------

### Retrieve Reservation Requests

Source: https://ezo.io/ezofficeinventory/developers

Get reservation requests made by a specific user. Pagination is supported.

```APIDOC
## GET /members/<USER_ID>/reservation_requests.api

### Description
Retrieves reservation requests made by a specific user.

### Method
GET

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/members/<USER_ID>/reservation_requests.api?page=<PAGE_NUM | DEFAULT = 1>

### Parameters
#### Path Parameters
- **USER_ID** (integer) - Required - The ID of the user.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1. Each page contains up to 25 entries.

### Request Example
```bash
curl -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/members/123/reservation_requests.api?page=1
```

### Response
#### Success Response (200)
- **reservation_requests** (array) - A list of reservation requests.
- **page** (integer) - The current page number.
- **total_pages** (integer) - The total number of pages available.

#### Response Example
```json
{
  "reservation_requests": [
    {
      "id": 501,
      "item_name": "Monitor",
      "requested_at": "2023-10-25T09:00:00Z"
    }
  ],
  "page": 1,
  "total_pages": 1
}
```
```

--------------------------------

### Create Inventory Reservation

Source: https://ezo.io/ezofficeinventory/developers

Use this endpoint to create a new inventory reservation. Ensure all required fields like dates, quantity, price, and user ID are provided.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "inventory_reservation[from]=mm/dd/yyyy" \
      -d "inventory_reservation[to]=mm/dd/yyyy" \
      -d "inventory_reservation[quantity]=<QUANTITY>" \
      -d "inventory_reservation[price]=<PRICE>" \
      -d "inventory_reservation[note]=<COMMENTS>" \
      -d "inventory_reservation[location_number]=<LOCATION#>" \
      -d "user[id]=<USER_ID>"
      https://<SUBDOMAIN>.ezofficeinventory.com/inventory/<INVENTORY#>/inventory_reservations.api
```

--------------------------------

### Retrieve Check In/Out History

Source: https://ezo.io/ezofficeinventory/developers

Get the check-in/check-out history for a specific user. Pagination is supported.

```APIDOC
## GET /members/<USER_ID>/checkin_checkout_history.api

### Description
Retrieves the check-in/check-out history for a specific user.

### Method
GET

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/members/<USER_ID>/checkin_checkout_history.api?page=<PAGE_NUM | DEFAULT = 1>

### Parameters
#### Path Parameters
- **USER_ID** (integer) - Required - The ID of the user.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1. Each page contains up to 25 history entries.

### Request Example
```bash
curl -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/members/123/checkin_checkout_history.api?page=1
```

### Response
#### Success Response (200)
- **history** (array) - A list of check-in/check-out history entries.
- **page** (integer) - The current page number.
- **total_pages** (integer) - The total number of pages available.

#### Response Example
```json
{
  "history": [
    {
      "action": "checked_out",
      "item_name": "Dell Laptop",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ],
  "page": 1,
  "total_pages": 3
}
```
```

--------------------------------

### Create Stock Asset Reservation

Source: https://ezo.io/ezofficeinventory/developers

Use this endpoint to create a new reservation for a stock asset. Ensure all required fields like dates, quantity, price, and location details are provided.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "inventory_reservation[from]=mm/dd/yyyy" \
      -d "inventory_reservation[to]=mm/dd/yyyy" \
      -d "inventory_reservation[quantity]=<QUANTITY>" \
      -d "inventory_reservation[price]=<PRICE>" \
      -d "inventory_reservation[note]=<COMMENTS>" \
      -d "inventory_reservation[location_number]=<LOCATION#>" \
      -d "inventory_reservation[reserved_to_location_number]=<LOCATION#>" \
      -d "user[id]=<USER_ID>" \
      https://<SUBDOMAIN>.ezofficeinventory.com/stock_assets/<STOCKASSET#>/inventory_reservations.api
```

--------------------------------

### Retrieve All Bundles

Source: https://ezo.io/ezofficeinventory/developers

Retrieve a list of all bundles. Each page contains 25 bundles; specify `page` for subsequent pages.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/bundles.api?page=<PAGE_NUM>


```

--------------------------------

### Retrieve Inventory Reservation History

Source: https://ezo.io/ezofficeinventory/developers

Get the inventory reservation history for a specific user. Pagination is supported.

```APIDOC
## GET /members/<USER_ID>/inventory_reservations.api

### Description
Retrieves the inventory reservation history for a specific user.

### Method
GET

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/members/<USER_ID>/inventory_reservations.api?page=<PAGE_NUM | DEFAULT = 1>

### Parameters
#### Path Parameters
- **USER_ID** (integer) - Required - The ID of the user.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1. Each page contains up to 25 history entries.

### Request Example
```bash
curl -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/members/123/inventory_reservations.api?page=1
```

### Response
#### Success Response (200)
- **inventory_reservations** (array) - A list of inventory reservation history entries.
- **page** (integer) - The current page number.
- **total_pages** (integer) - The total number of pages available.

#### Response Example
```json
{
  "inventory_reservations": [
    {
      "id": 601,
      "item_name": "Desk Chair",
      "reserved_at": "2023-10-24T11:00:00Z"
    }
  ],
  "page": 1,
  "total_pages": 1
}
```
```

--------------------------------

### Retrieve Reserved Dates for an Asset

Source: https://ezo.io/ezofficeinventory/developers

Get the reserved dates for a specific asset by providing its stock number.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \
    https://<SUBDOMAIN>.ezofficeinventory.com/assets/<Asset Stock#>/reserved_dates.api
```

--------------------------------

### Create a New Location

Source: https://ezo.io/ezofficeinventory/developers

Use this endpoint to create a new location. Mandatory fields include the location name. Optional fields allow for specifying city, state, zip code, street addresses, status, and a description.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "location[name]=<LOCATION_NAME>" \
      -d "location[city]=<CITY_NAME>" \
      -d "location[status]=<active>" \
      https://<SUBDOMAIN>.ezofficeinventory.com/locations.api
```

--------------------------------

### Retrieve Check In/Out Stock History

Source: https://ezo.io/ezofficeinventory/developers

Get the stock check-in/check-out history for a specific user. Pagination is supported.

```APIDOC
## GET /members/<USER_ID>/checkin_checkout_history_for_stock.api

### Description
Retrieves the stock check-in/check-out history for a specific user.

### Method
GET

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/members/<USER_ID>/checkin_checkout_history_for_stock.api?page=<PAGE_NUM | DEFAULT = 1>

### Parameters
#### Path Parameters
- **USER_ID** (integer) - Required - The ID of the user.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1. Each page contains up to 25 history entries.

### Request Example
```bash
curl -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/members/123/checkin_checkout_history_for_stock.api?page=1
```

### Response
#### Success Response (200)
- **history** (array) - A list of stock check-in/check-out history entries.
- **page** (integer) - The current page number.
- **total_pages** (integer) - The total number of pages available.

#### Response Example
```json
{
  "history": [
    {
      "action": "checked_in",
      "item_name": "Keyboard",
      "timestamp": "2023-10-26T15:30:00Z"
    }
  ],
  "page": 1,
  "total_pages": 1
}
```
```

--------------------------------

### Retrieve All Checklists

Source: https://ezo.io/ezofficeinventory/developers

Fetch all checklists available in the system. Use the 'page' parameter to paginate through results, with each page containing up to 25 checklists.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/checklists/page=<PAGE_NUM | DEFAULT = 1>
```

--------------------------------

### Get Background Job Details

Source: https://ezo.io/ezofficeinventory/developers

Retrieves detailed information about a specific background job, including its status and any associated attachments.

```APIDOC
## GET /background_jobs/<ID>.api

### Description
Retrieves detailed information about a specific background job.

### Method
GET

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/background_jobs/<ID>.api

### Parameters
#### Path Parameters
- **ID** (string) - Required - The unique identifier of the background job.

#### Headers
- **token** (string) - Required - Your company token for authentication.

### Response
#### Success Response (200)
- **background_job** (object) - An object containing details of the background job.
  - **id** (string) - The unique identifier for the background job.
  - **status** (string) - The current status of the background job (e.g., "Completed", "Failed").
  - **attachments** (array) - A list of attachments associated with the background job (if any).
    - **order** (integer) - The order of the attachment.
    - **mime-type** (string) - The MIME type of the attachment.
    - **download_url** (string) - The URL to download the attachment.
    - **download_url_expires_at** (string) - The expiration date and time for the download URL.
  - **data** (object) - Contains error details if the job failed.
    - **error** (string) - A message describing the error.

### Response Example (Single Attachment)
```json
{
  "background_job": {
    "id": "59eff6ae-b983-4a80-a829-88e1c3d8a422",
    "status": "Completed",
    "attachments": [
      {
        "order": 1,
        "mime-type": "text/csv",
        "download_url": "https://s3.amazonaws.com/download/custom_report_2025-02-04_014937.csv",
        "download_url_expires_at": "2025-02-04T02:50:54Z"
      }
    ]
  }
}
```

### Response Example (Multiple Attachments)
```json
{
  "background_job": {
    "id": "b8ef86c8-eabe-4459-a2ce-884fe3f5b0e7",
    "status": "Completed",
    "attachments": [
      {
        "order": 1,
        "mime-type": "text/csv",
        "download_url": "https://s3.amazonaws.com/download/custom_report_part_1.csv",
        "download_url_expires_at": "2025-02-04T01:51:59Z"
      },
      {
        "order": 2,
        "mime-type": "text/csv",
        "download_url": "https:/s3.amazonaws.com/download/custom_report_part_2.csv",
        "download_url_expires_at": "2025-02-04T01:51:59Z"
      },
      {
        "order": 3,
        "mime-type": "text/csv",
        "download_url": "https://s3.amazonaws.com/download/custom_report_part_3.csv",
        "download_url_expires_at": "2025-02-04T01:51:59Z"
      },
      {
        "order": 4,
        "mime-type": "text/csv",
        "download_url": "https://s3.amazonaws.com/download/custom_report_part_4.csv",
        "download_url_expires_at": "2025-02-04T01:51:59Z"
      }
    ]
  }
}
```

### Error Response Example
```json
{
  "background_job": {
    "id": "b42a3950-22ff-440b-a994-42c0d3efd1e1",
    "status": "Failed",
    "data": {
      "error": "An unexpected error occurred while processing the report."
    }
  }
}
```
```

--------------------------------

### Get Assets in Work Orders by Type

Source: https://ezo.io/ezofficeinventory/developers

Retrieves assets associated with work orders of a specific type. Supports pagination.

```APIDOC
## GET /tasks.api?task_type=<Work_Order_Type>&page=<PAGE_NUM | DEFAULT = 1>

### Description
Retrieves assets from work orders filtered by their type. Supports pagination, with each page containing up to 25 work orders.

### Method
GET

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/tasks.api

### Parameters
#### Query Parameters
- **task_type** (string) - Required - The type of work orders to filter by.
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.

### Response
#### Success Response (200)
- **work_orders** (array) - A list of work orders matching the specified type.
- **total_pages** (integer) - The total number of pages available.

#### Response Example
[Example of the success response]
```

--------------------------------

### Receive Purchase Order Items

Source: https://ezo.io/ezofficeinventory/developers

Receive all items for a purchase order and specify payment details.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X PATCH \      -F "payment_details[amount]=<AMOUNT>" \      https://<SUBDOMAIN>.ezofficeinventory.com/purchase_orders/<PO#>/receive_items.api
```

--------------------------------

### Retrieve Stock Quantity by Location

Source: https://ezo.io/ezofficeinventory/developers

Get the stock quantity for a specific asset at a particular location. Requires the asset_id and location_id.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \      -d "asset_id=<ASSET_ID>"      -d "location_id=<LOCATION_ID>"      https://<SUBDOMAIN>.ezofficeinventory.com/locations/get_quantity_by_location.api
```

--------------------------------

### Retrieve All Purchase Orders

Source: https://ezo.io/ezofficeinventory/developers

Fetch a list of all purchase orders associated with the account.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \      https://<SUBDOMAIN>.ezofficeinventory.com/purchase_orders.api
```

--------------------------------

### Retrieve Assets in Service by Type

Source: https://ezo.io/ezofficeinventory/developers

Use this command to retrieve all assets currently in service, filtered by their service type. The `service_type` parameter is mandatory. Each page returns 25 assets; specify `page` for subsequent pages.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \
              -d "service_type=<Service_type_name>" \
              "https://<SUBDOMAIN>.ezofficeinventory.com/assets/filter.api?for_service=true&status=assets_being_serviced&page=<PAGE_NUM | DEFAULT = 1>" 
        
```

--------------------------------

### Retrieve Location-Based Thresholds for Inventory

Source: https://ezo.io/ezofficeinventory/developers

Get location-specific threshold details for an inventory item by providing its inventory number in the URL.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/inventory/<Inventory#>/location_based_thresholds.api
```

--------------------------------

### Create Purchase Order

Source: https://ezo.io/ezofficeinventory/developers

Use this endpoint to create a new purchase order by specifying the vendor ID.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \      -d "vendor_id=<VENDOR_ID>" \      https://<SUBDOMAIN>.ezofficeinventory.com/purchase_orders.api
```

--------------------------------

### Link Checkout History with Project

Source: https://ezo.io/ezofficeinventory/developers

This cURL command links checkout history with a project. Specify the project_id and checkout details, including optional overrides and custom attributes.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X PUT \
      -d "checkout_values[location_id]=<LOCATION_ID>" \
      -d "checkout_values[comments]=<COMMENTS>" 
      -d "till=<Date>" 
      -d "till_time=<Time>" 
      -d "project_id=<PROJECT_ID>"
      -d "checkout_values[override_conflicting_reservations]=true" 
      -d "checkout_values[override_my_conflicting_reservations]=true" 
      -d "checkout_values[c_attr_vals][<CUSTOM_ATTRIBUTE_NAME>]=<CUSTOM_ATTRIBUTE_VALUE>" \
      https://<SUBDOMAIN>.ezofficeinventory.com/assets/<ASSET#>/checkout.api?user_id=<USER_ID>

```

--------------------------------

### Get Items Checked Out to a User

Source: https://ezo.io/ezofficeinventory/developers

Retrieve a list of items that have been checked out to a specific user. Requires the user's ID and item type.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X PUT \
      -d "item_type=<ASSET_TYPE>" \
      https://<SUBDOMAIN>.ezofficeinventory.com/members/<USER_ID>/checked_out_items.api?page=<PAGE_NUM | DEFAULT = 1>
```

--------------------------------

### Create Group - API

Source: https://ezo.io/ezofficeinventory/developers

Use this endpoint to create a new group. Mandatory fields include group name. Optional fields allow for description, asset depreciation mode, and depreciation rates for specific methods.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "group[name]=<GROUP_NAME>" \
      -d "group[description]=<DESCRIPTION>" \
      -d "group[asset_depreciation_mode]=<ASSET_DEPRECIATION_MODE>" \
      -d "depreciation_rates[depreciation method name]=<DEPRECIATION_RATE>" \
      https://<SUBDOMAIN>.ezofficeinventory.com/groups.api

```

--------------------------------

### Retrieve Current Checkouts

Source: https://ezo.io/ezofficeinventory/developers

Get the current checkout status for line items of a stock asset. Requires the Asset# and current checkout status.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \        -d "current_checkout_status=<CURRENT_CHECKOUT_STATUS>" \        -d "user_id=<USER_ID>" \        https://<SUBDOMAIN>.ezofficeinventory.com/stock_assets/<ASSET#>/get_current_checkouts.api
```

--------------------------------

### Create Subgroup

Source: https://ezo.io/ezofficeinventory/developers

Use this command to create a new subgroup. Mandatory fields include sub_group[name]. Optional fields are sub_group[description] and sub_group[parent_id].

```bash
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "sub_group[name]=<SUBGROUP_NAME>" \
      -d "sub_group[description]=<DESCRIPTION>" \
      -d "sub_group[parent_id]=<PARENT_SUBGROUP_ID>"\
      https://<SUBDOMAIN>.ezofficeinventory.com/groups/<GROUP_ID>/sub_groups.api

```

--------------------------------

### Retrieve Location Details

Source: https://ezo.io/ezofficeinventory/developers

Get detailed information for a specific location by providing its ID. Custom fields can be included in the response by setting the 'include_custom_fields' parameter.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      -d "include_custom_fields=true" \
      https://<SUBDOMAIN>.ezofficeinventory.com/locations/<LOCATION#>.api
```

--------------------------------

### Retrieve User Listings

Source: https://ezo.io/ezofficeinventory/developers

Fetches all user listings, with optional pagination. Defaults to the first page if no page number is provided.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/user_listings.api?page=<PAGE_NUM | DEFAULT = 1>

```

--------------------------------

### Retrieve Project Details

Source: https://ezo.io/ezofficeinventory/developers

Use this cURL command to retrieve the details of a specific project. The project ID must be included in the URL.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/projects/<PROJECT#>.api

```

--------------------------------

### Retrieve Single Vendor

Source: https://ezo.io/ezofficeinventory/developers

Get the details of a specific vendor using its unique ID. The 'include_custom_fields' parameter can be set to true to include custom fields in the response.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      -d "include_custom_fields=true" \
      https://<SUBDOMAIN>.ezofficeinventory.com/vendors/<VENDOR_ID>.api
```

--------------------------------

### Get Specific Background Job Details

Source: https://ezo.io/ezofficeinventory/developers

Retrieve detailed information for a single background job by specifying its unique ID. This is useful for checking the status and any associated attachments.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/background_jobs/<ID>/.api

```

--------------------------------

### Retrieve All Assets

Source: https://ezo.io/ezofficeinventory/developers

This command retrieves all assets. Optional parameters can be included to show custom fields, document URLs, image URLs, and service details. Use the 'page' parameter to paginate through results.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      -d "include_custom_fields=true" \
      -d "show_document_urls=true" \
      -d "show_image_urls=true" \
      -d "show_document_details=true" \
      https://<SUBDOMAIN>.ezofficeinventory.com/assets.api?page=<PAGE_NUM | DEFAULT = 1>
```

--------------------------------

### Get Filtered Work Orders

Source: https://ezo.io/ezofficeinventory/developers

Retrieves a paginated list of work orders based on a specified filter. Available filters include 'complete', 'in_progess', 'review_pending', and 'open'.

```APIDOC
## GET /tasks.api

### Description
Retrieves a paginated list of work orders based on a specified filter. This endpoint allows users to query work orders by their status.

### Method
GET

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/tasks.api

### Parameters
#### Query Parameters
- **filter** (string) - Required - The filter value for work orders (e.g., 'complete', 'in_progess', 'review_pending', 'open').
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.

### Request Example
```json
{
  "filter": "<FILTER_VALUE>",
  "page": "<PAGE_NUM | DEFAULT = 1>"
}
```

### Response
#### Success Response (200)
- **total_pages** (integer) - The total number of pages available.
(Other response fields not provided in source)

#### Response Example
(Response example not provided in source)
```

--------------------------------

### Create Vendor

Source: https://ezo.io/ezofficeinventory/developers

Creates a new vendor with the provided details. The 'name' field is mandatory.

```APIDOC
## POST /vendors.api

### Description
Creates a new vendor.

### Method
POST

### Endpoint
https://<SUBDOMAIN>.ezofficeinventory.com/vendors.api

### Parameters
#### Request Body
- **vendor[name]** (string) - Required - The name of the vendor.
- **vendor[description]** (string) - Optional - A description of the vendor.
- **vendor[website]** (string) - Optional - The website of the vendor.
- **vendor[address]** (string) - Optional - The address of the vendor.
- **vendor[contact_person_name]** (string) - Optional - The name of the contact person.
- **vendor[email]** (string) - Optional - The email address of the vendor.
- **vendor[phone_number]** (string) - Optional - The phone number of the vendor.
- **vendor[fax]** (string) - Optional - The fax number of the vendor.
- **vendor[custom_attributes][CUSTOM_ATTRIBUTE_NAME]** (string) - Optional - Custom attributes for the vendor.

### Request Example
```
curl  -H "token:<COMPANY_TOKEN>" -X POST \
      -d "vendor[name]=<NAME>" \
      -d "vendor[description]=<DESCRIPTION>" \
      -d "vendor[website]=<WEBSITE>" \
      -d "vendor[address]=<ADDRESS>" \
      -d "vendor[contact_person_name]=<CONTACT_PERSON_NAME>" \
      -d "vendor[email]=<EMAIL>" \
      -d "vendor[phone_number]=<PHONE NUMBER>" \
      -d "vendor[fax]=<FAX>" \
      -d "vendor[custom_attributes][CUSTOM_ATTRIBUTE_NAME]=<CUSTOM_ATTRIBUTE_VALUE>" \
      https://<SUBDOMAIN>.ezofficeinventory.com/vendors.api
```
```

--------------------------------

### Retrieve Default Member Address

Source: https://ezo.io/ezofficeinventory/developers

Retrieves the default shipping address for a given member. This is a direct endpoint to get the primary address without needing to specify an address ID.

```bash
curl -H "token:<COMPANY_TOKEN>" -X GET \
  https://<SUBDOMAIN>.ezofficeinventory.com/users/<Member_ID>/shipping_addresses/default_address.api
```

--------------------------------

### Get Filtered Work Orders

Source: https://ezo.io/ezofficeinventory/developers

Retrieve work orders based on their status. Specify a filter value such as 'complete', 'in_progress', 'review_pending', or 'open'. Pagination is supported via the 'page' parameter.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/tasks.api?filter=<FILTER_VALUE>&page=<PAGE_NUM | DEFAULT = 1>
```

--------------------------------

### Retrieve Item Quantities by Location

Source: https://ezo.io/ezofficeinventory/developers

Fetches the quantity of assets, asset stocks, or inventory stocks for a given location ID.

```bash
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/locations/<LOCATION#>/quantities_by_asset_ids.api
```

--------------------------------

### Get Assets in Work Orders by Type

Source: https://ezo.io/ezofficeinventory/developers

Retrieve assets associated with work orders of a specific type. You can paginate results using the 'page' parameter, with each page containing up to 25 work orders. The response includes the total number of pages available.

```curl
curl  -H "token:<COMPANY_TOKEN>" -X GET \
      https://<SUBDOMAIN>.ezofficeinventory.com/tasks.api?task_type=<Work_Order_Type>&page=<PAGE_NUM | DEFAULT = 1>
```
Tokens:
Raw