List inventory items for the authenticated organization

Error

A valid request URL is required to generate request examples

[
  {
    "id": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
    "skuId": "203a5df2-423a-43a9-bb19-1ccaf3434b91",
    "imei": [
      356789012345678
    ],
    "deployStatus": "ARCHIVED",
    "condition": "NEW",
    "categoryCode": "TSHIRT",
    "categoryNameOfSku": "T-shirt",
    "skuTitle": "T-shirt White - 5XL",
    "vendorCode": "AWESOME_MERCHANDISE",
    "vendorSku": "TSHRT_5XL_WHITE",
    "createdAt": "2023-02-09T00:00:00",
    "updatedAt": "2023-03-02T17:39:01.650027",
    "tags": [
      {
        "id": "8e0caa73-cc71-4aa4-88eb-fca494de8e20",
        "label": "Engineering"
      }
    ],
    "serialNumber": "25f2e6ea9a",
    "deployReason": "LOST_BY_WORKER",
    "renewalDate": "2026-02-09",
    "renewalDateUpdatedBy": "RENEWAL_DATE_ORGANIZATION_LEVEL",
    "billingStartDate": "2026-02-09",
    "billingEndDate": "2028-02-09",
    "procurementMethod": "Inventory Order - #c853d81c-ba0b-4027-a394-d5586b61608c",
    "returnOrder": {
      "id": "371da231-5878-45b1-80a3-9113f8795c29",
      "createdAt": "2023-11-07T05:31:56Z",
      "returnOrderItemId": "371da231-5878-45b1-80a3-9113f8795c29",
      "retrievalMethod": {
        "type": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "inboundTrackingCode": "1Z999AA10123456784",
        "inboundTrackingLink": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    },
    "assignedTo": {
      "id": "371da231-5878-45b1-80a3-9113f8795c29",
      "type": "PERSON",
      "label": "jane@example.com",
      "assignedAt": "2023-11-07T05:31:56Z"
    },
    "pricing": {
      "regionCode": "<string>",
      "priceOption": "<string>",
      "price": 123,
      "currencyCode": "<string>",
      "discountedPrice": 123,
      "discountPercentage": 123
    },
    "description": "Custom inventory description",
    "netsuiteInvoiceId": "INV-123456",
    "holdStartDate": "2023-12-25",
    "unlockDate": "2023-12-25",
    "itadRequested": true,
    "appleBusiness": {
      "assignmentStatus": "ASSIGNED",
      "nextSyncTimestamp": "2026-07-02T02:00:00Z",
      "lastSyncTimestamp": "2026-07-01T12:00:00Z"
    }
  }
]

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

GET

api

inventory

Error

A valid request URL is required to generate request examples

[
  {
    "id": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
    "skuId": "203a5df2-423a-43a9-bb19-1ccaf3434b91",
    "imei": [
      356789012345678
    ],
    "deployStatus": "ARCHIVED",
    "condition": "NEW",
    "categoryCode": "TSHIRT",
    "categoryNameOfSku": "T-shirt",
    "skuTitle": "T-shirt White - 5XL",
    "vendorCode": "AWESOME_MERCHANDISE",
    "vendorSku": "TSHRT_5XL_WHITE",
    "createdAt": "2023-02-09T00:00:00",
    "updatedAt": "2023-03-02T17:39:01.650027",
    "tags": [
      {
        "id": "8e0caa73-cc71-4aa4-88eb-fca494de8e20",
        "label": "Engineering"
      }
    ],
    "serialNumber": "25f2e6ea9a",
    "deployReason": "LOST_BY_WORKER",
    "renewalDate": "2026-02-09",
    "renewalDateUpdatedBy": "RENEWAL_DATE_ORGANIZATION_LEVEL",
    "billingStartDate": "2026-02-09",
    "billingEndDate": "2028-02-09",
    "procurementMethod": "Inventory Order - #c853d81c-ba0b-4027-a394-d5586b61608c",
    "returnOrder": {
      "id": "371da231-5878-45b1-80a3-9113f8795c29",
      "createdAt": "2023-11-07T05:31:56Z",
      "returnOrderItemId": "371da231-5878-45b1-80a3-9113f8795c29",
      "retrievalMethod": {
        "type": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "inboundTrackingCode": "1Z999AA10123456784",
        "inboundTrackingLink": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    },
    "assignedTo": {
      "id": "371da231-5878-45b1-80a3-9113f8795c29",
      "type": "PERSON",
      "label": "jane@example.com",
      "assignedAt": "2023-11-07T05:31:56Z"
    },
    "pricing": {
      "regionCode": "<string>",
      "priceOption": "<string>",
      "price": 123,
      "currencyCode": "<string>",
      "discountedPrice": 123,
      "discountPercentage": 123
    },
    "description": "Custom inventory description",
    "netsuiteInvoiceId": "INV-123456",
    "holdStartDate": "2023-12-25",
    "unlockDate": "2023-12-25",
    "itadRequested": true,
    "appleBusiness": {
      "assignmentStatus": "ASSIGNED",
      "nextSyncTimestamp": "2026-07-02T02:00:00Z",
      "lastSyncTimestamp": "2026-07-01T12:00:00Z"
    }
  }
]

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

Authorizations

Authorization

string

header

required

Prefix the value with "ApiKey" to indicate the custom authorization type

Query Parameters

page

integer<int32>

The page number to request (1 based)

Example:

1

size

integer<int32>

The number of results to return in a page

Example:

10

personId

string

Id of a person to which inventory is assigned

Example:

"00000000-0000-0000-0000-000000000000"

warehouseId

string

Id of a warehouse to which inventory is assigned

Example:

"00000000-0000-0000-0000-000000000000"

officeId

string

Id of an office to which inventory is assigned

Example:

"00000000-0000-0000-0000-000000000000"

Response

Paginated list of inventory items

string<uuid>

required

Unique identifier for this inventory item

Example:

"ecb7e933-de1e-9830-b180-b25d1d0d296e"

skuId

string<uuid>

required

The SKU (product variant) ID this inventory item is associated with

Example:

"203a5df2-423a-43a9-bb19-1ccaf3434b91"

imei

string[]

required

deployStatus

enum<string>

required

Current lifecycle state of the inventory item. DEPLOYED = assigned to a person; AVAILABLE = in a warehouse ready to ship; ARCHIVED = permanently decommissioned; UNAVAILABLE = in warehouse but not ready to ship; AWAITING_ARRIVAL = in transit to a warehouse.

Available options:

ARCHIVED,

AVAILABLE,

AWAITING_ARRIVAL,

DEPLOYED,

ON_HOLD,

UNAVAILABLE

Example:

"ARCHIVED"

condition

enum<string>

required

Physical condition of the item (NEW or USED)

Available options:

NEW,

USED_LIKE_NEW,

USED_GOOD,

USED_FAIR,

USED,

USED_POOR,

UNUSABLE

Example:

"NEW"

categoryCode

string

required

Category code of the SKU (e.g. COMPUTER, MONITOR, HEADSET)

Example:

"TSHIRT"

categoryNameOfSku

string

required

Human-readable category name for the SKU

Example:

"T-shirt"

skuTitle

string

required

Display title of the SKU (product variant name)

Example:

"T-shirt White - 5XL"

vendorCode

string

required

Vendor/brand code for the SKU

Example:

"AWESOME_MERCHANDISE"

vendorSku

string

required

Vendor-specific SKU or model identifier

Example:

"TSHRT_5XL_WHITE"

createdAt

string<date-time>

required

Timestamp when this inventory item was created in Firstbase

Example:

"2023-02-09T00:00:00"

updatedAt

string<date-time>

required

Timestamp when this inventory item was last updated

Example:

"2023-03-02T17:39:01.650027"

People

Shipment Notices V1

Returns

Replacements

People — Lifecycle

Packages

Orders

New Joiners

ITAD

Inventory

Inventory Orders

Inventory Levels

Assets

Return Orders

Offices

Warehouses V1

Shipment

Regions V1

Categories

Catalog

Brands

List inventory items for the authenticated organization

Authorizations

Query Parameters

Response