Products

APIs for maketplace owner to manager vendor products.

Get product list

Request

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[pageSize]	integer Page size.
searchCriteria[currentPage]	integer Current page.
vendor_id	integer Specify vendor id to filter products.

Responses

200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/products

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": { }
}
],
"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": { }
}
],
"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": { }
}
],
"extension_attributes": { },
"product_id": 0
}
],
"configurable_product_links": [0
],
"vertex_commodity_code": {"code": "string",
"type": "string"
}
},
"product_links": [{"sku": "string",
"link_type": "string",
"linked_product_sku": "string",
"linked_product_type": "string",
"position": 0,
"extension_attributes": {"qty": 0
}
}
],
"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
}

Create or update product - [deprecated]

Because performance issues with this default magento API, we suggest to use POST /V1/omnyfy/products instead. Native call to create a product. Use the Inventory API to assign the product to a specific Vendor on the marketplace.

Request

Request Body schema: application/json
optional

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

Responses

200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

post/rest/V1/products

Request samples

Payload

application/json

{"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": { }
}
],
"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
],
"vertex_commodity_code": {"code": "string",
"type": "string"
}
},
"product_links": [{"sku": "string",
"link_type": "string",
"linked_product_sku": "string",
"linked_product_type": "string",
"position": 0,
"extension_attributes": {"qty": 0
}
}
],
"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

application/json

{"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": { }
}
],
"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
],
"vertex_commodity_code": {"code": "string",
"type": "string"
}
},
"product_links": [{"sku": "string",
"link_type": "string",
"linked_product_sku": "string",
"linked_product_type": "string",
"position": 0,
"extension_attributes": {"qty": 0
}
}
],
"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"
}
]
}

Get product by SKU

Request

path Parameters

sku

required

string

query Parameters

editMode	boolean
storeId	integer
forceReload	boolean

Responses

200

200 Success.

get/rest/V1/products/{sku}

Response samples

application/json

{"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": { }
}
],
"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
],
"vertex_commodity_code": {"code": "string",
"type": "string"
}
}
],
"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": {"vertex_flex_field": "string"
}
}
],
"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"
}
}

Delete product

delete product

Request

path Parameters

sku

required

string

Responses

200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

delete/rest/V1/products/{sku}

Response samples

200
400
401
default

application/json

true

Get category list

Request

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.

Responses

200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/V1/categories/list

Response samples

200
401
default

application/json

{"items": [{"id": 0,
"parent_id": 0,
"name": "string",
"is_active": true,
"position": 0,
"level": 0,
"children": "string",
"created_at": "string",
"updated_at": "string",
"path": "string",
"available_sort_by": ["string"
],
"include_in_menu": true,
"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
}

Import products

This API provides aggregated product import with better performance than the stock Magento V1/products API. Import product, image upload, assign vendor and set vendor location quantity can be done within one API call.

Please use the field “variant_skus” to provide all child product SKUs for the configurable (parent) product.
Please use the field “super_attribute_codes” to provide all attributes (example, colour, size etc) that are used to link child product SKUs to the configurable (parent) product.
Please provide values in each child product for attributes in parent product in point 2 above where 4763 is the code for the colour of that child product. Example - { "attribute_code": "color", "value": 4763 }
Please use the field “type_id”. Value will be “configurable” for parent product and “simple” for child products.
Please use the field “visibility”.Value will be 4 for parent product and 1 for child products.
See Response samples - items from above points are provided. You do not need to send the child products in the same payload

Request

Request Body schema: application/json
optional

required

Array of objects (omnyfy-product-import)

Responses

200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

post/V1/omnyfy/products

Request samples

Payload

application/json

[{"inventory": { },
"price": { },
"product_data": {"sku": "child_sku_1",
"type_id": "simple",
"visibility": 1,
"custom_attributes": [{"attribute_code": "color",
"value": "5"
},
{"attribute_code": "size",
"value": "7"
}
]
}
},
{"inventory": { },
"price": { },
"product_data": {"sku": "child_sku_2",
"type_id": "simple",
"visibility": 1,
"custom_attributes": [{"attribute_code": "color",
"value": "6"
},
{"attribute_code": "size",
"value": "8"
}
]
}
},
{"inventory": { },
"price": { },
"product_data": {"sku": "configurable_product_example",
"type_id": "configurable,",
"visibility": 4,
"super_attribute_codes": ["size",
"color"
],
"variant_skus": ["child_sku_1",
"child_sku_2"
]
}
}
]

Response samples

200
400
401
default

application/json

{"items": [{"success": true,
"error": "string",
"product_data": {"id": 0,
"sku": "string"
}
}
]
}

Get Product Attributes

Retrieve all attributes for entity type

Request

query Parameters

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

Responses

200

200 Success.

get/rest/V1/products/attributes

Response samples

application/json

{"items": [{"extension_attributes": {"is_pagebuilder_enabled": true
},
"is_wysiwyg_enabled": true,
"is_html_allowed_on_front": true,
"used_for_sort_by": true,
"is_filterable": true,
"is_filterable_in_search": true,
"is_used_in_grid": true,
"is_visible_in_grid": true,
"is_filterable_in_grid": true,
"position": 0,
"apply_to": ["string"
],
"is_searchable": "string",
"is_visible_in_advanced_search": "string",
"is_comparable": "string",
"is_used_for_promo_rules": "string",
"is_visible_on_front": "string",
"used_in_product_listing": "string",
"is_visible": true,
"scope": "string",
"attribute_id": 0,
"attribute_code": "string",
"frontend_input": "string",
"entity_type_id": "string",
"is_required": true,
"options": [{"label": "string",
"value": "string",
"sort_order": 0,
"is_default": true,
"store_labels": [{"store_id": 0,
"label": "string"
}
]
}
],
"is_user_defined": true,
"default_frontend_label": "string",
"frontend_labels": [{"store_id": 0,
"label": "string"
}
],
"note": "string",
"backend_type": "string",
"backend_model": "string",
"source_model": "string",
"default_value": "string",
"is_unique": "string",
"frontend_class": "string",
"validation_rules": [{"key": "string",
"value": "string"
}
],
"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 Inventory

Products

Get product list

query Parameters

Create or update product - [deprecated]

Request Body schema: application/jsonoptional

Get product by SKU

path Parameters

query Parameters

Delete product

path Parameters

Get category list

query Parameters

Import products

Request Body schema: application/jsonoptional

Get Product Attributes

query Parameters

Request Body schema: application/json
optional

Request Body schema: application/json
optional