Create product

POST /V1/products

Create product

Body

product object Required
Hide product attributes Show product attributes object
- id integer
  
  Id
- sku string Required
  
  Sku
- name string
  
  Name
- attribute_set_id integer
  
  Attribute set id
- price number
  
  Price
- status integer
  
  Status
- visibility integer
  
  Visibility
- type_id string
  
  Type id
- created_at string
  
  Created date
- updated_at string
  
  Updated date
- weight number
  
  Weight
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  website_ids array[integer]
  
  category_links array[object]
  
  Hide category_links attributes Show category_links attributes object
  
  position integer
  
  category_id string Required
  
  Category id
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryLinkInterface
  
  discounts array[object]
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  bundle_product_options array[object]
  
  Interface OptionInterface
  
  Hide bundle_product_options attributes Show bundle_product_options attributes object
  
  option_id integer
  
  Option id
  
  title string
  
  Option title
  
  required boolean
  
  Is required option
  
  type string
  
  Input type
  
  position integer
  
  Option position
  
  sku string
  
  Product sku
  
  product_links array[object]
  
  Interface LinkInterface
  
  Hide product_links attributes Show product_links attributes object
  
  id string
  
  The identifier
  
  sku string
  
  Linked product sku
  
  option_id integer
  
  Option id
  
  qty number
  
  Qty
  
  position integer
  
  Position
  
  is_default boolean Required
  
  Is default
  
  price number Required
  
  Price
  
  price_type integer Required
  
  Price type
  
  can_change_quantity integer
  
  Whether quantity could be changed
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\LinkInterface
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionInterface
  
  stock_item object
  
  Interface StockItem
  
  Hide stock_item attributes Show stock_item attributes object
  
  item_id integer
  
  product_id integer
  
  stock_id integer
  
  Stock identifier
  
  qty number Required
  
  is_in_stock boolean Required
  
  Stock Availability
  
  is_qty_decimal boolean Required
  
  show_default_notification_message boolean Required
  
  use_config_min_qty boolean Required
  
  min_qty number Required
  
  Minimal quantity available for item status in stock
  
  use_config_min_sale_qty integer Required
  
  min_sale_qty number Required
  
  Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation
  
  use_config_max_sale_qty boolean Required
  
  max_sale_qty number Required
  
  Maximum Qty Allowed in Shopping Cart data wrapper
  
  use_config_backorders boolean Required
  
  backorders integer Required
  
  Backorders status
  
  use_config_notify_stock_qty boolean Required
  
  notify_stock_qty number Required
  
  Notify for Quantity Below data wrapper
  
  use_config_qty_increments boolean Required
  
  qty_increments number Required
  
  Quantity Increments data wrapper
  
  use_config_enable_qty_inc boolean Required
  
  enable_qty_increments boolean Required
  
  Whether Quantity Increments is enabled
  
  use_config_manage_stock boolean Required
  
  manage_stock boolean Required
  
  Can Manage Stock
  
  low_stock_date string Required
  
  is_decimal_divided boolean Required
  
  stock_status_changed_auto integer Required
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface
  
  downloadable_product_links array[object]
  
  Hide downloadable_product_links attributes Show downloadable_product_links attributes object
  
  id integer
  
  Sample(or link) id
  
  title string
  
  sort_order integer Required
  
  is_shareable integer Required
  
  Shareable status
  
  price number Required
  
  Price
  
  number_of_downloads integer
  
  Of downloads per user
  
  link_type string Required
  
  link_file string
  
  relative file path
  
  link_file_content object
  
  Hide link_file_content attributes Show link_file_content attributes object
  
  file_data string Required
  
  Data (base64 encoded content)
  
  name string Required
  
  File name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface
  
  link_url string
  
  Link url or null when type is 'file'
  
  sample_type string Required
  
  sample_file string
  
  relative file path
  
  sample_file_content object
  
  Hide sample_file_content attributes Show sample_file_content attributes object
  
  file_data string Required
  
  Data (base64 encoded content)
  
  name string Required
  
  File name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface
  
  sample_url string
  
  file URL
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\LinkInterface
  
  downloadable_product_samples array[object]
  
  Hide downloadable_product_samples attributes Show downloadable_product_samples attributes object
  
  id integer
  
  Sample(or link) id
  
  title string Required
  
  Title
  
  sort_order integer Required
  
  Order index for sample
  
  sample_type string Required
  
  sample_file string
  
  relative file path
  
  sample_file_content object
  
  Hide sample_file_content attributes Show sample_file_content attributes object
  
  file_data string Required
  
  Data (base64 encoded content)
  
  name string Required
  
  File name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface
  
  sample_url string
  
  file URL
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\SampleInterface
  
  giftcard_amounts array[object]
  
  Interface GiftcardAmountInterface: this interface is used to serialize and deserialize EAV attribute giftcard_amounts
  
  Hide giftcard_amounts attributes Show giftcard_amounts attributes object
  
  attribute_id integer Required
  
  website_id integer Required
  
  value number Required
  
  website_value number Required
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftcardAmountInterface
  
  configurable_product_options array[object]
  
  Interface OptionInterface
  
  Hide configurable_product_options attributes Show configurable_product_options attributes object
  
  id integer
  
  attribute_id string
  
  label string
  
  position integer
  
  is_use_default boolean
  
  values array[object]
  
  Interface OptionValueInterface
  
  Hide values attributes Show values attributes object
  
  value_index string Required
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionValueInterface
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionInterface
  
  product_id integer
  
  configurable_product_links array[integer]
  
  mapped_size string
- product_links array[object]
  Hide product_links attributes Show product_links attributes object
  
  sku string Required
  
  SKU
  
  link_type string Required
  
  Link type
  
  linked_product_sku string Required
  
  Linked product sku
  
  linked_product_type string Required
  
  Linked product type (simple, virtual, etc)
  
  position integer Required
  
  Linked item position
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  qty number
- options array[object]
  Hide options attributes Show options attributes object
  
  product_sku string Required
  
  Product SKU
  
  option_id integer
  
  Option id
  
  title string Required
  
  Option title
  
  type string Required
  
  Option type
  
  sort_order integer Required
  
  Sort order
  
  is_require boolean Required
  
  Is require
  
  price number
  
  Price
  
  price_type string
  
  Price type
  
  sku string
  
  Sku
  
  file_extension string
  
  max_characters integer
  
  image_size_x integer
  
  image_size_y integer
  
  values array[object]
  
  Hide values attributes Show values attributes object
  
  title string Required
  
  Option title
  
  sort_order integer Required
  
  Sort order
  
  price number Required
  
  Price
  
  price_type string Required
  
  Price type
  
  sku string
  
  Sku
  
  option_type_id integer
  
  Option type id
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionInterface
- media_gallery_entries array[object]
  Hide media_gallery_entries attributes Show media_gallery_entries attributes object
  
  id integer
  
  Gallery entry ID
  
  media_type string Required
  
  Media type
  
  label string Required
  
  Gallery entry alternative text
  
  position integer Required
  
  Gallery entry position (sort order)
  
  disabled boolean Required
  
  If gallery entry is hidden from product page
  
  types array[string] Required
  
  Gallery entry image types (thumbnail, image, small_image etc)
  
  file string
  
  File path
  
  content object
  
  Image Content data interface
  
  Hide content attributes Show content attributes object
  
  base64_encoded_data string Required
  
  Media data (base64 encoded content)
  
  type string Required
  
  MIME type
  
  name string Required
  
  Image name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  video_content object
  
  Video Content data interface
  
  Hide video_content attributes Show video_content attributes object
  
  media_type string Required
  
  MIME type
  
  video_provider string Required
  
  Provider
  
  video_url string Required
  
  Video URL
  
  video_title string Required
  
  Title
  
  video_description string Required
  
  Video Description
  
  video_metadata string Required
  
  Metadata
- tier_prices array[object]
  Hide tier_prices attributes Show tier_prices attributes object
  
  customer_group_id integer Required
  
  Customer group id
  
  qty number Required
  
  Tier qty
  
  value number Required
  
  Price value
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductTierPriceInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  percentage_value number
  
  website_id integer
- custom_attributes array[object]
  
  Interface for custom attribute value.
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
saveOptions boolean

Responses

200

200 Success.
Hide response attributes Show response attributes object
- id integer
  
  Id
- sku string Required
  
  Sku
- name string
  
  Name
- attribute_set_id integer
  
  Attribute set id
- price number
  
  Price
- status integer
  
  Status
- visibility integer
  
  Visibility
- type_id string
  
  Type id
- created_at string
  
  Created date
- updated_at string
  
  Updated date
- weight number
  
  Weight
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  website_ids array[integer]
  
  category_links array[object]
  
  Hide category_links attributes Show category_links attributes object
  
  position integer
  
  category_id string Required
  
  Category id
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryLinkInterface
  
  discounts array[object]
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  bundle_product_options array[object]
  
  Interface OptionInterface
  
  Hide bundle_product_options attributes Show bundle_product_options attributes object
  
  option_id integer
  
  Option id
  
  title string
  
  Option title
  
  required boolean
  
  Is required option
  
  type string
  
  Input type
  
  position integer
  
  Option position
  
  sku string
  
  Product sku
  
  product_links array[object]
  
  Interface LinkInterface
  
  Hide product_links attributes Show product_links attributes object
  
  id string
  
  The identifier
  
  sku string
  
  Linked product sku
  
  option_id integer
  
  Option id
  
  qty number
  
  Qty
  
  position integer
  
  Position
  
  is_default boolean Required
  
  Is default
  
  price number Required
  
  Price
  
  price_type integer Required
  
  Price type
  
  can_change_quantity integer
  
  Whether quantity could be changed
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\LinkInterface
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionInterface
  
  stock_item object
  
  Interface StockItem
  
  Hide stock_item attributes Show stock_item attributes object
  
  item_id integer
  
  product_id integer
  
  stock_id integer
  
  Stock identifier
  
  qty number Required
  
  is_in_stock boolean Required
  
  Stock Availability
  
  is_qty_decimal boolean Required
  
  show_default_notification_message boolean Required
  
  use_config_min_qty boolean Required
  
  min_qty number Required
  
  Minimal quantity available for item status in stock
  
  use_config_min_sale_qty integer Required
  
  min_sale_qty number Required
  
  Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation
  
  use_config_max_sale_qty boolean Required
  
  max_sale_qty number Required
  
  Maximum Qty Allowed in Shopping Cart data wrapper
  
  use_config_backorders boolean Required
  
  backorders integer Required
  
  Backorders status
  
  use_config_notify_stock_qty boolean Required
  
  notify_stock_qty number Required
  
  Notify for Quantity Below data wrapper
  
  use_config_qty_increments boolean Required
  
  qty_increments number Required
  
  Quantity Increments data wrapper
  
  use_config_enable_qty_inc boolean Required
  
  enable_qty_increments boolean Required
  
  Whether Quantity Increments is enabled
  
  use_config_manage_stock boolean Required
  
  manage_stock boolean Required
  
  Can Manage Stock
  
  low_stock_date string Required
  
  is_decimal_divided boolean Required
  
  stock_status_changed_auto integer Required
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface
  
  downloadable_product_links array[object]
  
  Hide downloadable_product_links attributes Show downloadable_product_links attributes object
  
  id integer
  
  Sample(or link) id
  
  title string
  
  sort_order integer Required
  
  is_shareable integer Required
  
  Shareable status
  
  price number Required
  
  Price
  
  number_of_downloads integer
  
  Of downloads per user
  
  link_type string Required
  
  link_file string
  
  relative file path
  
  link_file_content object
  
  Hide link_file_content attributes Show link_file_content attributes object
  
  file_data string Required
  
  Data (base64 encoded content)
  
  name string Required
  
  File name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface
  
  link_url string
  
  Link url or null when type is 'file'
  
  sample_type string Required
  
  sample_file string
  
  relative file path
  
  sample_file_content object
  
  Hide sample_file_content attributes Show sample_file_content attributes object
  
  file_data string Required
  
  Data (base64 encoded content)
  
  name string Required
  
  File name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface
  
  sample_url string
  
  file URL
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\LinkInterface
  
  downloadable_product_samples array[object]
  
  Hide downloadable_product_samples attributes Show downloadable_product_samples attributes object
  
  id integer
  
  Sample(or link) id
  
  title string Required
  
  Title
  
  sort_order integer Required
  
  Order index for sample
  
  sample_type string Required
  
  sample_file string
  
  relative file path
  
  sample_file_content object
  
  Hide sample_file_content attributes Show sample_file_content attributes object
  
  file_data string Required
  
  Data (base64 encoded content)
  
  name string Required
  
  File name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface
  
  sample_url string
  
  file URL
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Downloadable\Api\Data\SampleInterface
  
  giftcard_amounts array[object]
  
  Interface GiftcardAmountInterface: this interface is used to serialize and deserialize EAV attribute giftcard_amounts
  
  Hide giftcard_amounts attributes Show giftcard_amounts attributes object
  
  attribute_id integer Required
  
  website_id integer Required
  
  value number Required
  
  website_value number Required
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftcardAmountInterface
  
  configurable_product_options array[object]
  
  Interface OptionInterface
  
  Hide configurable_product_options attributes Show configurable_product_options attributes object
  
  id integer
  
  attribute_id string
  
  label string
  
  position integer
  
  is_use_default boolean
  
  values array[object]
  
  Interface OptionValueInterface
  
  Hide values attributes Show values attributes object
  
  value_index string Required
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionValueInterface
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionInterface
  
  product_id integer
  
  configurable_product_links array[integer]
  
  mapped_size string
- product_links array[object]
  
  Hide product_links attributes Show product_links attributes object
  
  sku string Required
  
  SKU
  
  link_type string Required
  
  Link type
  
  linked_product_sku string Required
  
  Linked product sku
  
  linked_product_type string Required
  
  Linked product type (simple, virtual, etc)
  
  position integer Required
  
  Linked item position
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  qty number
- options array[object]
  
  Hide options attributes Show options attributes object
  
  product_sku string Required
  
  Product SKU
  
  option_id integer
  
  Option id
  
  title string Required
  
  Option title
  
  type string Required
  
  Option type
  
  sort_order integer Required
  
  Sort order
  
  is_require boolean Required
  
  Is require
  
  price number
  
  Price
  
  price_type string
  
  Price type
  
  sku string
  
  Sku
  
  file_extension string
  
  max_characters integer
  
  image_size_x integer
  
  image_size_y integer
  
  values array[object]
  
  Hide values attributes Show values attributes object
  
  title string Required
  
  Option title
  
  sort_order integer Required
  
  Sort order
  
  price number Required
  
  Price
  
  price_type string Required
  
  Price type
  
  sku string
  
  Sku
  
  option_type_id integer
  
  Option type id
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionInterface
- media_gallery_entries array[object]
  
  Hide media_gallery_entries attributes Show media_gallery_entries attributes object
  
  id integer
  
  Gallery entry ID
  
  media_type string Required
  
  Media type
  
  label string Required
  
  Gallery entry alternative text
  
  position integer Required
  
  Gallery entry position (sort order)
  
  disabled boolean Required
  
  If gallery entry is hidden from product page
  
  types array[string] Required
  
  Gallery entry image types (thumbnail, image, small_image etc)
  
  file string
  
  File path
  
  content object
  
  Image Content data interface
  
  Hide content attributes Show content attributes object
  
  base64_encoded_data string Required
  
  Media data (base64 encoded content)
  
  type string Required
  
  MIME type
  
  name string Required
  
  Image name
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  video_content object
  
  Video Content data interface
  
  Hide video_content attributes Show video_content attributes object
  
  media_type string Required
  
  MIME type
  
  video_provider string Required
  
  Provider
  
  video_url string Required
  
  Video URL
  
  video_title string Required
  
  Title
  
  video_description string Required
  
  Video Description
  
  video_metadata string Required
  
  Metadata
- tier_prices array[object]
  
  Hide tier_prices attributes Show tier_prices attributes object
  
  customer_group_id integer Required
  
  Customer group id
  
  qty number Required
  
  Tier qty
  
  value number Required
  
  Price value
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductTierPriceInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  percentage_value number
  
  website_id integer
- custom_attributes array[object]
  
  Interface for custom attribute value.
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/products

curl \
 -X POST https://magento2.winkelstraat.mac/rest/all/V1/products \
 -d '{"product":{"id":42,"sku":"string","name":"string","attribute_set_id":42,"price":42.0,"status":42,"visibility":42,"type_id":"string","created_at":"string","updated_at":"string","weight":42.0,"extension_attributes":{"website_ids":[42],"category_links":[{"position":42,"category_id":"string","extension_attributes":{}}],"discounts":[{"discount_data":{"amount":42.0,"base_amount":42.0,"original_amount":42.0,"base_original_amount":42.0},"rule_label":"string","rule_i_d":42}],"bundle_product_options":[{"option_id":42,"title":"string","required":true,"type":"string","position":42,"sku":"string","product_links":[{"id":"string","sku":"string","option_id":42,"qty":42.0,"position":42,"is_default":true,"price":42.0,"price_type":42,"can_change_quantity":42,"extension_attributes":{}}],"extension_attributes":{}}],"stock_item":{"item_id":42,"product_id":42,"stock_id":42,"qty":42.0,"is_in_stock":true,"is_qty_decimal":true,"show_default_notification_message":true,"use_config_min_qty":true,"min_qty":42.0,"use_config_min_sale_qty":42,"min_sale_qty":42.0,"use_config_max_sale_qty":true,"max_sale_qty":42.0,"use_config_backorders":true,"backorders":42,"use_config_notify_stock_qty":true,"notify_stock_qty":42.0,"use_config_qty_increments":true,"qty_increments":42.0,"use_config_enable_qty_inc":true,"enable_qty_increments":true,"use_config_manage_stock":true,"manage_stock":true,"low_stock_date":"string","is_decimal_divided":true,"stock_status_changed_auto":42,"extension_attributes":{}},"downloadable_product_links":[{"id":42,"title":"string","sort_order":42,"is_shareable":42,"price":42.0,"number_of_downloads":42,"link_type":"string","link_file":"string","link_file_content":{"file_data":"string","name":"string","extension_attributes":{}},"link_url":"string","sample_type":"string","sample_file":"string","sample_file_content":{"file_data":"string","name":"string","extension_attributes":{}},"sample_url":"string","extension_attributes":{}}],"downloadable_product_samples":[{"id":42,"title":"string","sort_order":42,"sample_type":"string","sample_file":"string","sample_file_content":{"file_data":"string","name":"string","extension_attributes":{}},"sample_url":"string","extension_attributes":{}}],"giftcard_amounts":[{"attribute_id":42,"website_id":42,"value":42.0,"website_value":42.0,"extension_attributes":{}}],"configurable_product_options":[{"id":42,"attribute_id":"string","label":"string","position":42,"is_use_default":true,"values":[{"value_index":"string","extension_attributes":{}}],"extension_attributes":{},"product_id":42}],"configurable_product_links":[42],"mapped_size":"string"},"product_links":[{"sku":"string","link_type":"string","linked_product_sku":"string","linked_product_type":"string","position":42,"extension_attributes":{"qty":42.0}}],"options":[{"product_sku":"string","option_id":42,"title":"string","type":"string","sort_order":42,"is_require":true,"price":42.0,"price_type":"string","sku":"string","file_extension":"string","max_characters":42,"image_size_x":42,"image_size_y":42,"values":[{"title":"string","sort_order":42,"price":42.0,"price_type":"string","sku":"string","option_type_id":42}],"extension_attributes":{}}],"media_gallery_entries":[{"id":42,"media_type":"string","label":"string","position":42,"disabled":true,"types":["string"],"file":"string","content":{"base64_encoded_data":"string","type":"string","name":"string"},"extension_attributes":{"video_content":{"media_type":"string","video_provider":"string","video_url":"string","video_title":"string","video_description":"string","video_metadata":"string"}}}],"tier_prices":[{"customer_group_id":42,"qty":42.0,"value":42.0,"extension_attributes":{"percentage_value":42.0,"website_id":42}}],"custom_attributes":[{"attribute_code":"string","value":"string"}]},"saveOptions":true}'

Request examples

{
  "product": {
    "id": 42,
    "sku": "string",
    "name": "string",
    "attribute_set_id": 42,
    "price": 42.0,
    "status": 42,
    "visibility": 42,
    "type_id": "string",
    "created_at": "string",
    "updated_at": "string",
    "weight": 42.0,
    "extension_attributes": {
      "website_ids": [
        42
      ],
      "category_links": [
        {
          "position": 42,
          "category_id": "string",
          "extension_attributes": {}
        }
      ],
      "discounts": [
        {
          "discount_data": {
            "amount": 42.0,
            "base_amount": 42.0,
            "original_amount": 42.0,
            "base_original_amount": 42.0
          },
          "rule_label": "string",
          "rule_i_d": 42
        }
      ],
      "bundle_product_options": [
        {
          "option_id": 42,
          "title": "string",
          "required": true,
          "type": "string",
          "position": 42,
          "sku": "string",
          "product_links": [
            {
              "id": "string",
              "sku": "string",
              "option_id": 42,
              "qty": 42.0,
              "position": 42,
              "is_default": true,
              "price": 42.0,
              "price_type": 42,
              "can_change_quantity": 42,
              "extension_attributes": {}
            }
          ],
          "extension_attributes": {}
        }
      ],
      "stock_item": {
        "item_id": 42,
        "product_id": 42,
        "stock_id": 42,
        "qty": 42.0,
        "is_in_stock": true,
        "is_qty_decimal": true,
        "show_default_notification_message": true,
        "use_config_min_qty": true,
        "min_qty": 42.0,
        "use_config_min_sale_qty": 42,
        "min_sale_qty": 42.0,
        "use_config_max_sale_qty": true,
        "max_sale_qty": 42.0,
        "use_config_backorders": true,
        "backorders": 42,
        "use_config_notify_stock_qty": true,
        "notify_stock_qty": 42.0,
        "use_config_qty_increments": true,
        "qty_increments": 42.0,
        "use_config_enable_qty_inc": true,
        "enable_qty_increments": true,
        "use_config_manage_stock": true,
        "manage_stock": true,
        "low_stock_date": "string",
        "is_decimal_divided": true,
        "stock_status_changed_auto": 42,
        "extension_attributes": {}
      },
      "downloadable_product_links": [
        {
          "id": 42,
          "title": "string",
          "sort_order": 42,
          "is_shareable": 42,
          "price": 42.0,
          "number_of_downloads": 42,
          "link_type": "string",
          "link_file": "string",
          "link_file_content": {
            "file_data": "string",
            "name": "string",
            "extension_attributes": {}
          },
          "link_url": "string",
          "sample_type": "string",
          "sample_file": "string",
          "sample_file_content": {
            "file_data": "string",
            "name": "string",
            "extension_attributes": {}
          },
          "sample_url": "string",
          "extension_attributes": {}
        }
      ],
      "downloadable_product_samples": [
        {
          "id": 42,
          "title": "string",
          "sort_order": 42,
          "sample_type": "string",
          "sample_file": "string",
          "sample_file_content": {
            "file_data": "string",
            "name": "string",
            "extension_attributes": {}
          },
          "sample_url": "string",
          "extension_attributes": {}
        }
      ],
      "giftcard_amounts": [
        {
          "attribute_id": 42,
          "website_id": 42,
          "value": 42.0,
          "website_value": 42.0,
          "extension_attributes": {}
        }
      ],
      "configurable_product_options": [
        {
          "id": 42,
          "attribute_id": "string",
          "label": "string",
          "position": 42,
          "is_use_default": true,
          "values": [
            {
              "value_index": "string",
              "extension_attributes": {}
            }
          ],
          "extension_attributes": {},
          "product_id": 42
        }
      ],
      "configurable_product_links": [
        42
      ],
      "mapped_size": "string"
    },
    "product_links": [
      {
        "sku": "string",
        "link_type": "string",
        "linked_product_sku": "string",
        "linked_product_type": "string",
        "position": 42,
        "extension_attributes": {
          "qty": 42.0
        }
      }
    ],
    "options": [
      {
        "product_sku": "string",
        "option_id": 42,
        "title": "string",
        "type": "string",
        "sort_order": 42,
        "is_require": true,
        "price": 42.0,
        "price_type": "string",
        "sku": "string",
        "file_extension": "string",
        "max_characters": 42,
        "image_size_x": 42,
        "image_size_y": 42,
        "values": [
          {
            "title": "string",
            "sort_order": 42,
            "price": 42.0,
            "price_type": "string",
            "sku": "string",
            "option_type_id": 42
          }
        ],
        "extension_attributes": {}
      }
    ],
    "media_gallery_entries": [
      {
        "id": 42,
        "media_type": "string",
        "label": "string",
        "position": 42,
        "disabled": true,
        "types": [
          "string"
        ],
        "file": "string",
        "content": {
          "base64_encoded_data": "string",
          "type": "string",
          "name": "string"
        },
        "extension_attributes": {
          "video_content": {
            "media_type": "string",
            "video_provider": "string",
            "video_url": "string",
            "video_title": "string",
            "video_description": "string",
            "video_metadata": "string"
          }
        }
      }
    ],
    "tier_prices": [
      {
        "customer_group_id": 42,
        "qty": 42.0,
        "value": 42.0,
        "extension_attributes": {
          "percentage_value": 42.0,
          "website_id": 42
        }
      }
    ],
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "string"
      }
    ]
  },
  "saveOptions": true
}

Response examples (200)

{
  "id": 42,
  "sku": "string",
  "name": "string",
  "attribute_set_id": 42,
  "price": 42.0,
  "status": 42,
  "visibility": 42,
  "type_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "weight": 42.0,
  "extension_attributes": {
    "website_ids": [
      42
    ],
    "category_links": [
      {
        "position": 42,
        "category_id": "string",
        "extension_attributes": {}
      }
    ],
    "discounts": [
      {
        "discount_data": {
          "amount": 42.0,
          "base_amount": 42.0,
          "original_amount": 42.0,
          "base_original_amount": 42.0
        },
        "rule_label": "string",
        "rule_i_d": 42
      }
    ],
    "bundle_product_options": [
      {
        "option_id": 42,
        "title": "string",
        "required": true,
        "type": "string",
        "position": 42,
        "sku": "string",
        "product_links": [
          {
            "id": "string",
            "sku": "string",
            "option_id": 42,
            "qty": 42.0,
            "position": 42,
            "is_default": true,
            "price": 42.0,
            "price_type": 42,
            "can_change_quantity": 42,
            "extension_attributes": {}
          }
        ],
        "extension_attributes": {}
      }
    ],
    "stock_item": {
      "item_id": 42,
      "product_id": 42,
      "stock_id": 42,
      "qty": 42.0,
      "is_in_stock": true,
      "is_qty_decimal": true,
      "show_default_notification_message": true,
      "use_config_min_qty": true,
      "min_qty": 42.0,
      "use_config_min_sale_qty": 42,
      "min_sale_qty": 42.0,
      "use_config_max_sale_qty": true,
      "max_sale_qty": 42.0,
      "use_config_backorders": true,
      "backorders": 42,
      "use_config_notify_stock_qty": true,
      "notify_stock_qty": 42.0,
      "use_config_qty_increments": true,
      "qty_increments": 42.0,
      "use_config_enable_qty_inc": true,
      "enable_qty_increments": true,
      "use_config_manage_stock": true,
      "manage_stock": true,
      "low_stock_date": "string",
      "is_decimal_divided": true,
      "stock_status_changed_auto": 42,
      "extension_attributes": {}
    },
    "downloadable_product_links": [
      {
        "id": 42,
        "title": "string",
        "sort_order": 42,
        "is_shareable": 42,
        "price": 42.0,
        "number_of_downloads": 42,
        "link_type": "string",
        "link_file": "string",
        "link_file_content": {
          "file_data": "string",
          "name": "string",
          "extension_attributes": {}
        },
        "link_url": "string",
        "sample_type": "string",
        "sample_file": "string",
        "sample_file_content": {
          "file_data": "string",
          "name": "string",
          "extension_attributes": {}
        },
        "sample_url": "string",
        "extension_attributes": {}
      }
    ],
    "downloadable_product_samples": [
      {
        "id": 42,
        "title": "string",
        "sort_order": 42,
        "sample_type": "string",
        "sample_file": "string",
        "sample_file_content": {
          "file_data": "string",
          "name": "string",
          "extension_attributes": {}
        },
        "sample_url": "string",
        "extension_attributes": {}
      }
    ],
    "giftcard_amounts": [
      {
        "attribute_id": 42,
        "website_id": 42,
        "value": 42.0,
        "website_value": 42.0,
        "extension_attributes": {}
      }
    ],
    "configurable_product_options": [
      {
        "id": 42,
        "attribute_id": "string",
        "label": "string",
        "position": 42,
        "is_use_default": true,
        "values": [
          {
            "value_index": "string",
            "extension_attributes": {}
          }
        ],
        "extension_attributes": {},
        "product_id": 42
      }
    ],
    "configurable_product_links": [
      42
    ],
    "mapped_size": "string"
  },
  "product_links": [
    {
      "sku": "string",
      "link_type": "string",
      "linked_product_sku": "string",
      "linked_product_type": "string",
      "position": 42,
      "extension_attributes": {
        "qty": 42.0
      }
    }
  ],
  "options": [
    {
      "product_sku": "string",
      "option_id": 42,
      "title": "string",
      "type": "string",
      "sort_order": 42,
      "is_require": true,
      "price": 42.0,
      "price_type": "string",
      "sku": "string",
      "file_extension": "string",
      "max_characters": 42,
      "image_size_x": 42,
      "image_size_y": 42,
      "values": [
        {
          "title": "string",
          "sort_order": 42,
          "price": 42.0,
          "price_type": "string",
          "sku": "string",
          "option_type_id": 42
        }
      ],
      "extension_attributes": {}
    }
  ],
  "media_gallery_entries": [
    {
      "id": 42,
      "media_type": "string",
      "label": "string",
      "position": 42,
      "disabled": true,
      "types": [
        "string"
      ],
      "file": "string",
      "content": {
        "base64_encoded_data": "string",
        "type": "string",
        "name": "string"
      },
      "extension_attributes": {
        "video_content": {
          "media_type": "string",
          "video_provider": "string",
          "video_url": "string",
          "video_title": "string",
          "video_description": "string",
          "video_metadata": "string"
        }
      }
    }
  ],
  "tier_prices": [
    {
      "customer_group_id": 42,
      "qty": 42.0,
      "value": 42.0,
      "extension_attributes": {
        "percentage_value": 42.0,
        "website_id": 42
      }
    }
  ],
  "custom_attributes": [
    {
      "attribute_code": "string",
      "value": "string"
    }
  ]
}

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}