Responses

• 200

  application/json

  application/json application/xml

  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]
      Hide discounts attributes Show discounts attributes object

      Rule discount Interface

      • 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]
      Hide bundle_product_options attributes Show bundle_product_options attributes object

      Interface OptionInterface

      • 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]

        Product links

        Hide product_links attributes Show product_links attributes object

        Interface LinkInterface

        • 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]
      Hide giftcard_amounts attributes Show giftcard_amounts attributes object

      Interface GiftcardAmountInterface: this interface is used to serialize and deserialize EAV attribute giftcard_amounts

      • 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]
      Hide configurable_product_options attributes Show configurable_product_options attributes object

      Interface OptionInterface

      • id integer
      • attribute_id string
      • label string
      • position integer
      • is_use_default boolean
      • values array[object]
        Hide values attributes Show values attributes object

        Interface OptionValueInterface

        • 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]

    Product links info

    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]

    List of product options

    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]

    Media gallery entries

    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]

    List of product tier prices

    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]

    Custom attributes values.

    Hide custom_attributes attributes Show custom_attributes attributes object

    Interface for custom attribute value.

    • attribute_code string Required

      Attribute code

    • value string Required

      Attribute value

  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]
      Hide discounts attributes Show discounts attributes object

      Rule discount Interface

      • 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]
      Hide bundle_product_options attributes Show bundle_product_options attributes object

      Interface OptionInterface

      • 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]

        Product links

        Hide product_links attributes Show product_links attributes object

        Interface LinkInterface

        • 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]
      Hide giftcard_amounts attributes Show giftcard_amounts attributes object

      Interface GiftcardAmountInterface: this interface is used to serialize and deserialize EAV attribute giftcard_amounts

      • 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]
      Hide configurable_product_options attributes Show configurable_product_options attributes object

      Interface OptionInterface

      • id integer
      • attribute_id string
      • label string
      • position integer
      • is_use_default boolean
      • values array[object]
        Hide values attributes Show values attributes object

        Interface OptionValueInterface

        • 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]

    Product links info

    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]

    List of product options

    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]

    Media gallery entries

    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]

    List of product tier prices

    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]

    Custom attributes values.

    Hide custom_attributes attributes Show custom_attributes attributes object

    Interface for custom attribute value.

    • attribute_code string Required

      Attribute code

    • value string Required

      Attribute value

• 401

  application/json

  application/json application/xml

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Errors list

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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 list

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Errors list

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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 list

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• 400

  application/json

  application/json application/xml

  400 Bad Request

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Errors list

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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 list

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Errors list

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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 list

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  application/json

  application/json application/xml

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Errors list

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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 list

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Errors list

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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 list

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace