Rest API
Seller Rest API
Get Current Seller
Endpoint: /V1/sellers/me
Method:
GET
Params:
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
Update profile Seller
Endpoint: /V1/saveprofile/me
Method:
PUT
Params:
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
Save Seller
Endpoint: /V1/sellers
Method:
PUT
Params:
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
Sales REST API
Get Seller Order
Endpoint: /V1/getsellerorders
Method:
GET
Params:
Response Data:
"string"
Get Seller Order By Id
Endpoint: /V1/sellerordersbyid/:id
Method:
GET
Params:
id
Response Data:
"string"
Get Order Cancel
Endpoint: /V1/sellerorders/:orderId/cancel
Method:
GET
Params:
orderId
Response Data:
"string"
Get Seller Invoices
Endpoint: /V1/sellerinvoices
Method:
GET
Params:
Response Data:
"string"
Get Seller Invoices By Id
Endpoint: /V1/sellerinvoices/:InvoiceId
Method: get
Params:
InvoiceId
Response Data:
"string"
Seller, Admin manage Ratings
Seller Get List
Endpoint: /V1/seller/myRating
Method:
GET
Params:
Response Data:
{
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
}
Get My Rating
Endpoint: /V1/seller/myRatings/:ratingId
Method:
GET
Params:
ratingId
Response Data:
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "string"
}
Update My Rating
Endpoint: /V1/seller/myRatings/:ratingId
Method:
PUT
Params:
ratingId
Body:
{ "rating": { "rating_id": 0, "seller_id": 0, "customer_id": 0, "rate1": 0, "rate2": 0, "rate3": 0, "rating": 0, "status": "string", "title": "string", "detail": "string", "nickname": "string", "created_at": "string", "verified_buyer": 0, "is_recommended": true, "answer": "string", "admin_note": "string", "like_about": "string", "not_like_about": "string", "guest_email": "string", "email": "string", "plus_review": 0, "minus_review": 0, "report_abuse": 0, "updated_at": "string" } }
Response Data:
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "string"
}
Get Rating
Endpoint: /V1/sellerRatings/:ratingId
Method:
GET
Params:
ratingId
Response Data:
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "string"
}
Get List Rating
Endpoint: /V1/sellerRatings/search
Method:
GET
Params:
Response Data:
{
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
}
Update Rating
Endpoint: /V1/sellerRatings/:ratingId
Method:
PUT
Params:
ratingId
Body:
{ "rating": { "rating_id": 0, "seller_id": 0, "customer_id": 0, "rate1": 0, "rate2": 0, "rate3": 0, "rating": 0, "status": "string", "title": "string", "detail": "string", "nickname": "string", "created_at": "string", "verified_buyer": 0, "is_recommended": true, "answer": "string", "admin_note": "string", "like_about": "string", "not_like_about": "string", "guest_email": "string", "email": "string", "plus_review": 0, "minus_review": 0, "report_abuse": 0, "updated_at": "string" } }
Response Data:
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "string"
}
Delete Rating By Id
Endpoint: /V1/sellerRatings/:ratingId
Method:
DELETE
Params:
ratingId
Response Data:
true
Seller Manage Messages API
Get List Message
Endpoint: /V1/seller/messages
Method:
GET
Params:
Response Data:
{
"items": [
{
"message_id": 0,
"description": "string",
"subject": "string",
"sender_email": "string",
"sender_name": "string",
"created_at": "string",
"status": 0,
"is_read": 0,
"sender_id": "string",
"owner_id": 0,
"receiver_id": 0,
"seller_send": 0
}
],
"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
}
Get Message Details
Endpoint: /V1/seller/messages/:messageId
Method:
GET
Params:
messageId
Response Data:
{
"items": [
{
"message_id": 0,
"description": "string",
"subject": "string",
"sender_email": "string",
"sender_name": "string",
"created_at": "string",
"status": 0,
"is_read": 0,
"sender_id": "string",
"owner_id": 0,
"receiver_id": 0,
"seller_send": 0
}
],
"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
}
Seller Reply Message
Endpoint: /V1/seller/messages/:messageId
Method:
PUT
Params:
messageId
Body
{ "message": "string" }
Response Data:
{
"detail_id": 0,
"message_id": 0,
"seller_send": "string",
"sender_id": 0,
"sender_email": "string",
"sender_name": "string",
"receiver_id": 0,
"receiver_email": "string",
"receiver_name": "string",
"content": "string",
"is_read": 0,
"created_at": "string",
"message_admin": 0
}
Set Is Read Message
Endpoint: /V1/seller/isReadMessage/:messageId
Method:
PUT
Params:
messageId
Body
{ "status": "string" }
Response Data:
{
"message_id": 0,
"description": "string",
"subject": "string",
"sender_email": "string",
"sender_name": "string",
"created_at": "string",
"status": 0,
"is_read": 0,
"sender_id": "string",
"owner_id": 0,
"receiver_id": 0,
"seller_send": 0
}
Seller Delete Message
Endpoint: /V1/seller/messages/:messageId
Method:
DELETE
Params:
messageId
Response Data:
true
Seller Manage Admin Messages API
Get List Admin Message
Endpoint: /V1/seller/adminmessages
Method:
GET
Params:
Response Data:
{
"items": [
{
"message_id": 0,
"description": "string",
"subject": "string",
"admin_email": "string",
"admin_name": "string",
"seller_email": "string",
"seller_name": "string",
"created_at": "string",
"status": 0,
"is_read": 0,
"admin_id": 0,
"owner_id": 0,
"seller_id": 0,
"receiver_id": 0,
"seller_send": 0
}
],
"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
}
Get Details Message
Endpoint: /V1/seller/adminmessages/:messageId
Method:
GET
Params:
messageId
Response Data:
{
"items": [
{
"detail_id": 0,
"message_id": 0,
"seller_send": "string",
"sender_id": 0,
"sender_email": "string",
"sender_name": "string",
"receiver_id": 0,
"receiver_email": "string",
"receiver_name": "string",
"content": "string",
"is_read": 0,
"created_at": "string",
"message_admin": 0
}
],
"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
}
Send Message
Endpoint: /V1/seller/adminmessages
Method:
POST
Params:
{
"subject": "string",
"message": "string"
}
Response Data:
{
"message_id": 0,
"description": "string",
"subject": "string",
"admin_email": "string",
"admin_name": "string",
"seller_email": "string",
"seller_name": "string",
"created_at": "string",
"status": 0,
"is_read": 0,
"admin_id": 0,
"owner_id": 0,
"seller_id": 0,
"receiver_id": 0,
"seller_send": 0
}
Reply Message
Endpoint: /V1/seller/adminmessages/:messageId
Method:
PUT
Params:
messageId
body
{ "message": "string" }
Response Data:
{
"detail_id": 0,
"message_id": 0,
"seller_send": "string",
"sender_id": 0,
"sender_email": "string",
"sender_name": "string",
"receiver_id": 0,
"receiver_email": "string",
"receiver_name": "string",
"content": "string",
"is_read": 0,
"created_at": "string",
"message_admin": 0
}
Set Id read admin message
Endpoint: /V1/seller/isReadAdminMessage/:messageId
Method:
PUT
Params:
messageId
Body
{ "status": "string" }
Response Data:
{
"message_id": 0,
"description": "string",
"subject": "string",
"admin_email": "string",
"admin_name": "string",
"seller_email": "string",
"seller_name": "string",
"created_at": "string",
"status": 0,
"is_read": 0,
"admin_id": 0,
"owner_id": 0,
"seller_id": 0,
"receiver_id": 0,
"seller_send": 0
}
seller manage his products, update stock, update product price
Seller Update Stock
Endpoint: /V1/sellerproduct/updateStock
Method:
PUT
Params:
{
"product": {
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
}
Response Data:
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
Seller Update Product Price
Endpoint: /V1/sellerproduct/updatePrice
Method: PUT
Params:
{
"product": {
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
}{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
Response Data:
Seller Setting
Save My Setting
Endpoint: /V1/seller/setting
Method:
POST
Params:
{
"setting": {
"setting_id": 0,
"seller_id": 0,
"group": "string",
"key": "string",
"value": "string",
"scope": "string",
"scope_id": 0,
"path": "string",
"updated_at": "string"
}
}
Response Data:
{
"setting_id": 0,
"seller_id": 0,
"group": "string",
"key": "string",
"value": "string",
"scope": "string",
"scope_id": 0,
"path": "string",
"updated_at": "string"
}
Get List Setting
Endpoint: /V1/seller/setting/search
Method:
GET
Params:
Response Data:
"items": [
{
"setting_id": 0,
"seller_id": 0,
"group": "string",
"key": "string",
"value": "string",
"scope": "string",
"scope_id": 0,
"path": "string",
"updated_at": "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
}
Get My Setting
Endpoint: /V1/seller/setting/:settingId
Method:
GET
Params:
settingId
Response Data:
{
"setting_id": 0,
"seller_id": 0,
"group": "string",
"key": "string",
"value": "string",
"scope": "string",
"scope_id": 0,
"path": "string",
"updated_at": "string"
}
Edit My Setting
Endpoint: /V1/seller/setting/:settingId
Method:
PUT
Params:
settingId
Response Data:
{
"setting_id": 0,
"seller_id": 0,
"group": "string",
"key": "string",
"value": "string",
"scope": "string",
"scope_id": 0,
"path": "string",
"updated_at": "string"
}
Seller manage his product
Create Product
Endpoint: /V1/createproduct
Method:
POST
Params:
{
"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": {}
}
],
"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": {}
},
"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": {}
}
],
"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": {}
}
],
"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"
}
]
}
}
Response Data:
{
"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": {}
}
],
"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": {}
},
"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": {}
}
],
"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": {}
}
],
"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"
}
]
}
Edit Product
Endpoint: /V1/sellerproduct/:sku
Method:
PUT
Params:
sku
{ "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": {} } ], "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": {} }, "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": {} } ], "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": {} } ], "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 Data:
{
"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": {}
}
],
"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": {}
},
"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": {}
}
],
"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": {}
}
],
"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"
}
]
}
Get Product
Endpoint: /V1/sellerproduct/:sku
Method:
GET
Params:
sku
storeId
Response Data:
{
"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": {}
}
],
"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": {}
},
"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": {}
}
],
"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": {}
}
],
"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"
}
]
}
Get list product
Endpoint: /V1/sellerproducts
Method:
GET
Params:
Response Data:
{
"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": {}
}
],
"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": {}
},
"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": {}
}
],
"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": {}
}
],
"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"
}
]
}
],
"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
}
API Seller get Transactions
Get Seller Transactions
Endpoint: /V1/seller/transactions
Method:
GET
Params:
Response Data:
{
"items": [
{
"transaction_id": 0,
"customer_id": "string",
"seller_id": 0,
"type": "string",
"amount": 0,
"balance": 0,
"description": "string",
"additional_info": "string",
"created_at": "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
}
Get Seller Vacation
Endpoint: /V1/sellervacation
Method:
GET
Params:
Response Data:
{
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
}
Update Seller Vacation
Endpoint: /V1/sellervacation
Method:
PUT
Params:
{
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
}
}
Response Data:
{
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
}
API Seller Group
Get List Seller Group
Endpoint: /V1/lofmarketplace/groups
Method:
GET
Params:
Response Data:
{
"items": [
{
"group_id": 0,
"url_key": "string",
"name": "string",
"position": 0,
"status": 0,
"show_in_sidebar": 0,
"limit_product": 0,
"can_add_product": 0,
"can_use_shiping": 0,
"can_use_message": 0,
"can_use_vacation": 0,
"can_use_withdrawal": 0
}
],
"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
}
Get Group By ID
Endpoint: /V1/lofmarketplace/group/:entityId
Method:
GET
Params:
entityId
Response Data:
{
"group_id": 0,
"url_key": "string",
"name": "string",
"position": 0,
"status": 0,
"show_in_sidebar": 0,
"limit_product": 0,
"can_add_product": 0,
"can_use_shiping": 0,
"can_use_message": 0,
"can_use_vacation": 0,
"can_use_withdrawal": 0
}
API Manager
Assign product
Endpoint: /V1/assignproducts/:productId/:storeId/:sellerId
Method:
POST
Params:
productId
storeId
sellerId
{ "customerId": 0 }
Response Data:
true
Set Commision For Special Product
Endpoint: /V1/setcommission/:productId/:commission/:seller_id
Method:
POST
Params:
productId
commission
seller_id
{ "sellerId": 0 }
Response Data:
"string"
Delete Group By Id
Endpoint: /V1/lofmarketplace/group/:entityId
Method:
DELETE
Params:
entityId
Response Data:
true
Save Amount Transaction
Endpoint: /V1/lofmarketplace/amounttransaction
Method:
POST
Params:
{
"amountTransaction": {
"transaction_id": 0,
"customer_id": "string",
"seller_id": 0,
"type": "string",
"amount": 0,
"balance": 0,
"description": "string",
"additional_info": "string",
"created_at": "string"
}
}
Response Data:
{
"transaction_id": 0,
"customer_id": "string",
"seller_id": 0,
"type": "string",
"amount": 0,
"balance": 0,
"description": "string",
"additional_info": "string",
"created_at": "string"
}
Get List Amount Transaction
Endpoint: /V1/lofmarketplace/amounttransaction/search
Method:
GET
Params:
Response Data:
{
"items": [
{
"transaction_id": 0,
"customer_id": "string",
"seller_id": 0,
"type": "string",
"amount": 0,
"balance": 0,
"description": "string",
"additional_info": "string",
"created_at": "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
}
Get Amount Transaction by Id
Endpoint:/V1/lofmarketplace/amounttransaction/:id
Method:
GET
Params:
id
Response Data:
{
"transaction_id": 0,
"customer_id": "string",
"seller_id": 0,
"type": "string",
"amount": 0,
"balance": 0,
"description": "string",
"additional_info": "string",
"created_at": "string"
}
Update amount transacion by id
Endpoint: /V1/lofmarketplace/amounttransaction/:id
Method:
PUT
Params:
id
{ "amountTransaction": { "transaction_id": 0, "customer_id": "string", "seller_id": 0, "type": "string", "amount": 0, "balance": 0, "description": "string", "additional_info": "string", "created_at": "string" } }
Response Data:
{
"transaction_id": 0,
"customer_id": "string",
"seller_id": 0,
"type": "string",
"amount": 0,
"balance": 0,
"description": "string",
"additional_info": "string",
"created_at": "string"
}
Delete Transaction By Id
Endpoint: /V1/lofmarketplace/amounttransaction/:id
Method:
DELETE
Params:
id
Response Data:
true
Admin Manage Seller
Get List Seller
Endpoint: /V1/sellers
Method:
GET
Params:
Response Data:
{
"items": [
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"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
}
Get List Seller By Id
Endpoint: /V1/sellers/:sellerId
Method:
GET
Params:
sellerId
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
Update Seller Status
Endpoint: /V1/sellers/changeStatus
Method:
PUT
Params:
{
"sellerId": 0,
"status": 0
}
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
Verifi Seller
Endpoint: /V1/sellers/verify
Method:
PUT
Params:
{
"sellerId": 0,
"status": 0
}
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
Manage Withdrawl request
Save Withdrawl
Endpoint: /V1/lofmarketplace/withdrawal
Method:
POST
Params:
{
"withdrawal": {
"withdrawal_id": "string",
"seller_id": "string",
"payment_id": "string",
"email": "string",
"fee": "string",
"amount": "string",
"net_amount": "string",
"comment": "string",
"admin_message": "string",
"status": "string",
"created_at": "string",
"updated_at": "string"
}
}
Response Data:
{
"withdrawal_id": "string",
"seller_id": "string",
"payment_id": "string",
"email": "string",
"fee": "string",
"amount": "string",
"net_amount": "string",
"comment": "string",
"admin_message": "string",
"status": "string",
"created_at": "string",
"updated_at": "string"
}
Request Withdrawl
Endpoint: /V1/seller/withdrawal
Method:
POST
Params:
{
"withdrawal": {
"withdrawal_id": "string",
"seller_id": "string",
"payment_id": "string",
"email": "string",
"fee": "string",
"amount": "string",
"net_amount": "string",
"comment": "string",
"admin_message": "string",
"status": "string",
"created_at": "string",
"updated_at": "string"
}
}
Response Data:
{
"withdrawal_id": "string",
"seller_id": "string",
"payment_id": "string",
"email": "string",
"fee": "string",
"amount": "string",
"net_amount": "string",
"comment": "string",
"admin_message": "string",
"status": "string",
"created_at": "string",
"updated_at": "string"
}
Get List Withdrawl
Endpoint: /V1/lofmarketplace/withdrawal/search
Method:
GET
Params:
Response Data:
{
"items": [
{
"withdrawal_id": "string",
"seller_id": "string",
"payment_id": "string",
"email": "string",
"fee": "string",
"amount": "string",
"net_amount": "string",
"comment": "string",
"admin_message": "string",
"status": "string",
"created_at": "string",
"updated_at": "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
}
Get My List Withdrawl
Endpoint: /V1/seller/withdrawal/search
Method:
GET
Params:
Response Data:
{
"items": [
{
"withdrawal_id": "string",
"seller_id": "string",
"payment_id": "string",
"email": "string",
"fee": "string",
"amount": "string",
"net_amount": "string",
"comment": "string",
"admin_message": "string",
"status": "string",
"created_at": "string",
"updated_at": "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
}
Get Withdrawl by Id
Endpoint: /V1/lofmarketplace/withdrawal/:withdrawalId
Method:
GET
Params:
withdrawalId
Response Data:
{
"withdrawal_id": "string",
"seller_id": "string",
"payment_id": "string",
"email": "string",
"fee": "string",
"amount": "string",
"net_amount": "string",
"comment": "string",
"admin_message": "string",
"status": "string",
"created_at": "string",
"updated_at": "string"
}
Update Withdrawl
Endpoint: /V1/lofmarketplace/withdrawal/:withdrawalId
Method:
PUT
Params:
withdrawalId
{ "withdrawal": { "withdrawal_id": "string", "seller_id": "string", "payment_id": "string", "email": "string", "fee": "string", "amount": "string", "net_amount": "string", "comment": "string", "admin_message": "string", "status": "string", "created_at": "string", "updated_at": "string" } }
Response Data:
{
"withdrawal_id": "string",
"seller_id": "string",
"payment_id": "string",
"email": "string",
"fee": "string",
"amount": "string",
"net_amount": "string",
"comment": "string",
"admin_message": "string",
"status": "string",
"created_at": "string",
"updated_at": "string"
}
Delete Withdrawl
Endpoint: /V1/lofmarketplace/withdrawal/:withdrawalId
Method:
DELETE
Params:
withdrawalId
Response Data:
true
Save Payment
Endpoint: /V1/llofmarketplace/payment
Method:
POST
Params:
{
"payment": {
"payment_id": "string",
"name": "string",
"fee": "string",
"min_amount": "string",
"max_amount": "string",
"order": "string",
"description": "string",
"message": "string",
"email_account": "string",
"additional": "string",
"status": "string",
"created_at": "string",
"updated_at": "string",
"fee_by": "string",
"fee_percent": "string"
}
}{
"payment_id": "string",
"name": "string",
"fee": "string",
"min_amount": "string",
"max_amount": "string",
"order": "string",
"description": "string",
"message": "string",
"email_account": "string",
"additional": "string",
"status": "string",
"created_at": "string",
"updated_at": "string",
"fee_by": "string",
"fee_percent": "string"
}
Response Data:
Get List Payment
Endpoint: /V1/lofmarketplace/payment/search
Method:
GET
Params:
Response Data:
{
"items": [
{
"payment_id": "string",
"name": "string",
"fee": "string",
"min_amount": "string",
"max_amount": "string",
"order": "string",
"description": "string",
"message": "string",
"email_account": "string",
"additional": "string",
"status": "string",
"created_at": "string",
"updated_at": "string",
"fee_by": "string",
"fee_percent": "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
}
Get Public Payment
Endpoint: /V1/seller/payment/search
Method:
GET
Params:
Response Data:
{
"items": [
{
"payment_id": "string",
"name": "string",
"fee": "string",
"min_amount": "string",
"max_amount": "string",
"order": "string",
"description": "string",
"message": "string",
"email_account": "string",
"additional": "string",
"status": "string",
"created_at": "string",
"updated_at": "string",
"fee_by": "string",
"fee_percent": "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
}
Get Payment By Id
Endpoint: /V1/lofmarketplace/payment/:paymentId
Method:
GET
Params:
paymentId
Response Data:
{
"payment_id": "string",
"name": "string",
"fee": "string",
"min_amount": "string",
"max_amount": "string",
"order": "string",
"description": "string",
"message": "string",
"email_account": "string",
"additional": "string",
"status": "string",
"created_at": "string",
"updated_at": "string",
"fee_by": "string",
"fee_percent": "string"
}
Update payment
Endpoint: /V1/lofmarketplace/payment/:paymentId
Method:
PUT
Params:
paymentId
{ "payment": { "payment_id": "string", "name": "string", "fee": "string", "min_amount": "string", "max_amount": "string", "order": "string", "description": "string", "message": "string", "email_account": "string", "additional": "string", "status": "string", "created_at": "string", "updated_at": "string", "fee_by": "string", "fee_percent": "string" } }
Response Data:
{
"payment_id": "string",
"name": "string",
"fee": "string",
"min_amount": "string",
"max_amount": "string",
"order": "string",
"description": "string",
"message": "string",
"email_account": "string",
"additional": "string",
"status": "string",
"created_at": "string",
"updated_at": "string",
"fee_by": "string",
"fee_percent": "string"
}
Delete Payment
Endpoint: /V1/lofmarketplace/payment/:paymentId
Method:
DELETE
Params:
paymentId
Response Data:
true
Frontend
API get seller group
Endpoint: /V1/seller/groups
Method:
GET
Params:
Response Data:
{
"items": [
{
"group_id": 0,
"url_key": "string",
"name": "string",
"position": 0,
"status": 0,
"show_in_sidebar": 0,
"limit_product": 0,
"can_add_product": 0,
"can_use_shiping": 0,
"can_use_message": 0,
"can_use_vacation": 0,
"can_use_withdrawal": 0
}
],
"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
}
API create seller order by order increment_id
Endpoint: /V1/seller/createorder/:orderId
Method:
POST
Params:
orderId
Response Data:
"string"
API get seller product
Get list seller product
Endpoint: /V1/seller/products/:sellerUrl
Method:
GET
Params:
sellerUrl
Response Data:
Get list product
Endpoint: /V1/seller/products
Method:
GET
Params:
Response Data:
{
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
}
API Register New Seller Account
RegisterNewSeller
Endpoint: /V1/seller/register
Method:
POST
Params:
{
"customer": {
"id": 0,
"group_id": 0,
"default_billing": "string",
"default_shipping": "string",
"confirmation": "string",
"created_at": "string",
"updated_at": "string",
"created_in": "string",
"dob": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"gender": 0,
"store_id": 0,
"taxvat": "string",
"website_id": 0,
"addresses": [
{
"id": 0,
"customer_id": 0,
"region": {
"region_code": "string",
"region": "string",
"region_id": 0,
"extension_attributes": {}
},
"region_id": 0,
"country_id": "string",
"street": [
"string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"default_shipping": true,
"default_billing": true,
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
],
"disable_auto_group_change": 0,
"extension_attributes": {
"assistance_allowed": 0,
"is_subscribed": true
},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
},
"data": {
"shop_url": "string",
"contact_number": "string",
"company": "string",
"address": "string",
"region": "string",
"region_id": 0,
"city": "string",
"group_id": 0,
"postcode": "string",
"country_id": "string",
"telephone": "string",
"extension_attributes": {}
},
"password": "string"
}
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
Become seller
Endpoint: /V1/seller/becomeSeller
Method:
POST
Params:
{
"data": {
"shop_url": "string",
"contact_number": "string",
"company": "string",
"address": "string",
"region": "string",
"region_id": 0,
"city": "string",
"group_id": 0,
"postcode": "string",
"country_id": "string",
"telephone": "string",
"extension_attributes": {}
}
}
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
Get List Seller
Endpoint: /V1/seller/search
Method:
GET
Params:
Response Data:
{
"items": [
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"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
}
Get Seller By Url
Endpoint: /V1/seller/:sellerUrl
Method:
GET
Params:
sellerUrl
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
API seller review and rating
Get list review by URL
Endpoint: /V1/seller/:sellerUrl/reviews
Method:
GET
Params:
sellerUrl
Response Data:
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
}
Get List Rating by URL
Endpoint: /V1/seller/:sellerUrl/ratings
Method:
GET
Params:
sellerUrl
Response Data:
{
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
}
Get Summary Rating
Endpoint: /V1/seller/:sellerUrl/summaryRatings
Method:
GET
Params:
sellerUrl
Response Data:
{
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
}
Get Rating by Id
Endpoint: /V1/seller/ratings/:ratingId
Method:
GET
Params:
ratingId
Response Data:
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "string"
}
Update Rating
Endpoint: /V1/seller/ratings/:ratingId
Method:
PUT
Params:
ratingId
{ "type": "string" }
Response Data:
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "string"
}
Save Rating
Endpoint: /V1/seller/:sellerUrl/ratings
Method:
POST
Params:
sellerUrl
{ "rating": { "rate1": 0, "rate2": 0, "rate3": 0, "title": "string", "detail": "string", "nickname": "string", "email": "string", "like_about": "string", "not_like_about": "string", "is_recommended": true } }
Response Data:
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "string"
}
Get Seller By product Sku
Endpoint: /V1/seller/getSellerInfoBySku/:sku
Method:
GET
Params:
sku
storeId
Response Data:
{
"id": 0,
"sale": "string",
"commission_id": 0,
"page_layout": "string",
"status": 0,
"verify_status": 0,
"position": 0,
"twitter_id": "string",
"facebook_id": "string",
"gplus_id": "string",
"youtube_id": "string",
"vimeo_id": "string",
"instagram_id": "string",
"pinterest_id": "string",
"linkedin_id": "string",
"tw_active": "string",
"fb_active": "string",
"gplus_active": "string",
"vimeo_active": "string",
"instagram_active": "string",
"pinterest_active": "string",
"linkedin_active": "string",
"banner_pic": "string",
"shop_url": "string",
"logo_pic": "string",
"store_id": "string",
"seller_id": 0,
"contact_number": "string",
"customer_id": "string",
"name": "string",
"email": "string",
"shop_title": "string",
"company_locality": "string",
"company": "string",
"company_description": "string",
"return_policy": "string",
"shipping_policy": "string",
"address": "string",
"country": "string",
"image": "string",
"thumbnail": "string",
"region": "string",
"region_id": "string",
"city": "string",
"group": "string",
"url": "string",
"group_id": 0,
"product_count": 0,
"postcode": "string",
"country_id": "string",
"company_url": "string",
"message": "string",
"url_key": "string",
"meta_keyword": "string",
"meta_description": "string",
"street": "string",
"duration_of_vendor": "string",
"telephone": "string",
"total_sold": 0,
"is_searchable": 0,
"attribute_set_id": 0,
"latitude": 0,
"longitude": 0,
"opening_hours": "string",
"special_opening_hours": "string",
"taxvat": "string",
"seller_rates": {
"items": [
{
"rating_id": 0,
"seller_id": 0,
"customer_id": 0,
"rate1": 0,
"rate2": 0,
"rate3": 0,
"rating": 0,
"status": "string",
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "string",
"verified_buyer": 0,
"is_recommended": true,
"answer": "string",
"admin_note": "string",
"like_about": "string",
"not_like_about": "string",
"guest_email": "string",
"email": "string",
"plus_review": 0,
"minus_review": 0,
"report_abuse": 0,
"updated_at": "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
},
"seller_reviews": {
"items": [
{
"reviewseller_id": 0,
"type": 0,
"seller_id": 0,
"customer_id": 0,
"review_id": 0,
"product_id": 0,
"order_id": 0,
"is_public": 0,
"rating": 0,
"status": 0,
"title": "string",
"detail": "string",
"nickname": "string",
"created_at": "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
},
"products": {
"items": [
{
"id": 0,
"entity_id": 0,
"qty": 0,
"type_id": 0,
"sku": "string",
"has_options": "string",
"required_options": "string",
"created_at": "string",
"updated_at": "string",
"seller_id": "string",
"approval": "string",
"name": "string",
"price": 0,
"attribute_set_id": 0,
"product_id": 0,
"is_in_stock": 0
}
],
"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
},
"total_reviews": 0,
"total_products": 0,
"summary_rates": {
"total_count": 0,
"count": 0,
"total_rate": 0,
"average": 0,
"per_rate": 0,
"rate_one": 0,
"rate_two": 0,
"rate_three": 0,
"rate_four": 0,
"rate_five": 0,
"extension_attributes": {}
},
"total_sales": 0,
"vacation": {
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
},
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
API Seller Vacation
Endpoint: /V1/seller/:sellerUrl/vacation
Method:
GET
Params:
sellerUrl
Response Data:
{
"seller_id": "string",
"created_at": "string",
"updated_at": "string",
"vacation_id": "string",
"status": "string",
"vacation_message": "string",
"from_date": "string",
"to_date": "string",
"text_add_cart": "string"
}
Customer Manage Message API
Send Message
Endpoint: /V1/me/sendmessage/:sellerUrl
Method:
POST
Params:
sellerUrl
{ "subject": "string", "content": "string" }
Response Data:
{
"message_id": 0,
"description": "string",
"subject": "string",
"sender_email": "string",
"sender_name": "string",
"created_at": "string",
"status": 0,
"is_read": 0,
"sender_id": "string",
"owner_id": 0,
"receiver_id": 0,
"seller_send": 0
}
Get My List Message
Endpoint: /V1/me/sellermessages
Method:
GET
Params:
Response Data:
{
"items": [
{
"message_id": 0,
"description": "string",
"subject": "string",
"sender_email": "string",
"sender_name": "string",
"created_at": "string",
"status": 0,
"is_read": 0,
"sender_id": "string",
"owner_id": 0,
"receiver_id": 0,
"seller_send": 0
}
],
"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
}
Get My Details Message
Endpoint: /V1/me/sellermessages/:messageId
Method:
GET
Params:
messageId
Response Data:
{
"items": [
{
"message_id": 0,
"description": "string",
"subject": "string",
"sender_email": "string",
"sender_name": "string",
"created_at": "string",
"status": 0,
"is_read": 0,
"sender_id": "string",
"owner_id": 0,
"receiver_id": 0,
"seller_send": 0
}
],
"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
}
Reply Message
Endpoint: /V1/me/sellermessages/:messageId
Method:
POST
Params:
messageId
{ "message": "string" }
Response Data:
{
"detail_id": 0,
"message_id": 0,
"seller_send": "string",
"sender_id": 0,
"sender_email": "string",
"sender_name": "string",
"receiver_id": 0,
"receiver_email": "string",
"receiver_name": "string",
"content": "string",
"is_read": 0,
"created_at": "string",
"message_admin": 0
}
Manage Withdrawl request
Old REST API document you can find at here: https://documenter.getpostman.com/view/8533923/TVCcWozz
Last updated
Was this helpful?