Products

Create a new Product.

Changed on
post/products.json

Request

  • Base URL
    https://api.jumpseller.com/v1
  • URL
    https://api.jumpseller.com/v1/products.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: write_products

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.

Request body

Example request

{
  "product": {
    "appointment_settings": {
      "duration": 30,
      "availability_type": "weekly_recurring",
      "event_type": "online",
      "timeslots": {
        "monday": [
          {
            "start_time": "15:00",
            "end_time": "19:00"
          }
        ],
        "tuesday": [
          {
            "start_time": "15:00",
            "end_time": "19:00"
          }
        ],
        "wednesday": [
          {
            "start_time": "15:00",
            "end_time": "19:00"
          }
        ],
        "thursday": [
          {
            "start_time": "15:00",
            "end_time": "19:00"
          }
        ],
        "friday": [
          {
            "start_time": "15:00",
            "end_time": "19:00"
          }
        ],
        "saturday": [
          {
            "start_time": "15:00",
            "end_time": "19:00"
          }
        ],
        "sunday": [
          {
            "start_time": "15:00",
            "end_time": "19:00"
          }
        ]
      },
      "shared_calendars": [
        123,
        456
      ],
      "blocked_dates": [
        "2026-12-25",
        "2027-01-01"
      ]
    },
    "appointment_location_id": 1
  }
}

Response

OK

Example response

{
  "product": {
    "currency": "EUR"
  }
}

Changes

    • breaking

      the request property /// became required

    • breaking

      the request property ////// became required

    • breaking

      the request property ////// became required

    • 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 request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • 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 request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property ////

    • info

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

    • info

      the request property default value option was added

    • info

      the request property default value 123456 was removed

    • info

      the request property default value 100 was removed

    • info

      added the non-success response with the status

    • info

      added the non-success 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 new optional request property /

    • info

      added the new optional request property /