---
title: "Search items"
method: GET
path: "/items"
tags: ["Items"]
---

# Search items

`GET /items`

 

## Query parameters

- `item_id` string
- `item_name` string
- `item_sku` string
- `item_upc` string
- `connection_id` integer
- `item_category_id` integer
- `item_tag` string
- `item_active` boolean
- `with` 'item_images' | 'item_tags' | 'item_options' | 'item_option_variations' | 'item_swap_options' | 'connection'
- `limit` integer
- `offset` integer
- `sort_by` string
- `order` 'asc' | 'desc'

## Response `200`

OK

- object
  - `total` integer
  - `items` object[]
    - `item_id` integer
    - `item_name` string
    - `item_category_id` integer, nullable
    - `item_description` string, nullable
    - `item_image` string, nullable
    - `item_active` boolean
    - `item_price` string, nullable
    - `item_msrp` string, nullable
    - `item_cost` string, nullable
    - `item_shippable` boolean
    - `item_sku` string, nullable
    - `item_weight` string, nullable
    - `item_upc` string, nullable
    - `item_slug` string, nullable
    - `item_quantity` integer
    - `connection_id` integer, nullable
    - `out_of_stock_block` boolean
    - `item_turnaround_time` integer
    - `item_additional_description` string, nullable
    - `item_ingredients` string, nullable
    - `item_video` string, nullable
    - `item_sales_page` string, nullable
    - `item_perishable` boolean
    - `item_tax_code` string, nullable
    - `item_additional_details_1` string, nullable
    - `item_additional_details_2` string, nullable
    - `item_additional_details_3` string, nullable
    - `item_additional_details_4` string, nullable
    - `item_additional_details_5` string, nullable
    - `date_created` string, date-time
    - `created_by` integer
    - `date_modified` string, date-time
    - `modified_by` integer
    - `item_notes` string, nullable
    - `item_options` object[], nullable
      - `item_option_id` integer
      - `item_option_name` string
      - `item_option_values` object[]
        - `item_option_value_id` integer
        - `item_option_value_name` string
    - `item_option_variations` object[], nullable
      - `items_option_variation_id` integer
      - `items_option_variation_key` string
      - `items_option_variation_name` string
      - `items_option_variation_quantity` integer
      - `items_option_variation_sku` string, nullable
      - `items_option_variation_price` string
      - `items_option_variation_msrp` string
      - `items_option_variation_cost` string, nullable
      - `items_option_variation_weight` string, nullable
      - `items_option_variation_upc` string, nullable
      - `items_option_variation_image` string, nullable
      - `items_option_variation_images` object[]
        - `image_id` integer
        - `image_url` string
    - `item_images` object[], nullable
      - `image_id` integer
      - `image_url` string
    - `item_tags` object[], nullable
      - `tag_id` integer
      - `tag_name` string
      - `tag_slug` string
      - `tag_image` string, nullable
    - `item_swap_options` object[], nullable
      - `swap_item_id` integer
      - `swap_item_name` string
      - `swap_item_image` string, nullable
      - `swap_item_type_id` integer
      - `swap_item_description` string, nullable
      - `item_options` object[]
        - `item_option_id` integer
        - `item_option_name` string
        - `item_option_values` object[]
          - `item_option_value_id` integer
          - `item_option_value_name` string
      - `item_option_variations` object[]
        - `items_option_variation_id` integer
        - `items_option_variation_key` string
        - `items_option_variation_name` string
        - `items_option_variation_quantity` integer
        - `items_option_variation_sku` string, nullable
        - `items_option_variation_price` string
        - `items_option_variation_msrp` string
        - `items_option_variation_cost` string, nullable
        - `items_option_variation_weight` string, nullable
        - `items_option_variation_upc` string, nullable
        - `items_option_variation_image` string, nullable
        - `items_option_variation_images` object[]
          - `image_id` integer
          - `image_url` string
    - `connection` object, nullable
      - `connection_id` integer
      - `connection_name` string

## Other responses

- `401` — Unauthorized response
- `403` — Forbidden response
- `500` — Error response

---

[API](https://skmtc.net/vrio/apis/crm-configuration.md) · [All operations](https://skmtc.net/vrio/apis/crm-configuration/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vrio/crm-configuration/versions/62037010356e/schema)