products

post/V1/products

Create product

Request

Request Body schema:
application/json

required	object (catalog-data-product-interface)
saveOptions	boolean

Responses

200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples

Payload

{"product": {"id": 0,
"sku": "string",
"name": "string",
"attribute_set_id": 0,
"price": 0,
"status": 0,
"visibility": 0,
"type_id": "string",
"created_at": "string",
"updated_at": "string",
"weight": 0,
"extension_attributes": {"website_ids": [0
],
"category_links": [{"position": 0,
"category_id": "string",
"extension_attributes": { }
}
],
"discounts": [{"discount_data": {"amount": 0,
"base_amount": 0,
"original_amount": 0,
"base_original_amount": 0
},
"rule_label": "string",
"rule_i_d": 0
}
],
"bundle_product_options": [{"option_id": 0,
"title": "string",
"required": true,
"type": "string",
"position": 0,
"sku": "string",
"product_links": [{"id": "string",
"sku": "string",
"option_id": 0,
"qty": 0,
"position": 0,
"is_default": true,
"price": 0,
"price_type": 0,
"can_change_quantity": 0,
"extension_attributes": { }
}
],
"extension_attributes": { }
}
],
"stock_item": {"item_id": 0,
"product_id": 0,
"stock_id": 0,
"qty": 0,
"is_in_stock": true,
"is_qty_decimal": true,
"show_default_notification_message": true,
"use_config_min_qty": true,
"min_qty": 0,
"use_config_min_sale_qty": 0,
"min_sale_qty": 0,
"use_config_max_sale_qty": true,
"max_sale_qty": 0,
"use_config_backorders": true,
"backorders": 0,
"use_config_notify_stock_qty": true,
"notify_stock_qty": 0,
"use_config_qty_increments": true,
"qty_increments": 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": 0,
"extension_attributes": { }
},
"downloadable_product_links": [{"id": 0,
"title": "string",
"sort_order": 0,
"is_shareable": 0,
"price": 0,
"number_of_downloads": 0,
"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": 0,
"title": "string",
"sort_order": 0,
"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": 0,
"website_id": 0,
"value": 0,
"website_value": 0,
"extension_attributes": { }
}
],
"configurable_product_options": [{"id": 0,
"attribute_id": "string",
"label": "string",
"position": 0,
"is_use_default": true,
"values": [{"value_index": 0,
"extension_attributes": { }
}
],
"extension_attributes": { },
"product_id": 0
}
],
"configurable_product_links": [0
]
},
"product_links": [{"sku": "string",
"link_type": "string",
"linked_product_sku": "string",
"linked_product_type": "string",
"position": 0,
"extension_attributes": {"qty": 0
}
}
],
"options": [{"product_sku": "string",
"option_id": 0,
"title": "string",
"type": "string",
"sort_order": 0,
"is_require": true,
"price": 0,
"price_type": "string",
"sku": "string",
"file_extension": "string",
"max_characters": 0,
"image_size_x": 0,
"image_size_y": 0,
"values": [{"title": "string",
"sort_order": 0,
"price": 0,
"price_type": "string",
"sku": "string",
"option_type_id": 0
}
],
"extension_attributes": { }
}
],
"media_gallery_entries": [{"id": 0,
"media_type": "string",
"label": "string",
"position": 0,
"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": 0,
"qty": 0,
"value": 0,
"extension_attributes": {"percentage_value": 0,
"website_id": 0
}
}
],
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"saveOptions": true
}

Response samples

200
400
401
default

{"id": 0,
"sku": "string",
"name": "string",
"attribute_set_id": 0,
"price": 0,
"status": 0,
"visibility": 0,
"type_id": "string",
"created_at": "string",
"updated_at": "string",
"weight": 0,
"extension_attributes": {"website_ids": [0
],
"category_links": [{"position": 0,
"category_id": "string",
"extension_attributes": { }
}
],
"discounts": [{"discount_data": {"amount": 0,
"base_amount": 0,
"original_amount": 0,
"base_original_amount": 0
},
"rule_label": "string",
"rule_i_d": 0
}
],
"bundle_product_options": [{"option_id": 0,
"title": "string",
"required": true,
"type": "string",
"position": 0,
"sku": "string",
"product_links": [{"id": "string",
"sku": "string",
"option_id": 0,
"qty": 0,
"position": 0,
"is_default": true,
"price": 0,
"price_type": 0,
"can_change_quantity": 0,
"extension_attributes": { }
}
],
"extension_attributes": { }
}
],
"stock_item": {"item_id": 0,
"product_id": 0,
"stock_id": 0,
"qty": 0,
"is_in_stock": true,
"is_qty_decimal": true,
"show_default_notification_message": true,
"use_config_min_qty": true,
"min_qty": 0,
"use_config_min_sale_qty": 0,
"min_sale_qty": 0,
"use_config_max_sale_qty": true,
"max_sale_qty": 0,
"use_config_backorders": true,
"backorders": 0,
"use_config_notify_stock_qty": true,
"notify_stock_qty": 0,
"use_config_qty_increments": true,
"qty_increments": 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": 0,
"extension_attributes": { }
},
"downloadable_product_links": [{"id": 0,
"title": "string",
"sort_order": 0,
"is_shareable": 0,
"price": 0,
"number_of_downloads": 0,
"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": 0,
"title": "string",
"sort_order": 0,
"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": 0,
"website_id": 0,
"value": 0,
"website_value": 0,
"extension_attributes": { }
}
],
"configurable_product_options": [{"id": 0,
"attribute_id": "string",
"label": "string",
"position": 0,
"is_use_default": true,
"values": [{"value_index": 0,
"extension_attributes": { }
}
],
"extension_attributes": { },
"product_id": 0
}
],
"configurable_product_links": [0
]
},
"product_links": [{"sku": "string",
"link_type": "string",
"linked_product_sku": "string",
"linked_product_type": "string",
"position": 0,
"extension_attributes": {"qty": 0
}
}
],
"options": [{"product_sku": "string",
"option_id": 0,
"title": "string",
"type": "string",
"sort_order": 0,
"is_require": true,
"price": 0,
"price_type": "string",
"sku": "string",
"file_extension": "string",
"max_characters": 0,
"image_size_x": 0,
"image_size_y": 0,
"values": [{"title": "string",
"sort_order": 0,
"price": 0,
"price_type": "string",
"sku": "string",
"option_type_id": 0
}
],
"extension_attributes": { }
}
],
"media_gallery_entries": [{"id": 0,
"media_type": "string",
"label": "string",
"position": 0,
"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": 0,
"qty": 0,
"value": 0,
"extension_attributes": {"percentage_value": 0,
"website_id": 0
}
}
],
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}

products

get/V1/products

Get product list

Request

query Parameters

searchCriteria[currentPage]	integer Current page.
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[pageSize]	integer Page size.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[sortOrders][0][field]	string Sorting field.

Responses

200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples

200
401
default

{"items": [{"id": 0,
"sku": "string",
"name": "string",
"attribute_set_id": 0,
"price": 0,
"status": 0,
"visibility": 0,
"type_id": "string",
"created_at": "string",
"updated_at": "string",
"weight": 0,
"extension_attributes": {"website_ids": [0
],
"category_links": [{"position": 0,
"category_id": "string",
"extension_attributes": { }
}
],
"discounts": [{"discount_data": {"amount": 0,
"base_amount": 0,
"original_amount": 0,
"base_original_amount": 0
},
"rule_label": "string",
"rule_i_d": 0
}
],
"bundle_product_options": [{"option_id": 0,
"title": "string",
"required": true,
"type": "string",
"position": 0,
"sku": "string",
"product_links": [{"id": null,
"sku": null,
"option_id": null,
"qty": null,
"position": null,
"is_default": null,
"price": null,
"price_type": null,
"can_change_quantity": null,
"extension_attributes": null
}
],
"extension_attributes": { }
}
],
"stock_item": {"item_id": 0,
"product_id": 0,
"stock_id": 0,
"qty": 0,
"is_in_stock": true,
"is_qty_decimal": true,
"show_default_notification_message": true,
"use_config_min_qty": true,
"min_qty": 0,
"use_config_min_sale_qty": 0,
"min_sale_qty": 0,
"use_config_max_sale_qty": true,
"max_sale_qty": 0,
"use_config_backorders": true,
"backorders": 0,
"use_config_notify_stock_qty": true,
"notify_stock_qty": 0,
"use_config_qty_increments": true,
"qty_increments": 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": 0,
"extension_attributes": { }
},
"downloadable_product_links": [{"id": 0,
"title": "string",
"sort_order": 0,
"is_shareable": 0,
"price": 0,
"number_of_downloads": 0,
"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": 0,
"title": "string",
"sort_order": 0,
"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": 0,
"website_id": 0,
"value": 0,
"website_value": 0,
"extension_attributes": { }
}
],
"configurable_product_options": [{"id": 0,
"attribute_id": "string",
"label": "string",
"position": 0,
"is_use_default": true,
"values": [{"value_index": null,
"extension_attributes": null
}
],
"extension_attributes": { },
"product_id": 0
}
],
"configurable_product_links": [0
]
},
"product_links": [{"sku": "string",
"link_type": "string",
"linked_product_sku": "string",
"linked_product_type": "string",
"position": 0,
"extension_attributes": {"qty": 0
}
}
],
"options": [{"product_sku": "string",
"option_id": 0,
"title": "string",
"type": "string",
"sort_order": 0,
"is_require": true,
"price": 0,
"price_type": "string",
"sku": "string",
"file_extension": "string",
"max_characters": 0,
"image_size_x": 0,
"image_size_y": 0,
"values": [{"title": "string",
"sort_order": 0,
"price": 0,
"price_type": "string",
"sku": "string",
"option_type_id": 0
}
],
"extension_attributes": { }
}
],
"media_gallery_entries": [{"id": 0,
"media_type": "string",
"label": "string",
"position": 0,
"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": 0,
"qty": 0,
"value": 0,
"extension_attributes": {"percentage_value": 0,
"website_id": 0
}
}
],
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

➔ Next to products/attribute-sets

products

products

Request Body schema: application/jsonapplication/xmlapplication/json

products

query Parameters

Request Body schema:
application/json