Products

Retrieve Products filtered by status.

Changed on
get/products/status/{status}.json

Request

  • Base URL
    https://api.jumpseller.com/v1
  • URL
    https://api.jumpseller.com/v1/products/status/{status}.json
  • Auth
    • HTTP basic
    • or API key in query parameter login and API key in query parameter authtoken
    • or 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

Status of the Product used as filter

Query parameters

localestring

Language of the translatable fields, one of the store's languages (e.g. es). Defaults to the store's default language.

fieldsstring string

Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, bundle_components, fields, currency, appointment_settings, appointment_location_id.

limitinteger

Number of objects per page (maximum 100).

pageinteger

Page number, starting at 1.

Response

OK

Example response

[
  {
    "product": {
      "currency": "EUR"
    }
  }
]

Changes

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter page

    • info

      for the query request parameter locale, the format was generalized from string to no format

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status