POST api2/products.json

Create a product

Request Information

URI Parameters

None.

Body Parameters

api_root
NameDescriptionTypeAdditional information
product

Projects

None.

Request Format

{
  "product": {
    "product_id": "sample string 1",
    "title": "sample string 2",
    "comment": "sample string 3",
    "version": "sample string 4",
    "valid": true,
    "short_movie": 1,
    "runtime": 1,
    "allow_download_trial": 1,
    "product_type": 1,
    "release_date": "2024-07-10T00:15:42.5576337+02:00",
    "owner_company_id": 1,
    "pre_sales": true,
    "updated_at": "2024-07-10T00:15:42.5576337+02:00",
    "attribute_set_id": 1,
    "weight": 1.1,
    "drm_protected": true,
    "gtin": "sample string 5",
    "supplier": 1,
    "manage_stock": true,
    "items_in_stock": 1,
    "hide_on_shop_catalog": true,
    "template": true,
    "generate_individual_codes": true,
    "scorm_certificate_id": 1,
    "access_group_date_relative": 1,
    "access_group_date_fixed": "2024-07-10T00:15:42.5576337+02:00",
    "generic_downloads": 1,
    "generic_availability_days": 1,
    "generic_custom_url": "sample string 6",
    "scorm_expiration": 1,
    "published_at": "2024-07-10T00:15:42.5576337+02:00",
    "locales": [
      {
        "id": 1,
        "src": "sample string 2",
        "language_id": "en",
        "title": "sample string 4",
        "description": "sample string 5",
        "version": "sample string 6",
        "product_url": "sample string 7",
        "email_text": "sample string 8",
        "seo_description": "sample string 9",
        "seo_keywords": "sample string 10",
        "seo_title": "sample string 11"
      },
      {
        "id": 1,
        "src": "sample string 2",
        "language_id": "en",
        "title": "sample string 4",
        "description": "sample string 5",
        "version": "sample string 6",
        "product_url": "sample string 7",
        "email_text": "sample string 8",
        "seo_description": "sample string 9",
        "seo_keywords": "sample string 10",
        "seo_title": "sample string 11"
      }
    ],
    "tagging": {
      "id": 1,
      "year": "sample string 2",
      "isbn": "sample string 3"
    },
    "content_files": [
      {
        "id": 1,
        "project_id": 1,
        "upload_id": 1,
        "download_url": "sample string 2",
        "content_type": 1,
        "video_type": 1,
        "video_quality": 1,
        "valid": 1,
        "language": "sample string 3",
        "folder": true,
        "pdffiles": 1,
        "htmlfiles": 1
      },
      {
        "id": 1,
        "project_id": 1,
        "upload_id": 1,
        "download_url": "sample string 2",
        "content_type": 1,
        "video_type": 1,
        "video_quality": 1,
        "valid": 1,
        "language": "sample string 3",
        "folder": true,
        "pdffiles": 1,
        "htmlfiles": 1
      }
    ],
    "themes": [
      {
        "id": 1,
        "created_at": "2024-07-10T00:15:42.5576337+02:00",
        "theme_settings_id": 1
      },
      {
        "id": 1,
        "created_at": "2024-07-10T00:15:42.5576337+02:00",
        "theme_settings_id": 1
      }
    ],
    "categories": [
      {
        "id": 1,
        "product_id": "sample string 2",
        "category_id": 1,
        "created_at": "2024-07-10T00:15:42.6045081+02:00"
      },
      {
        "id": 1,
        "product_id": "sample string 2",
        "category_id": 1,
        "created_at": "2024-07-10T00:15:42.6045081+02:00"
      }
    ],
    "groups": [
      {
        "id": 1,
        "group_id": "sample string 2",
        "created_at": "2024-07-10T00:15:42.6045081+02:00",
        "start_at": "2024-07-10T00:15:42.6045081+02:00",
        "end_at": "2024-07-10T00:15:42.6045081+02:00"
      },
      {
        "id": 1,
        "group_id": "sample string 2",
        "created_at": "2024-07-10T00:15:42.6045081+02:00",
        "start_at": "2024-07-10T00:15:42.6045081+02:00",
        "end_at": "2024-07-10T00:15:42.6045081+02:00"
      }
    ],
    "preview_pictures": [
      {
        "src": "sample string 1",
        "id": 2,
        "width": 1,
        "height": 1
      },
      {
        "src": "sample string 1",
        "id": 2,
        "width": 1,
        "height": 1
      }
    ],
    "chapters": [
      {
        "runtime": 1,
        "id": 2,
        "name": "sample string 3"
      },
      {
        "runtime": 1,
        "id": 2,
        "name": "sample string 3"
      }
    ],
    "price_license_binding": [
      {
        "id": 1,
        "hd": true,
        "license_id": 1,
        "price_id": 1,
        "compare_price_id": 1,
        "audio_type": 64,
        "num_users": 1
      },
      {
        "id": 1,
        "hd": true,
        "license_id": 1,
        "price_id": 1,
        "compare_price_id": 1,
        "audio_type": 64,
        "num_users": 1
      }
    ],
    "tagging_genre": [
      {
        "id": 1,
        "value": "sample string 2"
      },
      {
        "id": 1,
        "value": "sample string 2"
      }
    ],
    "tagging_studios": [
      {
        "id": 1,
        "value": "sample string 2"
      },
      {
        "id": 1,
        "value": "sample string 2"
      }
    ],
    "tagging_people": [
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      },
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      }
    ],
    "tagging_script": [
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      },
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      }
    ],
    "tagging_director": [
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      },
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      }
    ],
    "attributes": [
      {
        "id": 1,
        "value": "sample string 1"
      },
      {
        "id": 1,
        "value": "sample string 1"
      }
    ],
    "product_status_details": [
      "sample string 1",
      "sample string 2"
    ],
    "product_is_live": false,
    "mirrored": true
  }
}

Response Information

Resource Description

created product

api_root
NameDescriptionTypeAdditional information
product

Projects

None.

Response Format

{
  "product": {
    "product_id": "sample string 1",
    "title": "sample string 2",
    "comment": "sample string 3",
    "version": "sample string 4",
    "created_at": "2024-07-10T00:15:42.6201186+02:00",
    "valid": true,
    "short_movie": 1,
    "runtime": 1,
    "allow_download_trial": 1,
    "product_type": 1,
    "release_date": "2024-07-10T00:15:42.6201186+02:00",
    "owner_company_id": 1,
    "pre_sales": true,
    "updated_at": "2024-07-10T00:15:42.6201186+02:00",
    "attribute_set_id": 1,
    "weight": 1.1,
    "drm_protected": true,
    "gtin": "sample string 5",
    "supplier": 1,
    "manage_stock": true,
    "items_in_stock": 1,
    "hide_on_shop_catalog": true,
    "template": true,
    "generate_individual_codes": true,
    "scorm_certificate_id": 1,
    "access_group_date_relative": 1,
    "access_group_date_fixed": "2024-07-10T00:15:42.6201186+02:00",
    "generic_downloads": 1,
    "generic_availability_days": 1,
    "generic_custom_url": "sample string 6",
    "scorm_expiration": 1,
    "id": 7,
    "published_at": "2024-07-10T00:15:42.6201186+02:00",
    "locales": [
      {
        "id": 1,
        "src": "sample string 2",
        "language_id": "en",
        "title": "sample string 4",
        "description": "sample string 5",
        "version": "sample string 6",
        "product_url": "sample string 7",
        "email_text": "sample string 8",
        "seo_description": "sample string 9",
        "seo_keywords": "sample string 10",
        "seo_title": "sample string 11"
      },
      {
        "id": 1,
        "src": "sample string 2",
        "language_id": "en",
        "title": "sample string 4",
        "description": "sample string 5",
        "version": "sample string 6",
        "product_url": "sample string 7",
        "email_text": "sample string 8",
        "seo_description": "sample string 9",
        "seo_keywords": "sample string 10",
        "seo_title": "sample string 11"
      }
    ],
    "tagging": {
      "id": 1,
      "year": "sample string 2",
      "isbn": "sample string 3"
    },
    "content_files": [
      {
        "id": 1,
        "project_id": 1,
        "upload_id": 1,
        "download_url": "sample string 2",
        "content_type": 1,
        "video_type": 1,
        "video_quality": 1,
        "valid": 1,
        "language": "sample string 3",
        "folder": true,
        "pdffiles": 1,
        "htmlfiles": 1
      },
      {
        "id": 1,
        "project_id": 1,
        "upload_id": 1,
        "download_url": "sample string 2",
        "content_type": 1,
        "video_type": 1,
        "video_quality": 1,
        "valid": 1,
        "language": "sample string 3",
        "folder": true,
        "pdffiles": 1,
        "htmlfiles": 1
      }
    ],
    "themes": [
      {
        "id": 1,
        "created_at": "2024-07-10T00:15:42.6201186+02:00",
        "theme_settings_id": 1
      },
      {
        "id": 1,
        "created_at": "2024-07-10T00:15:42.6201186+02:00",
        "theme_settings_id": 1
      }
    ],
    "categories": [
      {
        "id": 1,
        "product_id": "sample string 2",
        "category_id": 1,
        "created_at": "2024-07-10T00:15:42.6357435+02:00"
      },
      {
        "id": 1,
        "product_id": "sample string 2",
        "category_id": 1,
        "created_at": "2024-07-10T00:15:42.6357435+02:00"
      }
    ],
    "groups": [
      {
        "id": 1,
        "group_id": "sample string 2",
        "created_at": "2024-07-10T00:15:42.6357435+02:00",
        "start_at": "2024-07-10T00:15:42.6357435+02:00",
        "end_at": "2024-07-10T00:15:42.6357435+02:00"
      },
      {
        "id": 1,
        "group_id": "sample string 2",
        "created_at": "2024-07-10T00:15:42.6357435+02:00",
        "start_at": "2024-07-10T00:15:42.6357435+02:00",
        "end_at": "2024-07-10T00:15:42.6357435+02:00"
      }
    ],
    "preview_pictures": [
      {
        "src": "sample string 1",
        "id": 2,
        "width": 1,
        "height": 1
      },
      {
        "src": "sample string 1",
        "id": 2,
        "width": 1,
        "height": 1
      }
    ],
    "chapters": [
      {
        "runtime": 1,
        "id": 2,
        "name": "sample string 3"
      },
      {
        "runtime": 1,
        "id": 2,
        "name": "sample string 3"
      }
    ],
    "price_license_binding": [
      {
        "id": 1,
        "hd": true,
        "license_id": 1,
        "price_id": 1,
        "compare_price_id": 1,
        "audio_type": 64,
        "num_users": 1
      },
      {
        "id": 1,
        "hd": true,
        "license_id": 1,
        "price_id": 1,
        "compare_price_id": 1,
        "audio_type": 64,
        "num_users": 1
      }
    ],
    "tagging_genre": [
      {
        "id": 1,
        "value": "sample string 2"
      },
      {
        "id": 1,
        "value": "sample string 2"
      }
    ],
    "tagging_studios": [
      {
        "id": 1,
        "value": "sample string 2"
      },
      {
        "id": 1,
        "value": "sample string 2"
      }
    ],
    "tagging_people": [
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      },
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      }
    ],
    "tagging_script": [
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      },
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      }
    ],
    "tagging_director": [
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      },
      {
        "id": 1,
        "role": "sample string 2",
        "person": "sample string 3"
      }
    ],
    "attributes": [
      {
        "id": 1,
        "value": "sample string 1"
      },
      {
        "id": 1,
        "value": "sample string 1"
      }
    ],
    "product_status_details": [
      "sample string 1",
      "sample string 2"
    ],
    "product_is_live": false,
    "mirrored": true
  }
}