List items

Returns a page of items with their core fields and capability flags.

GET /items

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/items?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "type": "<string>",
      "status": "<string>",
      "origin": "<string>",
      "invoice_note": "<string>",
      "version": 123,
      "href": "<string>",
      "sale_enabled": true,
      "purchase_enabled": true,
      "inventory_enabled": true,
      "variations_enabled": true,
      "parent": true,
      "child": true,
      "parent_item_id": "<string>",
      "custom_form": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "manager": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "group": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "created_on": "<string>",
      "created_by": {
        "object": "<string>",
        "name": "<string>",
        "id": "<string>",
        "email": "<string>",
        "href": "<string>"
      },
      "last_updated_on": "<string>",
      "last_updated_by": {
        "object": "<string>",
        "name": "<string>",
        "id": "<string>",
        "email": "<string>",
        "href": "<string>"
      },
      "codes": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "currencies": [
        {
          "name": "<string>",
          "used_for_sale": true,
          "default_for_sale": true,
          "used_for_purchase": true,
          "default_for_purchase": true,
          "suppliers": "<array>"
        }
      ],
      "sale": {
        "enabled": true,
        "enable_back_order": true,
        "invoice_note": "<string>",
        "default_sale_price": 123,
        "pricing_method": "<string>",
        "sale_price_variant": "<string>",
        "use_on_sale_price": true,
        "tax_exempt_when_sold": true,
        "tax_configuration": {
          "sale_price_entered_inclusive_of_tax": true,
          "purchase_price_entered_inclusive_of_tax": true,
          "sale_price_based_on": "<string>",
          "tax_code": {
            "object": "<string>",
            "id": "<string>",
            "name": "<string>",
            "href": "<string>"
          }
        },
        "charge": {
          "type": "<string>",
          "price_period": "<string>",
          "properties": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        },
        "pricing": {
          "type": "<string>",
          "version": 123,
          "latest_used_pricing_version": 123,
          "pricing_module": [
            {
              "average_purchase_price": "<unknown>",
              "currency": "<string>",
              "last_purchase_price": "<unknown>",
              "price": 123,
              "price_type": "<string>",
              "pricing_level": "<string>",
              "unit": "<string>"
            }
          ]
        },
        "pricing_levels": [
          {
            "name": "<string>",
            "uuid": "<string>"
          }
        ],
        "pricing_schedules": "<array>",
        "payment_properties": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "accounting_code": "<unknown>",
        "discount_profile": "<unknown>",
        "pricing_profile": "<unknown>",
        "shipping_profile": "<unknown>",
        "sale_price": "<unknown>",
        "start_date": "<unknown>",
        "end_date": "<unknown>",
        "height": {
          "uom": "<string>",
          "value": 123
        },
        "length": {
          "uom": "<string>",
          "value": 123
        },
        "weight": {
          "uom": "<string>",
          "value": 123
        },
        "width": {
          "uom": "<string>",
          "value": 123
        }
      },
      "purchase": {
        "enabled": true,
        "supplier_management_enabled": true,
        "purchase_order_note": "<string>",
        "default_purchase_price": 123,
        "tax_exempt_when_purchase": true,
        "tax_configuration": {
          "sale_price_entered_inclusive_of_tax": true,
          "purchase_price_entered_inclusive_of_tax": true,
          "sale_price_based_on": "<string>",
          "tax_code": {
            "object": "<string>",
            "id": "<string>",
            "name": "<string>",
            "href": "<string>"
          }
        },
        "pricing": {
          "type": "<string>",
          "version": 123,
          "latest_used_pricing_version": 123,
          "pricing_module": [
            {
              "average_purchase_price": "<unknown>",
              "currency": "<string>",
              "last_purchase_price": "<unknown>",
              "price": 123,
              "price_type": "<string>",
              "pricing_level": "<string>",
              "unit": "<string>"
            }
          ]
        },
        "purchase_properties": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "accounting_code": "<unknown>",
        "pricing_profile": "<unknown>",
        "suppliers": [
          {
            "accounting_code": "<unknown>",
            "default_purchase_price": 123,
            "id": "<unknown>",
            "name": "<string>",
            "pricing": {
              "type": "<string>",
              "version": 123,
              "latest_used_pricing_version": 123,
              "pricing_module": [
                {
                  "average_purchase_price": "<unknown>",
                  "currency": "<string>",
                  "last_purchase_price": "<unknown>",
                  "price": 123,
                  "price_type": "<string>",
                  "pricing_level": "<string>",
                  "unit": "<string>"
                }
              ]
            },
            "purchase_order_note": "<unknown>",
            "tax_configuration": {
              "purchase_price_entered_inclusive_of_tax": true,
              "tax_code": {
                "object": "<string>",
                "id": "<string>",
                "name": "<string>",
                "href": "<string>"
              }
            },
            "tax_exempt_when_purchase": true
          }
        ]
      },
      "inventories": {
        "enabled": true,
        "enable_warehouse_management": true,
        "default_warehouse": "<string>",
        "inventory_properties": {
          "enabled": true,
          "enable_batch_tracking": true,
          "enable_serialization": true,
          "enable_inventory_costing": true,
          "enable_low_stock_notification": true,
          "enable_preorder": true,
          "enable_reordering": true,
          "low_stock_threshold_based_on": "<string>",
          "reordering_threshold_based_on": "<string>",
          "quantity_available_for_sale": "<string>",
          "quantity_available_for_sale_determination": "<array>",
          "use_atp_value_as_quantity_available_for_webhook": true,
          "default_cost_per_unit": "<unknown>",
          "preorder_configuration": [
            {
              "end_date": "<string>",
              "name": "<string>",
              "start_date": "<string>"
            }
          ],
          "preorder_period": "<string>"
        },
        "warehouses": [
          {
            "quantity_on_hand": 123,
            "quantity_on_hand_value": "<string>",
            "quantity_available": 123,
            "quantity_available_value": "<string>",
            "quantity_on_order": 123,
            "quantity_promised": 123,
            "quantity_on_return": 123,
            "quantity_on_purchase_return": 123,
            "warehouse": {
              "object": "<string>",
              "id": "<string>",
              "name": "<string>",
              "href": "<string>"
            },
            "uom": "<string>"
          }
        ]
      },
      "bundle_details": [
        {
          "id": "<string>",
          "name": "<string>",
          "quantity": 123,
          "uom": "<string>"
        }
      ],
      "family_details": [
        {
          "item_id": "<string>",
          "item_name": "<string>"
        }
      ],
      "package_details": [
        {
          "object": "<string>",
          "id": "<string>",
          "uuid": "<string>",
          "name": "<string>",
          "display_name": "<string>",
          "status": "<string>",
          "rank": 123,
          "items": [
            {
              "item_id": "<string>",
              "item_name": "<string>",
              "quantity": 123,
              "uom": "<unknown>"
            }
          ],
          "billing_periods": [
            {
              "name": "<string>",
              "rank": 123
            }
          ],
          "custom_attributes": "<array>",
          "created_on": "<string>",
          "created_by": {
            "object": "<string>",
            "name": "<string>",
            "id": "<string>",
            "email": "<string>",
            "href": "<string>"
          },
          "last_updated_on": "<unknown>",
          "last_updated_by": "<unknown>"
        }
      ],
      "configure_variations": [
        {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>",
          "values": [
            {
              "name": "<string>",
              "uuid": "<string>"
            }
          ]
        }
      ],
      "use_variations": [
        {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>",
          "values": [
            {
              "name": "<string>",
              "uuid": "<string>"
            }
          ]
        }
      ],
      "custom_objects": "<array>",
      "uoms": "<array>",
      "custom_attributes": [
        {
          "href": "<string>",
          "id": "<string>",
          "name": "<string>",
          "object": "<string>",
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "activity_logs": "<array>",
      "base_uom": "<unknown>",
      "image_url": "<unknown>"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

Returns items one page at a time under data, with pagination holding has_more and next_cursor. Set the page size with limit and fetch the next page with cursor. Filter with filter_<field> or filter_<field>_<operator>: an unknown field is refused with 400, and a value the field cannot match returns an empty data.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit · integer

How many records to return on one page.

Example:

20

cursor · string

The next_cursor from the previous page, to fetch the page after it.

sort · string

The field to sort by. Prefix it with - to sort descending, as in -created_on.

Example:

"-created_on"

filter_id · string

Only items whose id equals this value. Also takes _neq, _contains and _not_contains.

filter_uuid · string

Only items whose uuid equals this value. Also takes _neq.

filter_name · string

Only items whose name equals this value. Also takes _neq, _contains and _not_contains.

filter_display_name · string

Only items whose display_name equals this value. Also takes _neq, _contains and _not_contains.

filter_description · string

Only items whose description equals this value. Also takes _neq, _contains and _not_contains.

filter_status · string

Only items whose status equals this value. Also takes _neq.

filter_type · string

Only items whose type equals this value. Also takes _neq.

filter_origin · string

Only items whose origin equals this value. Also takes _neq, _contains and _not_contains.

filter_invoice_note · string

Only items whose invoice_note equals this value. Also takes _neq, _contains and _not_contains.

filter_image_uri · string

Only items whose image_uri equals this value. Also takes _neq, _contains and _not_contains.

filter_base_uom · string

Only items whose base_uom equals this value. Also takes _neq.

filter_group · string

Only items whose group equals this value. Also takes _neq.

filter_manager · string

Only items whose manager equals this value. Also takes _neq.

filter_custom_form · string

Only items whose custom_form equals this value. Also takes _neq.

filter_created_by · string

Only items whose created_by equals this value. Also takes _neq.

filter_last_updated_by · string

Only items whose last_updated_by equals this value. Also takes _neq.

filter_version · string

Only items whose version equals this value. Also takes _neq.

filter_item_number · string

Only items whose item_number in the sale, purchase or inventory section equals this value.

filter_upc_code · string

Only items whose upc_code in the sale, purchase or inventory section equals this value.

filter_sale_enabled · string

Only items whose sale_enabled in the sale, purchase or inventory section equals this value.

filter_sales_accounting_code_revenue · string

Only items whose sales_accounting_code_revenue in the sale, purchase or inventory section equals this value.

filter_sales_billing_mode · string

Only items whose sales_billing_mode in the sale, purchase or inventory section equals this value.

filter_sales_charge_type · string

Only items whose sales_charge_type in the sale, purchase or inventory section equals this value.

filter_sales_currency · string

Only items whose sales_currency in the sale, purchase or inventory section equals this value.

filter_sales_fulfillment_mode · string

Only items whose sales_fulfillment_mode in the sale, purchase or inventory section equals this value.

filter_sales_payment_mode · string

Only items whose sales_payment_mode in the sale, purchase or inventory section equals this value.

filter_sales_pricing_method · string

Only items whose sales_pricing_method in the sale, purchase or inventory section equals this value.

filter_sales_tax_inclusive_based_on · string

Only items whose sales_tax_inclusive_based_on in the sale, purchase or inventory section equals this value.

filter_purchase_enabled · string

Only items whose purchase_enabled in the sale, purchase or inventory section equals this value.

filter_purchase_currency · string

Only items whose purchase_currency in the sale, purchase or inventory section equals this value.

filter_purchase_order_note · string

Only items whose purchase_order_note in the sale, purchase or inventory section equals this value.

filter_purchase_profile · string

Only items whose purchase_profile in the sale, purchase or inventory section equals this value.

filter_purchase_receive_mode · string

Only items whose purchase_receive_mode in the sale, purchase or inventory section equals this value.

filter_inventory_enabled · string

Only items whose inventory_enabled in the sale, purchase or inventory section equals this value.

filter_inventory_quantity_available · string

Only items whose inventory_quantity_available in the sale, purchase or inventory section equals this value.

filter_inventory_quantity_on_hand · string

Only items whose inventory_quantity_on_hand in the sale, purchase or inventory section equals this value.

filter_inventory_qty_avl_on_sale_determination · string

Only items whose inventory_qty_avl_on_sale_determination in the sale, purchase or inventory section equals this value.

Response

200

application/json

A page of items, under data.

object · string

url · string

data · object[]

Show child attributes

pagination · object

Show child attributes