List Part Locations

Returns a list of Part Locations set up in your account.

Responses

Response Headers

X-PaginationLimit string
The per page limit. Currently set to 100 but subject to change at any time.
X-Pagination-Current-Page string
The current page. Defaults to 1.
X-Pagination-Total-Pages string
The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.
X-Pagination-Total-Count string
The total number of records in the result set (across all pages).

application/json

Schema
Example (from schema)

Schema

array

id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
account_id integer
Possible values: >= 1
name string
The name of this Part Location.
description string
A description of this Part Location.
archived_at date-time
The date and time at which this Part Location was archived.
metadata object
If this Part Location has any metadata, it will be shown here.
has_work_orders boolean
Whether or not this Part Location has any Work Orders.
has_active_work_orders boolean
Whether or not this Part Location has any active Work Orders.
has_purchase_orders boolean
Whether or not this Part Location has any Purchase Orders.
has_active_purchase_orders boolean
Whether or not this Part Location has any active Purchase Orders.
has_inventory_sets boolean
Whether or not this Part Location has any Inventory Sets.
has_active_inventory_sets boolean
Whether or not this Part Location has any active Inventory Sets.

[
  {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "account_id": 0,
    "name": "string",
    "description": "string",
    "archived_at": "2023-03-14T13:46:27-06:00",
    "metadata": {
      "has_work_orders": true,
      "has_active_work_orders": true,
      "has_purchase_orders": true,
      "has_active_purchase_orders": true,
      "has_inventory_sets": true,
      "has_active_inventory_sets": true
    }
  }
]

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}