--- title: "Retrieve Products filtered by status." method: GET path: "/products/status/{status}.json" tags: ["Products"] --- # Retrieve Products filtered by status. `GET /products/status/{status}.json` ## Request - Base URL: `https://api.jumpseller.com/v1` - URL: `https://api.jumpseller.com/v1/products/status/{status}.json` - Auth: one of: - HTTP basic - API key in query parameter `login` and API key in query parameter `authtoken` - OAuth 2 - Authorization code: `https://accounts.jumpseller.com/oauth/authorize` - Token URL: `https://accounts.jumpseller.com/oauth/token` scopes: `read_products` ## Path parameters - `status` 'available' | 'not-available' | 'disabled', required ## Query parameters - `locale` string - `fields` string, string - `limit` integer - `page` integer ## Response `200` OK - Product[] - `product` ProductFields - `id` integer: Unique identifier of the product - `name` string: Name of the product - `page_title` string: SEO title of the product - `description` string: Description of the product - `type` string: Type of the product: physical, digital, gift_card or appointment - `days_to_expire` integer, nullable: Number of days after the purchase date that the gift card will remain valid. Only present for gift cards. - `price` number, float: Price of the product - `discount` number, float: Discount of the product - `weight` number, float: Weight of the product - `stock` integer: Quantity in stock for the product - `stock_unlimited` boolean: True if the Product has unlimited stock - `stock_threshold` integer: Low stock threshold quantity. - `stock_notification` boolean: True if the Product has low stock threshold quantity enabled - `back_in_stock_enabled` boolean: True if email alerts for customers when this product is restocked are enabled - `cost_per_item` number, nullable: Cost per item of the product (only you can see this). - `compare_at_price` number, nullable: Used to show a sale price. Value must be higher than the price. - `sku` string: Stock Keeping Unit of the product - `brand` string: Brand of the product - `barcode` string: Barcode of the product - `google_product_category_text` string: Human-readable label for the Google product taxonomy category - `quotable` boolean: True if the product can be quoted - `featured` boolean: True if the product is featured - `reviews_enabled` boolean: True if the customer reviews are enabled for this product - `status` 'available' | 'not-available' | 'disabled': Status of the product - `created_at` string: Date of product creation - `updated_at` string: Date of the last product update - `package_format` 'box' | 'cylinder': Format the product package - `length` number, float: Length of the product - `width` number, float: Width of the product - `height` number, float: Height of the product - `diameter` number, float: Diameter of the product - `permalink` string: Product unique URL path - `categories` ProductCategoryFields[] - `id` integer: Unique identifier of the Category - `name` string: Name of the Category - `description` string, nullable: Description of the Category - `parent_id` integer, nullable: Unique identifier of the Parent Category. Null for top-level categories. - `images` ImageFields[] - `id` integer: Unique identifier of the image - `position` integer: Position of the image - `url` string: Complete URL of the image - `variants` VariantFields[] - `id` integer: Unique identifier of the Product's Variant - `position` integer: Position of the Product's Variant - `created_at` string: Date of the Product's Variant creation - `updated_at` string: Date of the Product's Variant last update - `price` number, float: Price of the Product's Variant - `sku` string: Stock Keeping Unit of the Product's Variant - `barcode` string: Barcode of the Product's Variant - `stock` integer: Quantity in stock for the Product's Variant - `stock_unlimited` boolean: True if the Product's Variant has unlimited stock - `stock_threshold` integer: Low stock threshold quantity. - `stock_notification` boolean: True if the Product has low stock threshold quantity enabled - `cost_per_item` number, nullable: Cost per item for the Product's Variant (only you can see this) - `compare_at_price` number, nullable: Used to show a sale price. Value must be higher than the price - `options` ProductVariantOptionFields[] - `product_option_id` integer: Unique identifier of the product option - `product_option_value_id` integer: Unique identifier of the product option value - `option_type` 'option' | 'color': Type of the product option. Only present for option types that generate variants. - `name` string: Name of the product option - `value` string: Value of the product option - `custom` string, nullable: Hexadecimal value of color. Only used for product option type 'color' - `product_option_position` integer: Position of the product option - `product_value_position` integer: Position of the product option value - `image` ImageFields - `id` integer: Unique identifier of the image - `position` integer: Position of the image - `url` string: Complete URL of the image - `weight` number, float: Weight of the Product's Variant - `discount` number: Discount of the Product's Variant - `bundle_components` BundleComponentFields[]: Products and variants included in the bundle - `id` integer: Unique identifier of the bundle component - `product_id` integer: Unique identifier of the component product - `variant_id` integer, nullable: Unique identifier of the component variant - `quantity` integer: Quantity of the component in the bundle - `meta_description` string: SEO meta description of the product - `shipping_required` boolean: False if the product does not need shipping (e.g. digital products) - `google_product_category` string, nullable: Google product taxonomy category id - `fields` ProductCustomFieldFields[]: Custom field values of the product - `id` integer: Unique identifier of the ProductCustomField value - `custom_field_id` integer: Unique identifier of the ProductCustomField - `type` string: The type of the ProductCustomField - `label` string: The label for the ProductCustomField - `value` string: The value for the ProductCustomField - `value_id` integer, nullable: Id of the selected option. Only for custom fields of type selection - `variant_id` integer, nullable: Unique identifier of the Product Variant - `google_attribute_id` string, nullable: Google attribute mapped to the Custom Field - `currency` string: Currency code of the store - `appointment_settings` object, nullable: Appointment scheduling settings. Only present for appointment products; see the request body of Create a new Product for the keys. - `appointment_location_id` integer, nullable: Id of the appointment location. Only present for in-person appointment products. ## Other responses - `404`: Status Invalid. ## Changes - **2026-10-15** `53dc9f2c1329`: 7 breaking, 2 warning, 16 info - the response property `items/product/categories/items/parent_id` became nullable for the status `200` - the response property `items/product/compare_at_price` became nullable for the status `200` - the response property `items/product/cost_per_item` became nullable for the status `200` - the response property `items/product/days_to_expire` became nullable for the status `200` - …21 more - **2026-09-28** `6d9bc2d4601a`: 2 info - added the optional property `items/product/variants/items/created_at` to the response with the `200` status - added the optional property `items/product/variants/items/updated_at` to the response with the `200` status - **2026-09-03** `b6c544795149`: 1 info - added the optional property `items/product/bundle_components` to the response with the `200` status [Operation history](https://skmtc.dev/jumpseller/apis/jumpseller-api/changes/products/status/:status.json/get.md) --- [API](https://skmtc.dev/jumpseller/apis/jumpseller-api.md) - [All operations](https://skmtc.dev/jumpseller/apis/jumpseller-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpseller/apis/jumpseller-api/revisions/09f991a20d74?raw)