Seller API Calls : needs Seller authorization

=============================================

1. Api to get allowed seller category list

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/allowedproductcategory

Resepone:

[
{
"category_ids": [
"10",
"33"
]
}
]

2. Get self products details

API Resource: rest/V1/mpapi/sellers/me/product
Method: GET
Response:
[
{
"status": int,
"total_count": int,
"items": [
{
"name": string,
"type": string,
"sku": string,
"mageproduct_id": string
}
]
}
]

3. Get self order details

API Resource: rest/V1/mpapi/sellers/me/order
Method: GET
Response:
{
"items": [
{
"entity_id": string,
"mageproduct_id": string,
"order_id": string,
"order_item_id": string,
"parent_item_id": string,
"magerealorder_id": string,
"magequantity": string,
"seller_id": string,
"trans_id": string,
"cpprostatus": string,
"paid_status": string,
"magebuyer_id": string,
"magepro_name": string,
"magepro_price": string,
 "total_amount": string,
"total_tax": string,
"total_commission": string,
"actual_seller_amount": string,
"created_at": string,
"updated_at": string,
"is_shipping": string,
"is_coupon": string,landing
"is_paid": string,
"commission_rate": string,
"currency_rate": string,
"applied_coupon_amount": string,
"is_withdrawal_requested": string
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
}
]
},
"total_count": int
}

4. Get self order sales details

API Resource: rest/V1/mpapi/sellers/me/order/sales
Method: GET
Response:
{
"items": [
{
"entity_id": string,
"order_id": string,
"product_ids": string,
"seller_id": string,
"shipment_id": string,
"invoice_id": string,
"creditmemo_id": string,
"is_canceled": string,
"shipping_charges": string,
"carrier_name": string,
"tracking_number": string,
"created_at": string,
"updated_at": string,
"tax_to_seller": string,
"total_tax": string,
"coupon_amount": string,
"refunded_coupon_amount": string,
"refunded_shipping_charges": string,
"seller_pending_notification": string,
"order_status": string
}
 ],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
}
]
},
"total_count": int
}

5. Create invoice for seller order

API Resource: rest/V1/mpapi/sellers/me/order/invoice
Method: POST
POST Data:
{
"orderId": 111,
"args": {
"comment_text": "testingcomment",
"send_email": 1,
"comment_customer_notify": 1,
"is_visible_on_front": 1,
"items": [{ #optional (if items are not passed then invoice will create
for all items)
"qty": 1,
"item_id": 124
}]
}
}

Response:
Case 1 : When Sucess
{
[
{
"invoice_id": string,
"message": string,
"status": boolean
}
]
}

Case 2 : When already created invoice

{
[
{
"message": string,
"status": boolean
}
]
}

6. Get invoice data

API Resource: rest/V1/mpapi/sellers/me/order/:orderId/invoice/:invoiceId
Method: GET
Response:
Case 1 : When invoiceId or OrderId is missing
{
"message": string,
"trace": string
}

Case 2 : When Success

{
[
{
"mainHeading": string,
"sendmailAction": string,
"sendmailWarning": string,
"subHeading": string,
"orderData": {
"title": string,
"label": string,
"statusLabel": string,
"statusValue": string,
"dateLabel": string,
"dateValue": string
},
"buyerData": {
"title": string,
"nameLabel": string,
"nameValue": string,
"emailLabel": string,
"emailValue": string
},
"shippingAddressData": {
"title": string,
"address": [
{
"name": string,
"street": string,
"state": string,
"country": string,
"telephone": string
}
]
},
"shippingMethodData": {
"title": string,
"method": string
},
"billingAddressData": {
"title": string,
"address": [
{
"name": string,
"street": string,
"state": string,
"country": string,
"telephone": string
}
]
 },
"paymentMethodData": {
"title": string,
"method": string
},
"items": [
{
"productName": string,
"price": string,
"qty": {
"Ordered": int,
"Invoiced": int,
"Shipped": int,
"Canceled": int,
"Refunded": int
},
"subTotal": string,
"adminComission": string,
"vendorTotal": string
}
],
"subtotal": {
"title": string,
"value": string
},
"shipping": {
"title": string,
"value": string
},
"tax": {
"title": string,
"value": string
},
"totalOrderedAmount": {
"title": string,
"value": string
},
"totalVendorAmount": {
"title": string,
"value": string
},
"totalAdminComission": {
"title": string,
"value": string
},
"status": int
}
]
}

7. Cancel the order

API Resource:rest/V1/mpapi/sellers/me/order/cancel
Method:POST
Params:
orderId: int
Response:
Case 1 : When seller has not permission
[
{
 "message": string,
"status": int
}
]

Case 2 : When success

[
{
"message": string,
"status": int
}
]

8. Create credit memo for seller order

API Resource: rest/V1/mpapi/sellers/me/order/creditmemo
Method: POST
Params: (Mandatory)
{
"invoiceId": int,
"orderId": int,
"creditMemo": {
"items": [
{
"qty": int,
"back_to_stock": bool,
"item_id": int
}
],
"do_offline": bool
}
}

**Params:(Can be add other parameters)

{
"invoiceId": int,
"orderId": int,
"creditMemo": {
"items": [
{
"qty": int,
"back_to_stock": bool,
"item_id": bool
}
],
"shipping_amount": int,
"adjustment_negative": int,
"adjustment_positive": int,
"do_offline": bool,
"comment_text": string,
"comment_customer_notify": bool,
"is_visible_on_front": bool,
"send_email": bool
}
}

Response:
Case 1 : When OrderId and InvoiceId are not matched
[
{
 "status": int,
"message": string
}
]
Case 2 : When OrderId match but InvoiceId mismatch
[
{
"status": int,
"message": string
}
]
Case 3 : When success
[
{
"id": string,
"status": int,
"message": string
}
]

9. Get the Credit memo for seller

API Resource: rest/V1/mpapi/sellers/me/order/:orderId/creditmemo/:creditmemoId
Method: GET
Response:
[
{
"sendmailAction": "Send Email To Customer",
"sendmailWarning": "Are you sure you want to send order email to
customer?",
"mainHeading": "Credit Memo Information",
"subHeading": "Credit Memo #000000004 - Refunded | 2024-12-26 05:11:34",
"orderData": {
"title": "Order Information",
"label": "Order # 000000003",
"statusLabel": "Order Status",
"statusValue": "Complete",
"dateLabel": "Order Date",
"dateValue": "2024-12-24 09:53:29"
},
"buyerData": {
"title": "Buyer Information",
"nameLabel": "Customer Name",
"nameValue": "John Smith",
"emailLabel": "Email",
"emailValue": "raginidwivedi.mg368@webkul.in"
},
"shippingAddressData": {
"title": "Shipping Address",
"address": {
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"street": [
"street"
],
"city": "merut",
"region": null,
"postcode": "272155",
"country_code": "TR",
 "region_id": "0",
"telephone": "08976567890"
}
},
"shippingMethodData": {
"title": "Shipping Information",
"method": "Flat Rate - Fixed"
},
"billingAddressData": {
"title": "Billing Address",
"address": {
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"street": [
"street"
],
"city": "merut",
"region_id": null,
"region": null,
"postcode": "272155",
"country_code": "TR",
"telephone": "08976567890"
}
},
"paymentMethodData": {
"title": "Payment Method",
"method": "Check / Money order"
},
"items": [
{
"productName": "product1",
"priceFormatted": "$700.00",
"price": 700,
"qty": {
"Ordered": 5,
"Invoiced": 5,
"Shipped": 5,
"Canceled": 0,
"Refunded": 5
},
"subTotalFormatted": "$3,500.00",
"subTotal": 3500,
"adminComissionFormatted": "$0.00",
"adminComission": "0.0000",
"vendorTotalFormatted": "$0.00",
"vendorTotal": "0.0000"
}
],
"subtotal": {
"title": "Subtotal",
"valueFormatted": "$3,500.00",
"value": 3500
},
"shipping": {
"title": "Shipping & Handling",
"valueFormatted": "$0.00",
"value": 0
},
 "tax": {
"title": "Total Tax",
"valueFormatted": "$0.00",
"value": 0
},
"totalOrderedAmount": {
"title": "Total Ordered Amount",
"valueFormatted": "$3,500.00",
"value": 3500
},
"totalVendorAmount": {
"title": "Total Vendor Amount",
"valueFormatted": "$0.00",
"value": 0
},
"totalAdminComission": {
"title": "Total Admin Commission",
"valueFormatted": "$0.00",
"value": 0
},
"status": 1
}
]
10. Request to create shipment
API Resource: rest/V1/mpapi/sellers/me/order/ship
Method: POST
Params:
{
"trackingId": string,
"carrier": string,
"orderId":string
}
Response:
[
{
"status": int,
"message": string
}
]

11. Get shipment details

API Resource: rest/V1/mpapi/sellers/me/order/:orderId/ship/:shipmentId
Method: GET
Response:
Case 1 : When success
[
{
"mainHeading": "View Shipment Details",
"sendmailAction": "Send Email To Customer",
"sendmailWarning": "Are you sure you want to send shipment email to
customer?",
"subHeading": "Shipment #000000002 | 2024-12-24 10:09:33",
"orderData": {
"title": "Order Information",
"label": "Order # 000000003",
"statusLabel": "Order Status",
"statusValue": "Complete",
"dateLabel": "Order Date",
"dateValue": "2024-12-24 09:53:29"
},
"buyerData": {
"title": "Buyer Information",
"nameLabel": "Customer Name",
"nameValue": "John Smith",
"emailLabel": "Email",
"emailValue": "raginidwivedi.mg368@webkul.in"
},
"shippingAddressData": {
"title": "Shipping Address",
"address": {
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"street": [
"street"
],
"city": "merut",
"region": null,
"postcode": "272155",
"country_code": "TR",
"region_id": "0",
"telephone": "08976567890"
}
},
"shippingMethodData": {
"title": "Shipping Information",
"method": "Flat Rate - Fixed"
},
"billingAddressData": {
"title": "Billing Address",
"address": {
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"street": [
"street"
],
"city": "merut",
"region_id": null,
"region": null,
"postcode": "272155",
"country_code": "TR",
"telephone": "08976567890"
}
},
"paymentMethodData": {
"title": "Payment Method",
"method": "Check / Money order"
},
"shippingCarriers": [],
"items": [
{
"productName": "product1",
"sku": "product1",
"qty": 5
}
],
"status": 1
 }
]
Case 2 : When missing orderId or shipmentId
{
"message": string,
"trace": string
}

12. Ask questions to admin

API Resource:rest/V1/mpapi/sellers/me/mailtoadmin
Method:POST
Params:
{
"subject":string,
"query": string
}
Response:
[
{
"message": string,
"status": int
}
]

13. Mail To Seller (Contact Seller)

API Resource: rest/V1/mpapi/sellers/me/mailtoseller
Method: POST
Params:
{
"subject":string,
"query":string,
"productId":string
}
Response:
Case 1 :When Success
[
{
"status": int,
"message": string
}
]
Case 2 : When SellerId mismatch
[
{
"status": int,
"message": string
}
]

14. Request to become partner

API Resource: rest/V1/mpapi/sellers/me/becomepartner
Method: POST
Params:
{
"shopUrl":string,
"isSeller":string
}
Response:
Case 1 : When sellerId is exist
 [
{
"status": int,
"message": string
}
]
Case 2 : When isSeller is not true or other value
[
{
"status": int,
"message": string
}
]
Case 3 : When Success
[
{
"message": string,
"status": int
}
]

15. Request to create seller account (No token needed)

API Resource: rest/V1/mpapi/sellers/create
Method: POST
Params:
{
"customer": {
"email": string,
"firstname": string,
"lastname": string,
"storeId": string,
"websiteId": string
},
"is_seller": string,
"profileurl": string,
"password": string,
"registered": string ("0" => for New , "1" => already account, now became
seller)
}
Response:
Case 1 : When sucess new account
[
{
"status": int,
"message": string,
"id": string,
"group_id": string,
"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": string,
"store_id": string,
"taxvat": string,
"website_id": string,
"disable_auto_group_change": string,
"is_seller": bool,
"profileurl": string
}
]
Case 2 : When already registered as seller and match shop name
[
{
"status": int,
"message": string
}
]
Case 3 : When already registered as seller
[
{
"status": int,
"message": string
}
]
Case 4 : When params missing
[
{
"status": int,
"message": string
}
]

16. Upload Product image (Seller Token Required)

API Resource: rest/V1/mpapi/uploadimage
Method: POST
Params:
{
image: select an image by clicking on select file button
}
Response:
{
"name": string,
"type": string,
"error": bool,
"size": int,
"file": string,
"url": string,
"message": string,
"success": bool
}

17. Request to create seller product

API Resource: rest/V1/mpapi/sellers/me/addproduct
Method: POST
Params:
Case 1 : Product Params (With Images)
{
"type": string,
"set": string,
"product": {
"category_ids": [ string ],
"name": string,
"description": string,
"short_description": string,
"sku": string,
"price": string,
"special_price": string,
"special_from_date": string,
"special_to_date": string,
"stock_data": {
"manage_stock": string,
"use_config_manage_stock": string
},
"quantity_and_stock_status": {
"qty": string,
"is_in_stock": string
},
"visibility": string,
"tax_class_id": string,
"product_has_weight": string,
"weight": string,
"url_key": string,
"meta_title": string,
"meta_keyword": string,
"meta_description": string,
"mp_product_cart_limit": string,
"media_gallery": {
"images": {
string: {
"position": string,
"media_type": string,
"video_provider": string,
"file": string,
"value_id": string,
"label": string,
"disabled": string,
"removed": string,
"video_url": string,
"video_title": string,
"video_description": string,
"video_metadata": string,
"role": string
}
},
"image": string,
"small_image": string,
"thumbnail": string,
"links_title": string,
"links_purchased_separately": string,
"samples_title": string,
"ts_dimensions_height": string,
"ts_dimensions_width": string,
"ts_dimensions_length": string,
"attribute_set_id": string
},
"affect_configurable_product_attributes": string,
"new-variations-attribute-set-id": string
}
}

Case 2 : Product Params (Mandatory Fields)

{
"type": string,
"set": string,
"product": {
"category_ids": [
string
],
"name": string,
"sku": string,
"price": string,
"stock_data": {
"manage_stock": string,
"use_config_manage_stock": string
},
"quantity_and_stock_status": {
"qty": string,
"is_in_stock": string
},
"visibility": string,
"tax_class_id": string,
"product_has_weight": string,
"weight": string,
"mp_product_cart_limit": string,
"media_gallery": {
"images": {
},
"attribute_set_id": string
},
"affect_configurable_product_attributes": string,
"new-variations-attribute-set-id": string
}
}

Case 3 : Configurable Product Params

{
"type": "configurable",
"set": "4",
"product": {
"category_ids": [ "3" ],
"name": "testport",
"description": "testport",
"short_description": "",
"sku": "testport",
"price": "14",
"special_price": "",
"special_from_date": "",
"special_to_date": "",
"stock_data": {
"manage_stock": "1",
"use_config_manage_stock": "1"
},
"quantity_and_stock_status": {
"is_in_stock": "1"
},
"visibility": "4",
"tax_class_id": "0",
 "product_has_weight": "1",
"weight": "11",
"meta_title": "",
"meta_keyword": "",
"meta_description": "",
"mp_product_cart_limit": "1",
"image": "",
"small_image": "",
"thumbnail": "",
"configurable_attributes_data": {
"93": {
"attribute_id": "93",
"code": "color",
"label": "Color",
"position": "0",
"values": {
"51": {
"include": "1",
"value_index": "51"
}
}
}
},
"product_length": "",
"product_width": "",
"product_height": "",
"fragile": "0"
},
"attributes": [
"93"
],
"variations-matrix": {
"51": {
"image": "",
"name": "testport-Black",
"configurable_attribute": "{\"color\":\"51\"}",
"status": "1",
"sku": "testport-Black",
"price": "11.11",
"quantity_and_stock_status": {
"qty": ""
},
"weight": "11.11"
}
},
"associated_product_ids": [
""
],
"affect_configurable_product_attributes": "1"
}

Response:
[
{
"error": 0,
"product_id": "2155",
"message": "Product Added Successfully"
}
]
Case 4. Virtual Product:

{
"type": "virtual",
"set": "4",
"product": {
"category_ids": [
"3"
],
"name": "v3",
"entity_id": 1229,
"description": "testport6",
"short_description": "",
"sku": "v3",
"price": "14",
"special_price": "",
"special_from_date": "",
"special_to_date": "",
"stock_data": {
"manage_stock": "1",
"use_config_manage_stock": "1"
},
"quantity_and_stock_status": {
"is_in_stock": "1",
"qty": 200
},
"qty": 200,
"visibility": "4",
"tax_class_id": "0",
"meta_title": "",
"meta_keyword": "",
"meta_description": "",
"mp_product_cart_limit": "1",
"image": "",
"small_image": "",
"thumbnail": ""
}
}

Response:

[
{
"error": 0,
"product_id": 1229,
"message": "Product Added Successfully",
"row_id": "1229"
}
]

Case 5: Downloadable Product:

# Use uploaddownloadableimage api upload image used in Downloadable product

{
"type": "downloadable",
"set": 4,
"product": {
"category_ids": [
 3
],
"name": "restdownloadable6",
"description": "duplicaterest2",
"short_description": "duplicaterest3",
"price": 100,
"sku": "restdownloadable6",
"special_price": 80,
"special_from_date": "",
"links_title":"Testing link title",
"samples_title":"Testing samples title",
"special_to_date": "",
"website_ids": [
1
],
"stock_data": {
"manage_stock": 1,
"use_config_manage_stock": 1
},
"quantity_and_stock_status": {
"qty": 20,
"is_in_stock": 1
},
"visibility": 3,
"tax_class_id": 1,
"meta_title": "",
"meta_keyword": "",
"meta_description": "",
"mp_product_cart_limit": "",
"affect_configurable_product_attributes": 1,
"new-variations-attribute-set-id": 1,
"links_purchased_separately": 1
},
"is_downloadable": true,
"downloadable": {
"link": [
{
"title": "test1",
"price": 20.34,
"link_id": 0,
"type": "file",
"link_url": "",
"file": "[{\"file\":\"\/s\/c\/screenshot_from_2025-06-12_16-30-
09_1.png.tmp\",\"name\":\"screenshot_from_2025-06-12_16-30-
09_1.png.tmp\",\"size\":215118,\"status\":\"new\"}]",
"is_shareable": 1,
"is_unlimited": 1,
"sample": {
"file": "[{\"file\":\"\/s\/c\/screenshot_from_2025-06-12_16-30-
09_1.png.tmp\",\"name\":\"screenshot_from_2025-06-12_16-30-
09_1.png.tmp\",\"size\":213222,\"status\":\"new\"}]",
"url": ""
}
}
],
"sample": [
{
"sort_order": 1,
"is_delete": 0,
 "sample_id": 0,
"title": "sdvds",
"type": "file",
"file": "[{\"file\":\"\/s\/c\/screenshot_from_2025-06-12_16-30-
09.png.tmp\",\"name\":\"screenshot_from_2025-06-12_16-30-
09.png.tmp\",\"size\":213222,\"status\":\"new\"}]",
"sample_url": ""
}
]
}
}

Response:

[
{
"error": 0,
"product_id": 1230,
"message": "Product Added Successfully",
"row_id": "1230"
}
]

Case 6: For save and duplicate product,need to pass one extra paramater "back":
"duplicate" in add product api

{
"type": "simple",
"back": "duplicate",
"set": 4,
"product": {
"category_ids": [
3
],
"name": "duplicaterest1",
"description": "duplicaterest1",
"short_description": "duplicaterest1",
"price": 100,
"sku": "duplicaterest1",
"special_price": 80,
"special_from_date": "",
"special_to_date": "",
"website_ids": [
1
],
"stock_data": {
"manage_stock": 1,
"use_config_manage_stock": 1
},
"quantity_and_stock_status": {
"qty": 20,
"is_in_stock": 1
},
"visibility": 3,
"tax_class_id": 1,
"product_has_weight": 1,
"weight": 2,
"meta_title": "",
"meta_keyword": "",
 "meta_description": "",
"mp_product_cart_limit": "",
"affect_configurable_product_attributes": 1,
"new-variations-attribute-set-id": 1
}
}

Response:

[
{
"error": 0,
"product_id": "1250",
"message": "Product Added and duplicated Successfully",
"row_id": "1249"
}
]

18. Save Seller Profile

API Resource: rest/V1/mpapi/sellers/me/saveprofile
Method: POST
Params:
Params:
{
"company_locality": string,
"company_banner": {
"file_name": string
},
"company_logo": {
"file_name": string
},
"fulfil_image": {
"file_name": string
},
"privacy_policy": string,
"analytic_id": string,
"facebook_id": string,
"fb_active": string,
"analytic_id": string,
"instagram_active": string,
"instagram_id": string,
"meta_description": string,
"meta_keyword": string,
"payment_source": string,
"pinterest_active": string,
"pinterest_id": string,
"privacy_policy": string,
"return_policy": string,
"shipping_policy": string,
"shop_title": string,
"taxvat": string,
"tw_active":string,
"twitter_id":string,
"vimeo_active": string,
"vimeo_id": string,
"youtube_active": string,
"youtube_id":string,
"moleskine_active": string,
"moleskine_id": string,
 "tiktok_active": string,
"tiktok_id": string,
"low_stock_quantity":int
}

Response:
[
{
"status": boolean,
"message": string
}
]

19. Delete Seller Product

API Resource: rest/V1/mpapi/sellers/me/deleteProduct
Method: POST
Params:
{
productIds: array (for example-[1251,1249])
}

Response:
[
{
"message": string,
"status": bool
}
]

20. Report Seller Product

API Resource: rest/V1/mpapi/report/product/:productId
Method: POST
Params:
{
reason: string
}

Response:
[
{
"message": string,
"status": bool
}
]

21. Report Seller

API Resource: rest/V1/mpapi/report/seller/:sellerId
Method: POST
Params:
{
reason: string
}

Response:
Case 1. When Successful
[
{
"flag_id": int,
 "status": bool,
"message": string
}
]
Case 2. When failed
[
{
"message": string,
"status": bool
}
]

Admin Api Calls : needs admin authorization

===========================================
1. Get all sellers data
API Resource:rest/V1/mpapi/admin/sellers
Method: GET
Params:
{
"searchCriteria":string
}
Response:
Case 1 : When search criteria blank, then show all seller list
{
"items": [
{
"entity_id": string,
"is_seller": string,
"seller_id": string,
"payment_source": string,
"twitter_id": string,
"facebook_id": string,
"gplus_id": string,
"youtube_id": string,
"vimeo_id": string,
"instagram_id": string,
"pinterest_id": string,
"moleskine_id": string,
"tw_active": string,
"fb_active": string,
"gplus_active": string,
"youtube_active": string,
"vimeo_active": string,
"instagram_active": string,
"pinterest_active": string,
"moleskine_active": string,
"others_info": string,
"banner_pic": string,
"shop_url": string,
"shop_title": string,
"logo_pic": string,
"company_locality": string,
"country_pic": string,
"company_description": string,
"meta_keyword": string,
"meta_description": string,
"background_width": string,
"store_id": string,
 "contact_number": string,
"return_policy": string,
"shipping_policy": string,
"created_at": string,
"updated_at": string,
"admin_notification": string,
"privacy_policy": string,
"allowed_categories": string,
"allowed_attributeset_ids": string
}
],
"search_criteria": {
"filter_groups": array
},
"total_count": int
}

Case 2 : When search criteria mentioned, and matched then show filtered seller
{
"items": [
{
"entity_id": string,
"is_seller": string,
"seller_id": string,
"payment_source": string,
"twitter_id": string,
"facebook_id": string,
"gplus_id": string,
"youtube_id": string,
"vimeo_id": string,
"instagram_id": string,
"pinterest_id": string,
"moleskine_id": string,
"tw_active": string,
"fb_active": string,
"gplus_active": string,
"youtube_active": string,
"vimeo_active": string,
"instagram_active": string,
"pinterest_active": string,
"moleskine_active": string,
"others_info": string,
"banner_pic": string,
"shop_url": string,
"shop_title": string,
"logo_pic": string,
"company_locality": string,
"country_pic": string,
"company_description": string,
"meta_keyword": string,
"meta_description": string,
"background_width": string,
"store_id": string,
"contact_number": string,
"return_policy": string,
"shipping_policy": string,
"created_at": string,
"updated_at": string,
"admin_notification": string,
 "privacy_policy": string,
"allowed_categories": string,
"allowed_attributeset_ids": string
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
}
]
},
"total_count": int
}

Case 3 : When search criteria mentioned and not matched

{
"items": array,
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
}
]
},
"total_count": int
}

2. Get seller by id
API Resource:rest/V1/mpapi/admin/sellers/:id
Method:GET
Response:
[
{
"entity_id": string,
"is_seller": string,
"seller_id": string,
"payment_source": string,
"twitter_id": string,
"facebook_id": string,
"gplus_id": string,
"youtube_id": string,
"vimeo_id": string,
"instagram_id": string,
"pinterest_id": string,
"moleskine_id": string,
"tw_active": string,
 "fb_active": string,
"gplus_active": string,
"youtube_active": string,
"vimeo_active": string,
"instagram_active": string,
"pinterest_active": string,
"moleskine_active": string,
"others_info": string,
"banner_pic": string,
"shop_url": string,
"shop_title": string,
"logo_pic": string,
"company_locality": string,
"country_pic": string,
"company_description": string,
"meta_keyword": string,
"meta_description": string,
"background_width": string,
"store_id": string,
"contact_number": string,
"return_policy": string,
"shipping_policy": string,
"created_at": string,
"updated_at": string,
"admin_notification": string,
"privacy_policy": string,
"allowed_categories": string,
"allowed_attributeset_ids": string
}
]

3. get sellers wise products

API Resource:rest/V1/mpapi/admin/sellers/:id/product
Method:GET
Response:
{
"items": [
{
"id": int,
"sku": string,
"name": string,
"attribute_set_id": int,
"price": int,
"status": int,
"visibility": int,
"type_id": string,
"created_at": string,
"updated_at": string,
"weight": int,
"extension_attributes": {
"website_ids": [
int
],
"category_links": [
{
"position": int,
"category_id": string
},
{
 "position": int,
"category_id": string
}
]
},
"product_links": array,
"options": array,
"media_gallery_entries": array,
"tier_prices": array,
"custom_attributes": [
{
"attribute_code": string,
"value": string
}
]
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
}
]
},
"total_count": int
}

4. Get seller wise orders

API Resource:rest/V1/mpapi/admin/sellers/:id/order
Method:GET
Params:(optional)
{
searchCriteria[filter_groups][0][filters][0][field]:int
searchCriteria[filter_groups][0][filters][0][value]:int
searchCriteria[filter_groups][0][filters][0][condition_type]:int
}
Response:
{
Case 1 : When Search Criteria applied, filtered data
"items": [
{
"entity_id": string,
"mageproduct_id": string,
"order_id": string,
"order_item_id": string,
"parent_item_id": string,
"magerealorder_id": string,
"magequantity": string,
"seller_id": string,
"trans_id": string,
"cpprostatus": string,
"paid_status": string,
"magebuyer_id": string,
 "magepro_name": string,
"magepro_price": string,
"total_amount": string,
"total_tax": string,
"total_commission": string,
"actual_seller_amount": string,
"created_at": string,
"updated_at": string,
"is_shipping": string,
"is_coupon": string,
"is_paid": string,
"commission_rate": string,
"currency_rate": string,
"applied_coupon_amount": string,
"is_withdrawal_requested": string
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
},
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
}
],
"page_size": int
},
"total_count": int
}

Case 2 : When Search Criteria not applied, then show all order of that seller
{
"items": [
{
"entity_id": string,
"mageproduct_id": string,
"order_id": string,
"order_item_id": string,
"parent_item_id": string,
"magerealorder_id": string,
"magequantity": string,
"seller_id": string,
"trans_id": string,
"cpprostatus": string,
"paid_status": string,
"magebuyer_id": string,
 "magepro_name": string,
"magepro_price": string,
"total_amount": string,
"total_tax": string,
"total_commission": string,
"actual_seller_amount": string,
"created_at": string,
"updated_at": string,
"is_shipping": string,
"is_coupon": string,
"is_paid": string,
"commission_rate": string,
"currency_rate": string,
"applied_coupon_amount": string,
"is_withdrawal_requested": string
},
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
}
]
},
"total_count": int
}

5. Get seller wise sales details

API Resource:rest/V1/mpapi/admin/sellers/:id/order/sales
Method:GET
Params:(optional)
{
searchCriteria[filter_groups][0][filters][0][field]:int
searchCriteria[filter_groups][0][filters][0][value]:int
searchCriteria[filter_groups][0][filters][0][condition_type]:int
}
Response:
Case 1 : When Search Criteria applied, filtered data
{
"items": [
{
"entity_id": string,
"order_id": string,
"product_ids": string,
"seller_id": string,
"shipment_id": string,
"invoice_id": string,
"creditmemo_id": string,
"is_canceled": string,
"shipping_charges": string,
"carrier_name": string,
"tracking_number": string,
"created_at": string,
 "updated_at": string,
"tax_to_seller": string,
"total_tax": string,
"coupon_amount": string,
"refunded_coupon_amount": string,
"refunded_shipping_charges": string,
"seller_pending_notification": string,
"order_status": string
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
}
]
},
"total_count": int
}

Case 2 : When Search Criteria not applied, then show all of that seller
{
"items": [
{
"entity_id": string,
"order_id": string,
"product_ids": string,
"seller_id": string,
"shipment_id": string,
"invoice_id": string,
"creditmemo_id": string,
"is_canceled": string,
"shipping_charges": string,
"carrier_name": string,
"tracking_number": string,
"created_at": string,
"updated_at": string,
"tax_to_seller": string,
"total_tax": string,
"coupon_amount": "string,
"refunded_coupon_amount": string,
"refunded_shipping_charges": string,
"seller_pending_notification": string,
"order_status": string
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
 "condition_type": string
}
]
}
]
},
"total_count": int
}

6. Pay seller his amount after deducting commission

API Resource: rest/V1/mpapi/admin/sellers/paytoseller
Method: POST
Params:
{
sellerPayReason : string
entityId : int
sellerId : int
}
Response:
Case 1 : When already paid to seller
[
{
"message": string,
"status": int
}
]
Case 2 : When paid to seller successfully
[
{
"message": string,
"status": int
}
]

7. Assign product(s) to seller

API Resource:rest/V1/mpapi/admin/sellers/assign
Method:POST
Params:
{
sellerId : int
productIds : int
}
Response:
Case 1 : When assign successfully
[
{
"message": array,
"status": int
}
]
Case 2 : When assigned already to seller
[
{
"message": array,
"status": int
}
]
Case 3 : When seller not found
[
 {
"message": array,
"status": int
}
]
Case 4 : When Product not found
[
{
"message": array,
"status": int
}
]

8. Unassign product(s) from seller

API Resource:rest/V1/mpapi/admin/sellers/unassign
Method:POST
Params:
{
sellerId : int
productIds : int
}
Response:
Case 1 : When unassign successfully
[
{
"message": array,
"status": int
}
]
Case 2 : When already unassigned from seller
[
{
"message": array,
"status": int
}
]
Case 3 : When seller not found
[
{
"message": array,
"status": int
}
]
Case 4 : When Product not found
[
{
"message": array,
"status": int
}
]

9. Create a Seller flag reason

API Resource:rest/V1/mpapi/admin/seller/flagreason
Method:POST
Params:
{
reason : string
status : int
}
Response:
[
{
"message": string,
"status": int
}
]

10. Create a Product flag reason

API Resource:rest/V1/mpapi/admin/product/flagreason
Method:POST
Params:
{
reason : string
status : int
}
Response:
[
{
"message": string,
"status": int
}
]

Guest Api Calls : No needs authorization

========================================

1. Returns marketplace landing page details

API Resource:rest/V1/mpapi/marketplace
Method:GET
Response:
[
{
"icons": [
{
"image": string,
"label": string
}
],
"labels": [
{
"label": string
}
],
"aboutImage": string,
"sellers": [
{
"products": [
{
"id": string,
"name": string,
"type": string,
"thumbnail": string
}
],
"shopTitle": string,
"profileurl": string,
"sellerIcon": string,
 "sellerProductCount": int
}
]
}
]

2. Get all sellers list

API Resource:rest/V1/mpapi/sellers
Method:GET
Params:
{
searchCriteria:string
}
Response:
{
"items": [
{
"entity_id": string,
"is_seller": string,
"seller_id": string,
"payment_source": string,
"twitter_id": string,
"facebook_id": string,
"gplus_id": string,
"youtube_id": string,
"vimeo_id": string,
"instagram_id": string,
"pinterest_id": string,
"moleskine_id": string,
"tw_active": string,
"fb_active": string,
"gplus_active": string,
"youtube_active": string,
"vimeo_active": string,
"instagram_active": string,
"pinterest_active": string,
"moleskine_active": string,
"others_info": string,
"banner_pic": string,
"shop_url": string,
"shop_title": string,
"logo_pic": string,
"company_locality": string,
"country_pic": string,
"company_description": string,
"meta_keyword": string,
"meta_description": string,
"background_width": string,
"store_id": string,
"contact_number": string,
"return_policy": string,
"shipping_policy": string,
"created_at": string,
"updated_at": string,
"admin_notification": string,
"privacy_policy": string,
"allowed_categories": string,
"allowed_attributeset_ids": string
}
 ]
}

3. Make seller review

API Resource: rest/V1/mpapi/sellers/reviews
Method:POST
Post Data: (All Object keys)
{
"feedback" : {
"feed_price": string,
"feed_quality": string,
"feed_value" : string,
"feed_nickname" : string,
"feed_summary" : string,
"feed_review" : string,
"buyer_email" : string,
"buyer_id" : string
},
"seller_id" : string
}
Post Data: (**Mandatory Object keys)
{
"feedback" : {
"buyer_id" : string
},
"seller_id" : string
}

Response:
Case 1 : When Success
[
{
"review_id": string,
"message": string,
"status": int
}
]
Case 2 : When feedback object data missing
[
{
"status": int,
"message": string
}
]

4. Get seller reviews

API Resource: rest/V1/mpapi/sellers/:id/reviews
Method: GET
Response:
{
"items": [
{
"entity_id": string,
"seller_id": string,
"buyer_id": string,
"buyer_email": string,
"status": string,
"feed_price": string",
"feed_value": string,
 "feed_quality": "string,
"feed_nickname": string,
"feed_summary": string,
"feed_review": string,
"created_at": string,
"updated_at": string,
"seller_pending_notification": string,
"admin_notification": string
}
],
"total_count": int
}

5. Get review details by review id

API Resource:rest/V1/mpapi/sellers/:review_id/review
Method:GET
Response:
Case 1 : When Success
{
"items": [
{
"entity_id": string,
"seller_id": string,
"buyer_id": string,
"buyer_email": string,
"status": string,
"feed_price": string,
"feed_value": string,
"feed_quality": string,
"feed_nickname": string,
"feed_summary": string,
"feed_review": string,
"created_at": string,
"updated_at": string,
"seller_pending_notification": string,
"admin_notification": string
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
},
{
"filters": [
{
"field": "status",
"value": string,
"condition_type": string
}
]
}
]
 },
"total_count": 1
}

Case 2 : When review_id not match

{
"items": array,
"total_count": int
}

6. Get Seller Details By Product SKU

API Resource: rest/V1/mpapi/sellers/sellerbyproduct/:sku
Method: GET
Response:
Case 1 : When Success
[
{
"seller": {
"entity_id": string,
"is_seller": string,
"seller_id": string,
"payment_source": string,
"twitter_id": string,
"facebook_id": string,
"gplus_id": string,
"youtube_id": string,
"vimeo_id": string,
"instagram_id": string,
"pinterest_id": string,
"moleskine_id": string,
"tw_active": string,
"fb_active": string,
"gplus_active": string,
"youtube_active": string,
"vimeo_active": string,
"instagram_active": string,
"pinterest_active": string,
"moleskine_active": string,
"others_info": string,
"banner_pic": string,
"shop_url": string,
"shop_title": string,
"logo_pic": string,
"company_locality": string,
"country_pic": string,
"company_description": string,
"meta_keyword": string,
"meta_description": string,
"background_width": string,
"store_id": string,
"contact_number": string,
"return_policy": string,
"shipping_policy": string,
"created_at": string,
"updated_at": string,
"admin_notification": string,
"privacy_policy": string,
"allowed_categories": string,
"allowed_attributeset_ids": string
 },
"message": string
}
]

Case 2 : When product sku not match

[
{
"message": string,
"seller": string
}
]

7. Get Seller Dashboard Data

API Resource: rest/V1/mpapi/sellers/me/dashboard
Method: POST
Params:
dateFrom: string # "2024-08-19"
dateTo: string

Response:

[
{
"title": [
"Seller Report",
"Seller Activities"
],
"seller_report": {
"sale_data": {
"graphx_value": "[\"Aug-28\",\"Aug-29\",\"Aug-30\",\"Aug-
31\",\"Sep-01\",\"Sep-02\",\"Sep-03\",\"Sep-04\",\"Sep-05\",\"Sep-06\",\"Sep-
07\",\"Sep-08\",\"Sep-09\",\"Sep-10\",\"Sep-11\",\"Sep-12\",\"Sep-13\",\"Sep-
14\",\"Sep-15\",\"Sep-16\",\"Sep-17\",\"Sep-18\",\"Sep-19\",\"Sep-20\",\"Sep-
21\",\"Sep-22\",\"Sep-23\",\"Sep-24\",\"Sep-25\",\"Sep-26\",\"Sep-27\",\"Sep-
28\",\"Sep-29\",\"Sep-30\",\"Oct-01\",\"Oct-02\",\"Oct-03\",\"Oct-04\",\"Oct-
05\",\"Oct-06\",\"Oct-07\",\"Oct-08\",\"Oct-09\",\"Oct-10\",\"Oct-11\",\"Oct-
12\",\"Oct-13\",\"Oct-14\",\"Oct-15\",\"Oct-16\",\"Oct-17\",\"Oct-18\",\"Oct-
19\",\"Oct-20\",\"Oct-21\",\"Oct-22\",\"Oct-23\",\"Oct-24\",\"Oct-25\",\"Oct-
26\",\"Oct-27\",\"Oct-28\",\"Oct-29\",\"Oct-30\",\"Oct-31\",\"Nov-01\",\"Nov-
02\",\"Nov-03\",\"Nov-04\",\"Nov-05\",\"Nov-06\",\"Nov-07\",\"Nov-08\",\"Nov-
09\",\"Nov-10\",\"Nov-11\",\"Nov-12\",\"Nov-13\",\"Nov-14\",\"Nov-15\",\"Nov-
16\",\"Nov-17\",\"Nov-18\",\"Nov-19\",\"Nov-20\",\"Nov-21\",\"Nov-22\",\"Nov-
23\",\"Nov-24\",\"Nov-25\",\"Nov-26\",\"Nov-27\",\"Nov-28\",\"Nov-29\",\"Nov-
30\",\"Dec-01\",\"Dec-02\",\"Dec-03\",\"Dec-04\",\"Dec-05\",\"Dec-06\",\"Dec-
07\",\"Dec-08\",\"Dec-09\",\"Dec-10\",\"Dec-11\",\"Dec-12\",\"Dec-13\",\"Dec-
14\",\"Dec-15\",\"Dec-16\",\"Dec-17\",\"Dec-18\",\"Dec-19\",\"Dec-20\"]",
"graph_data":
"[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,\"700.0000\",0,0,0,0,0,0,0,0,0,0,0,0,0,0]",
"total_sale_formatted": "$700.00",
"total_sale": "700.00",
"total_payout": "0.00",
"remaining_payout": "560.00",
"commission_paid": "0.00",
"total_payout_formatted": "$0.00",
"remaining_payout_formatted": "$560.00",
"commission_paid_formatted": "$0.00",
 "percent_compare": 100
},
"seller_order": {
"total_order": 2,
"processing_order": 0,
"complete_order": 1,
"cancelled_order": 0,
"graphx_value": "[\"Aug-28\",\"Aug-29\",\"Aug-30\",\"Aug-
31\",\"Sep-01\",\"Sep-02\",\"Sep-03\",\"Sep-04\",\"Sep-05\",\"Sep-06\",\"Sep-
07\",\"Sep-08\",\"Sep-09\",\"Sep-10\",\"Sep-11\",\"Sep-12\",\"Sep-13\",\"Sep-
14\",\"Sep-15\",\"Sep-16\",\"Sep-17\",\"Sep-18\",\"Sep-19\",\"Sep-20\",\"Sep-
21\",\"Sep-22\",\"Sep-23\",\"Sep-24\",\"Sep-25\",\"Sep-26\",\"Sep-27\",\"Sep-
28\",\"Sep-29\",\"Sep-30\",\"Oct-01\",\"Oct-02\",\"Oct-03\",\"Oct-04\",\"Oct-
05\",\"Oct-06\",\"Oct-07\",\"Oct-08\",\"Oct-09\",\"Oct-10\",\"Oct-11\",\"Oct-
12\",\"Oct-13\",\"Oct-14\",\"Oct-15\",\"Oct-16\",\"Oct-17\",\"Oct-18\",\"Oct-
19\",\"Oct-20\",\"Oct-21\",\"Oct-22\",\"Oct-23\",\"Oct-24\",\"Oct-25\",\"Oct-
26\",\"Oct-27\",\"Oct-28\",\"Oct-29\",\"Oct-30\",\"Oct-31\",\"Nov-01\",\"Nov-
02\",\"Nov-03\",\"Nov-04\",\"Nov-05\",\"Nov-06\",\"Nov-07\",\"Nov-08\",\"Nov-
09\",\"Nov-10\",\"Nov-11\",\"Nov-12\",\"Nov-13\",\"Nov-14\",\"Nov-15\",\"Nov-
16\",\"Nov-17\",\"Nov-18\",\"Nov-19\",\"Nov-20\",\"Nov-21\",\"Nov-22\",\"Nov-
23\",\"Nov-24\",\"Nov-25\",\"Nov-26\",\"Nov-27\",\"Nov-28\",\"Nov-29\",\"Nov-
30\",\"Dec-01\",\"Dec-02\",\"Dec-03\",\"Dec-04\",\"Dec-05\",\"Dec-06\",\"Dec-
07\",\"Dec-08\",\"Dec-09\",\"Dec-10\",\"Dec-11\",\"Dec-12\",\"Dec-13\",\"Dec-
14\",\"Dec-15\",\"Dec-16\",\"Dec-17\",\"Dec-18\",\"Dec-19\",\"Dec-20\"]",
"graph_data":
"[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,0,0,0,0,0,0,0,0,0,0,0,0,0,0]",
"percent_compare": 100
},
"top_category": [
{
"id": 2,
"percentage": 100,
"category": "Default Category"
}
],
"average_order_value": {
"graphx_value": "[\"Aug-28\",\"Aug-29\",\"Aug-30\",\"Aug-
31\",\"Sep-01\",\"Sep-02\",\"Sep-03\",\"Sep-04\",\"Sep-05\",\"Sep-06\",\"Sep-
07\",\"Sep-08\",\"Sep-09\",\"Sep-10\",\"Sep-11\",\"Sep-12\",\"Sep-13\",\"Sep-
14\",\"Sep-15\",\"Sep-16\",\"Sep-17\",\"Sep-18\",\"Sep-19\",\"Sep-20\",\"Sep-
21\",\"Sep-22\",\"Sep-23\",\"Sep-24\",\"Sep-25\",\"Sep-26\",\"Sep-27\",\"Sep-
28\",\"Sep-29\",\"Sep-30\",\"Oct-01\",\"Oct-02\",\"Oct-03\",\"Oct-04\",\"Oct-
05\",\"Oct-06\",\"Oct-07\",\"Oct-08\",\"Oct-09\",\"Oct-10\",\"Oct-11\",\"Oct-
12\",\"Oct-13\",\"Oct-14\",\"Oct-15\",\"Oct-16\",\"Oct-17\",\"Oct-18\",\"Oct-
19\",\"Oct-20\",\"Oct-21\",\"Oct-22\",\"Oct-23\",\"Oct-24\",\"Oct-25\",\"Oct-
26\",\"Oct-27\",\"Oct-28\",\"Oct-29\",\"Oct-30\",\"Oct-31\",\"Nov-01\",\"Nov-
02\",\"Nov-03\",\"Nov-04\",\"Nov-05\",\"Nov-06\",\"Nov-07\",\"Nov-08\",\"Nov-
09\",\"Nov-10\",\"Nov-11\",\"Nov-12\",\"Nov-13\",\"Nov-14\",\"Nov-15\",\"Nov-
16\",\"Nov-17\",\"Nov-18\",\"Nov-19\",\"Nov-20\",\"Nov-21\",\"Nov-22\",\"Nov-
23\",\"Nov-24\",\"Nov-25\",\"Nov-26\",\"Nov-27\",\"Nov-28\",\"Nov-29\",\"Nov-
30\",\"Dec-01\",\"Dec-02\",\"Dec-03\",\"Dec-04\",\"Dec-05\",\"Dec-06\",\"Dec-
07\",\"Dec-08\",\"Dec-09\",\"Dec-10\",\"Dec-11\",\"Dec-12\",\"Dec-13\",\"Dec-
14\",\"Dec-15\",\"Dec-16\",\"Dec-17\",\"Dec-18\",\"Dec-19\",\"Dec-20\"]",
"graph_data":
"[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,280,0,0,0,0,0,0,0,0,0,0,0,0,0,0]",
 "avg_order_value": 280,
"percent_compare": 100,
"avg_order_value_formatted": "$280.00"
},
"topselling_product": [],
"top_customer": {
"total_top_customer": 1,
"percent_compare": 100,
"top_customer_data": [
{
"entity_id": "1",
"customer_base_total": "$560.00",
"order_count": "2",
"name": "John Smith",
"email": "raginidwivedi.mg368@webkul.in",
"billing_telephone": "08976567890",
"gender": null,
"billing_full": "street merut 272155",
"customer_base_total_formatted": "560.00"
}
]
}
},
"seller_activity": {
"latest_order": [
{
"mageproduct_id": "000000004",
"created_at": "2024-12-24 13:17:16",
"status": "processing",
"actual_seller_amount": "2240.0000",
"shipping_address": "CompanyName,street,merut,272155",
"images": [
{
"image":
"http://192.168.15.89/magento/EE247p3/pub/media/catalog/product/f/8/
f899139df5e1059396431415e770c6dd.jpg",
"name": "product1",
"qty": 5
}
]
},
{
"mageproduct_id": "000000003",
"created_at": "2024-12-24 09:53:29",
"status": "complete",
"actual_seller_amount": "2800.0000",
"shipping_address": "CompanyName,street,merut,272155",
"images": [
{
"image":
"http://192.168.15.89/magento/EE247p3/pub/media/catalog/product/f/8/
f899139df5e1059396431415e770c6dd.jpg",
"name": "product1",
"qty": 5
}
]
},
{
"mageproduct_id": "000000002",
 "created_at": "2024-12-06 12:09:14",
"status": "complete",
"actual_seller_amount": "0.0000",
"shipping_address": "CompanyName,street,merut,272155",
"images": [
{
"image":
"http://192.168.15.89/magento/EE247p3/pub/media/catalog/product/f/8/
f899139df5e1059396431415e770c6dd.jpg",
"name": "product1",
"qty": 1
}
]
},
{
"mageproduct_id": "000000001",
"created_at": "2024-12-06 12:06:01",
"status": "complete",
"actual_seller_amount": "560.0000",
"shipping_address": "CompanyName,street,merut,272155",
"images": [
{
"image":
"http://192.168.15.89/magento/EE247p3/pub/media/catalog/product/f/8/
f899139df5e1059396431415e770c6dd.jpg",
"name": "product1",
"qty": 1
}
]
}
],
"seller_activity_notification": [],
"seller_latest_review_comment": [],
"seller_rating": {
"price_percent": {
"star5": 0,
"star4": 0,
"star3": 0,
"star2": 0,
"star1": 100
},
"value_percent": {
"star5": 0,
"star4": 0,
"star3": 100,
"star2": 0,
"star1": 0
},
"quality_percent": {
"star5": 0,
"star4": 0,
"star3": 0,
"star2": 0,
"star1": 100
}
}
}
}
]
8. Get Seller profile Data
API Resource: /rest/V1/mpapi/sellers/me/getprofile
Method: GET

Response:
[
{
"profile_hint": "enable",
"display_seller_profile": "enable",
"profile_status": "completed",
"profile_data": "{\"twitter\":
{\"value\":\"twitterid\",\"icon_active\":\"1\"},\"facebook\":
{\"value\":\"facebookactive\",\"icon_active\":\"1\"},\"instragram\":
{\"value\":\"instraid\",\"icon_active\":\"1\"},\"youtube\":
{\"value\":\"youtubeid\",\"icon_active\":\"1\"},\"vimeo\":
{\"value\":\"vimeoid\",\"icon_active\":\"1\"},\"pinterest\":
{\"value\":null,\"icon_active\":\"0\"},\"moleskine\":
{\"value\":\"moskiid\",\"icon_active\":\"1\"},\"tiktok\":
{\"value\":\"tiktokid\",\"icon_active\":\"1\"},\"contact_number\":\"7906948573\",\"
shop_title\":\"shoptitle\",\"low_stock_quantity\":\"100\",\"fulfilment_image\":\"ht
tp:\\/\\/192.168.15.89\\/magento\\/mpapi\\/pub\\/media\\/avatar\\/
Screenshot_from_2024-12-20_14-55-
29.png\",\"fulfilment_text\":\"fulfil\",\"banner_pic\":\"http:\\/\\/
192.168.15.89\\/magento\\/mpapi\\/pub\\/media\\/avatar\\/default\\/
Screenshot_from_2023-07-06_15-05-27.png\",\"logo_pic\":\"http:\\/\\/
192.168.15.89\\/magento\\/mpapi\\/pub\\/media\\/default\\/
noimage.png\",\"company_locality\":\"company
locality\",\"country_pic\":\"IN\",\"company_description\":\"<p>dis<\\/
p>\",\"meta_description\":null,\"meta_keyword\":null,\"payment_source\":null,\"retu
rn_policy\":{\"status\":\"enable\",\"value\":null},\"shipping_policy\":
{\"status\":\"enable\",\"value\":null},\"privacy_policy\":
{\"status\":\"enable\",\"value\":null},\"google_analytic\":
{\"status\":\"enable\",\"value\":\"test\"},\"taxvat\":\"test\"}"
}
]

9. Get Seller shop url Data

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/getshopurl

Params:
storeId:Int

Response:

[
{
"profile_target_url": "marketplace/seller/profile/shop/dcdfcdf",
"collection_target_url": "marketplace/seller/collection/shop/dcdfcdf",
"review_target_url": "marketplace/seller/feedback/shop/dcdfcdf",
"location_target_url": "marketplace/seller/location/shop/dcdfcdf",
"profile_request_url": "test2",
"collection_request_url": "test3",
"review_request_url": "test4",
"location_request_url": "test5",
"policy_request_url": "test6"
}
]
10.Save Seller Shop url Data
Method: POST
API Resource: /rest/V1/mpapi/sellers/me/saveshopurl

Params:
storeId:Int

Post Data: (All Object keys)

{
"profile_request_url": "d1",
"collection_request_url": "d2",
"review_request_url": "d3",
"location_request_url": "d4",
"policy_request_url": "d5"
}

Response:

[
{
"message": "The URL Rewrite has been saved",
"status": true
}
]

11. Get seller's customer data

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/customer

Params:
storeId:Int
pageSize:Int
currentPage:Int
#filter:"{\"name\":\"John Smith\"}"

Response:

[
{
"customer_data": [
{
"name": "Ragini Dwivedi",
"email": "raginidwivedi.mg368@webkul.in",
"contact_number": "08976567890",
"gender": "0",
"address": "street merut 272155",
"base_total": "7088.0000",
"order_count": "45",
"order_link": "marketplace/order/history/customer_id/1"
}
],
"total_count": 1
}
]

Seller Transactions Api

12. Seller Withdrawal Request

Method: POST
API Resource: /rest/V1/mpapi/sellers/me/withdrawalrequest

Response:

[
{
"status": true,
"message": "Your withdrawal request has been sent successfully"
}
]

13. Seller Transaction view

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/transaction/view
param:
Id :Int (required)

Response:
[
{
"transaction_id": "tr-LGOsaFU3y3h",
"transaction_info": {
"date": "2024-12-24 10:09:53",
"amount": "$2,800.00",
"amount_formatted": "2800.0000",
"type": "Manual",
"method": "Manual",
"comment_message": "DVSVS"
},
"transaction_order_info": [
{
"order_id": "000000003",
"product_name": "product1",
"price_formatted": "$700.00",
"price": "700.0000",
"qty": "5",
"total_price_formatted": "$3,500.00",
"total_price": "3500.0000",
"total_tax_formatted": "$0.00",
"total_tax": "0.0000",
"total_discount_formatted": "$0.00",
"total_discount": "0.0000",
"total_shipping_formatted": "$0.00",
"total_shipping": "0.0000",
"total_commission_formatted": "$0.00",
"total_commission": "0.0000",
"subtotal_formatted": "$0.00",
"subtotal": 0
}
]
}
]

Response if the transaction id is not of current Seller:

[
 {
"error": "You do not have permission to view this transaction."
}
]

14. Seller Transaction List

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/transaction/list

params : (optional)
{
"filter" : {
"pageSize":20,
"curPage":1,
"id_from":1 ,
"id_to":5,
"transaction_id":"tr-d6jS54OB1h4",
"purchased_on_from":"01-09-2024",
"puchased_on_to":"02-10-2024"
}}

Response:
[
{
"total_seller_earning_formatted": "$560.00",
"total_seller_earning": 560,
"total_sale_formatted": "$700.00",
"total_sale": 700,
"tax_formatted": "$0.00",
"tax": 0,
"commission_formatted": "$140.00",
"commission": "140.0000",
"total_payout_formatted": "$560.00",
"total_payout": "560.0000",
"remaining_payout_formatted": "$0.00",
"remaining_payout": "0.0000",
"button_show": false,
"items": [
{
"id": "1",
"purchased_on": "2024-12-24 10:09:53",
"transaction_amount": "2800.0000",
"transaction_amount_formatted": "$2,800.00",
"transaction_id": "tr-LGOsaFU3y3h",
"message": "DVSVS"
},
{
"id": "2",
"purchased_on": "2024-12-26 07:29:04",
"transaction_amount": "560.0000",
"transaction_amount_formatted": "$560.00",
"transaction_id": "tr-K9uP6BXTxny",
"message": "test"
}
]
}
]
Seller order Related Api
14.Method: GET
API Resource: /rest/V1/mpapi/sellers/me/orderview

param:
orderId :Int (required)

Response:

[
{
"can_ship": false,
"order_id": "000000048",
"status": "Closed",
"date": "2024-10-17 12:54:49",
"invoice_ids": "41",
"shipment_ids": "34",
"creditmemo_ids": null,
"can_invoice": false,
"can_cancel": false,
"can_mail": false,
"can_refund": false,
"buyer_data": {
"title": "Buyer Information",
"name_label": "Customer Name: ",
"name_value": "Ragini Dwivedi",
"email_label": "Email: ",
"email_value": "raginidwivedi.mg368@webkul.in"
},
"order_info": {
"title": "Order Information",
"shipping_address": {
"title": "Shipping Address",
"address": {
"name": "test test2",
"street": "street",
"state": "merut, , 272155",
"country": "Turkey",
"telephone": "T: 08976567890"
}
},
"shipping_method": {
"title": "Shipping Information",
"method": "Flat Rate - Fixed"
},
"billing_address": {
"title": "Billing Address",
"address": {
"name": "test test2",
"street": "street",
"state": "merut, , 272155",
"country": "Turkey",
"telephone": "T: 08976567890"
}
},
"payment_method": {
"title": "Payment Method",
"method": "Check / Money order"
}
},
"items": [
{
"product_name": "product3",
"sku": "product3",
"qty": {
"ordered": "1.0000",
"invoiced": "1.0000",
"cancelled": "0.0000",
"shipped": "1.0000",
"refunded": "1.0000"
},
"price": "$1,000.00",
"admin_commission": "$200.00",
"vendor_total": "$800.00",
"subtotal": "1000.0000",
"links": []
},
{
"product_name": "mkproduct2",
"sku": "mkproduct2",
"qty": {
"ordered": "1.0000",
"invoiced": "0.0000",
"cancelled": "1.0000",
"shipped": "0.0000",
"refunded": "0.0000"
},
"price": "$700.00",
"admin_commission": "$0.00",
"vendor_total": "$0.00",
"subtotal": "0.0000",
"links": []
}
],
"total_vendor_amount": {
"title": "Total Vendor Amount",
"value": "$800.00"
},
"subtotal": {
"title": "Subtotal",
"value": "$1,000.00"
},
"discount": {
"title": "Discount",
"value": "$0.00"
},
"total_ordered_amount": {
"title": "Total Ordered Amount",
"value": "$1,000.00"
},
"total_admin_commision": {
"title": "Total Admin Commission",
"value": "$200.00"
},
"tax": {
"title": "Total Tax",
"value": "$0.00"
}
 }
]

15. Seller order list

API Resource: rest/V1/mpapi/sellers/me/orderlist
Method: GET

Params:

type : "all/pending/processing/cancelled/holded/closed/complete", //required

pageSize:5
curPage:1
order_id: "magerealorder_id",
customer_name: "customername",
purchase_from: "01-09-2024",
puchase_to: "17-09-2024",
status: "status"

Response:

[
{
"order": [
{
"active": "active",
"count": 4,
"label": "All Orders"
},
{
"active": "",
"count": 0,
"label": "Pending"
},
{
"active": "",
"count": 1,
"label": "Processing"
},
{
"active": "",
"count": 0,
"label": "On Hold"
},
{
"active": "",
"count": 1,
"label": "Complete"
},
{
"active": "",
"count": 2,
"label": "Closed"
},
{
"active": "",
"count": 0,
"label": "Canceled"
}
],
 "items": [
{
"purchased_on": "2024-12-06 12:06:01",
"product_name": null,
"order_id": "000000001",
"status": "Complete",
"customer": "John Smith",
"entity_id": "1",
"base_total": {
"amount": 560,
"amount_formatted": "$560.00"
},
"purchase_total": {
"amount": 560,
"amount_formatted": "$560.00"
},
"products": [
{
"url":
"http://192.168.15.89/magento/EE247p3/pub/product1.html",
"product_id": "1",
"ordered": "1.0000",
"invoiced": "1.0000",
"shipped": "1.0000"
}
]
},
{
"purchased_on": "2024-12-06 12:09:14",
"product_name": null,
"order_id": "000000002",
"status": "Closed",
"customer": "John Smith",
"entity_id": "2",
"base_total": {
"amount": 0,
"amount_formatted": "$0.00"
},
"purchase_total": {
"amount": 0,
"amount_formatted": "$0.00"
},
"products": [
{
"url":
"http://192.168.15.89/magento/EE247p3/pub/product1.html",
"product_id": "1",
"ordered": "1.0000",
"invoiced": "1.0000",
"shipped": "1.0000",
"refunded": "1.0000"
}
]
},
{
"purchased_on": "2024-12-24 09:53:29",
"product_name": null,
"order_id": "000000003",
"status": "Closed",
 "customer": "John Smith",
"entity_id": "3",
"base_total": {
"amount": 0,
"amount_formatted": "$0.00"
},
"purchase_total": {
"amount": 0,
"amount_formatted": "$0.00"
},
"products": [
{
"url":
"http://192.168.15.89/magento/EE247p3/pub/product1.html",
"product_id": "1",
"ordered": "5.0000",
"invoiced": "5.0000",
"shipped": "5.0000",
"refunded": "5.0000"
}
]
},
{
"purchased_on": "2024-12-24 13:17:16",
"product_name": null,
"order_id": "000000004",
"status": "Processing",
"customer": "John Smith",
"entity_id": "4",
"base_total": {
"amount": 2240,
"amount_formatted": "$2,240.00"
},
"purchase_total": {
"amount": 2240,
"amount_formatted": "$2,240.00"
},
"products": [
{
"url":
"http://192.168.15.89/magento/EE247p3/pub/product1.html",
"product_id": "1",
"ordered": "5.0000",
"invoiced": "1.0000",
"shipped": "1.0000",
"refunded": "1.0000"
}
]
}
]
}
]

16.Seller order invoice list Api

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/order/invoicelist

param:
 orderId :Int (required)
pageSize: Int (required)
curPage :Int (required)

Response:
[
{
"items": [
{
"invoice_id": "000000005",
"created_at": "2024-12-24 09:53:57",
"bill_to_name": "John Smith",
"status": "Paid",
"entity_id": "5",
"amount_formatted": "$3,500.00",
"amount": "3500.0000"
}
]
}
]

17.Seller order shipment list

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/order/shipmentlist

param:
orderId :Int (required)
pageSize: Int (required)
curPage :Int (required)

Response:

[
{
"items": [
{
"shipment_id": "000000002",
"ship_date": "2024-12-24 10:09:33",
"ship_to_name": "John Smith",
"entity_id": "2",
"quantity": "5.0000"
}
]
}
]
18.Seller order creditmemo list

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/order/creditmemolist

param:
orderId :Int (required)
pageSize: Int (required)
curPage :Int (required)

Response:

[
 {
"items": [
{
"creditmemo_id": "000000004",
"created_at": "2024-12-26 05:11:34",
"bill_to_name": "John Smith",
"amount_formatted": "$3,500.00",
"amount": "3500.0000",
"status": "Refunded",
"entity_id": "4"
}
]
}
]

19.Send order mail to customer by seller

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/ordermailtocustomer

param:
orderId :Int (required)

Response:

[
{
"status": true,
"message": "You sent the order email."
}
]

20.Seller Earnings Api

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/earning

Request data:

Json data
{
"period":"day/month/year", //required
"from":"2024-07-01", String
"to":"2024-10-22", String
"page_size":20, Int
"cur_page":1 Int
}

Response:
[
{
"datasets": "[560]",
"labels": "[\"6\\/12\\/2024\"]",
"items": {
"total_count": 2,
"items": [
{
"interval": "Dec 6, 2024",
"total_amount_formatted": "$1,400.00",
 "total_amount": "1400.0000",
"total_earnings_formatted": "$560.00",
"total_earnings": "560.0000",
"total_discount_amount_formatted": "$0.00",
"total_discount_amount": "0.0000",
"admin_commision_formatted": "$140.00",
"admin_commision": "140.0000",
"orders": "2"
},
{
"interval": "Dec 24, 2024",
"total_amount_formatted": "$7,000.00",
"total_amount": "7000.0000",
"total_earnings_formatted": "$2,240.00",
"total_earnings": "2240.0000",
"total_discount_amount_formatted": "$0.00",
"total_discount_amount": "0.0000",
"admin_commision_formatted": "$560.00",
"admin_commision": "560.0000",
"orders": "2"
}
]
}
}
]

21.Seller Review List:

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/review

Request data:
These filters are optional
{
"page_size": 10,
"cur_page": 1,
"id_from": 1,
"id_to": 3,
"created_from": "07-08-2024",
"created_to": "08-08-2024",
"price_rating": 5,
"value_rating": 5,
"quality_rating": 5,
"feed_summary": "dvfv",
"feed_review": "dfvdfv",
"customer_name": "ware house",
"status": 1
}

Response:

[
{
"items": [
{
"id": "1",
"price_rating": "100",
"value_rating": "80",
"quality_rating": "80",
 "feed_summary": "testing seller review",
"feed_review": "testing seller review test",
"status": "Approved",
"created_at": "2024-11-08 06:20:13",
"customer_name": "shreya pandey"
}
],
"total_count": 1
}
]

22.Api to save Seller Pdf header Info

Method: POST
API Resource: /rest/V1/mpapi/sellers/me/savepdfheaderinfo

param:

othersInfo:String

Response:

[
{
"status": true,
"message": "Information has been saved successfully"
}
]

23.Api to get Seller Pdf header Info

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/getpdfheaderinfo

Response:

[
{
"othersInfo": "testing other info"
}
]

24. Api to get list of published news of admin at seller end

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/publishednews

Request parameters: //Optional

{
"pageSize":1,
"curPage":1
}

Response:

[
{
 "total_count": 2,
"items": [
{
"created_at": "2024-10-17 09:44:32",
"content": "<style>#html-body [data-pb-style=J4KW8A8]{background-
position:left top;background-size:cover;background-repeat:no-repeat;background-
attachment:scroll;align-self:stretch}#html-body [data-pb-style=D4D1DE1]
{display:flex;width:100%}#html-body [data-pb-style=ITLC8IQ],#html-body [data-pb-
style=S0SDHEP]{justify-content:flex-start;display:flex;flex-
direction:column;background-position:left top;background-size:cover;background-
repeat:no-repeat;background-attachment:scroll;width:50%;align-self:stretch}</
style><div class=\"pagebuilder-column-group\" data-background-images=\"{}\" data-
content-type=\"column-group\" data-appearance=\"default\" data-grid-size=\"12\"
data-element=\"main\" data-pb-style=\"J4KW8A8\"><div class=\"pagebuilder-column-
line\" data-content-type=\"column-line\" data-element=\"main\" data-pb-
style=\"D4D1DE1\"><div class=\"pagebuilder-column\" data-content-type=\"column\"
data-appearance=\"full-height\" data-background-images=\"{}\" data-element=\"main\"
data-pb-style=\"ITLC8IQ\"><div data-content-type=\"text\" data-
appearance=\"default\" data-element=\"main\"><p>Testing2</p></div></div><div
class=\"pagebuilder-column\" data-content-type=\"column\" data-appearance=\"full-
height\" data-background-images=\"{}\" data-element=\"main\" data-pb-
style=\"S0SDHEP\"></div></div></div>",
"read_status": 1,
"id": 3
}
]
}
]

25. Api to mark news as Read:

Method: POST
API Resource: /rest/V1/mpapi/sellers/me/newsmarkread

Request parameters: //Optional

{
"newsId":1
}

Response:
If id is passed then it only mark read to this particular news

[
{
"message": "The news has been marked as read.",
"status": true
}
]

If id is not provided:
[
{
"message": "All news have been marked as read.",
"status": true
}
]

26. Seller configurable product attribute related Api

1.Delete attribute by Id

Method: POST
API Resource: /rest/V1/mpapi/sellers/me/deleteattribute

param:
attrId :(Int)

Response:

[
{
"message": "Attribute has been successfully deleted",
"status": true
}
]

27. Create and edit Attribute:

Method: POST
API Resource: /rest/V1/mpapi/sellers/me/addattribute

Input Data:
{
"attribute_id":220, // Pass in the case if you want to edit attribute
"attribute_code": "testing", //required
"attribute_label": "desfgsdf", //required
"val_required": true,
"attroptions": [ //required
{
"admin": "red",
"store": "red1"
},
{
"admin": "blue",
"store": "blue1"
}
],
"default":0
}

Response:

In case if you pass attribute id for edit attribute:

[
{
"message": "Attribute has been updated sucessfully",
"status": true
}
]

In case if attribute id is not passed.

[
{
"message": "Attribute created successfully",
"status": true
 }
]

28. Get seller configurable product attribute list:

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/configattributelist

param:JSON form (optional)

{
"page_size":2,
"cur_page":1,
"attribute_code":"attr1",
"frontend_label":"label1",
"is_required":1,
"is_user_defined":1,
"is_visible":1,
"is_searchable":1,
"is_comparable":1
}

Response:

[
{
"total_count": 59,
"items": [
{
"attribute_id": "93",
"attribute_code": "color",
"frontend_label": "Color",
"is_required": 0,
"is_user_defined": 1,
"is_visible": 1,
"scope": "Global",
"is_searchable": 1,
"is_comparable": 1
},
{
"attribute_id": "182",
"attribute_code": "mycolor",
"frontend_label": "my color",
"is_required": 1,
"is_user_defined": 1,
"is_visible": 1,
"scope": "Global",
"is_searchable": 1,
"is_comparable": 0
},
{
"attribute_id": "183",
"attribute_code": "mysize",
"frontend_label": "my size",
"is_required": 1,
"is_user_defined": 1,
"is_visible": 1,
"scope": "Global",
"is_searchable": 1,
 "is_comparable": 0
},
{
"attribute_id": "184",
"attribute_code": "attributeset2attribute1",
"frontend_label": "Attribute Set 2 - Attribute 1",
"is_required": 1,
"is_user_defined": 1,
"is_visible": 1,
"scope": "Global",
"is_searchable": 1,
"is_comparable": 0
},
{
"attribute_id": "185",
"attribute_code": "attributeset3attribute1",
"frontend_label": "Attribute Set 3 - Attribute 1",
"is_required": 1,
"is_user_defined": 1,
"is_visible": 1,
"scope": "Global",
"is_searchable": 1,
"is_comparable": 0
}
]
}
]

29. Get seller configurable product attribute information by attribute id:

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/configattributeinfo

param:

attributeId:Int #required

Response:

[
{
"attribute_code": "webkul_attr1",
"attribute_label": "webkul_attr1",
"frontend_input": "select",
"val_required": "1",
"default_value": "",
"store_options": {
"300": "blue1",
"299": "red1"
},
"options": "{\"totalRecords\":2,\"items\":
[{\"option_id\":\"300\",\"attribute_id\":\"245\",\"sort_order\":\"0\",\"value\":\"b
lue\"},
{\"option_id\":\"299\",\"attribute_id\":\"245\",\"sort_order\":\"0\",\"value\":\"re
d\"}]}"
}
]

30.Api to get list of seller allowed product type

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/allowedproducttype

Response:

[
[
{
"value": "simple",
"label": "Simple"
},
{
"value": "downloadable",
"label": "Downloadable"
},
{
"value": "virtual",
"label": "Virtual"
},
{
"value": "configurable",
"label": "Configurable"
}
]
]

31.Api to get list of seller allowed product attribute set

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/allowedproductattributeset

Response:

[
[
{
"value": "4",
"label": "Default"
},
{
"value": "10",
"label": "Attribute Set 1"
},
{
"value": "11",
"label": "Attribute Set 2"
},
{
"value": "12",
"label": "Attribute Set 3"
}
]
]

Seller Draft product related Api

32. Draft product listing

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/listdraftproduct

Filter params (optional):

{
"page_size":1,
"cur_page":1,
"id_from":1,
"id_to":4,
"created_from":"26-10-2024",
"created_to":"26-10-2024",
"name":"testdraft",
"sku":"testdraft",
"price":1000,
"qty":100
}

Response:

[
{
"total_count": 3,
"items": [
{
"id": "5",
"name": "draftmk1",
"sku": "new-shoes-p3",
"price": "1000.0000",
"qty": "10",
"created_at": "2024-11-08 12:58:48",
"action": {
"edit": "marketplace/product/addset/4/type/simple/draft_id/5",
"delete": "marketplace/product/deletedraftproductdraft_id/5"
}
},
{
"id": "6",
"name": "editwkdraftproduct",
"sku": "testpostdraft2",
"price": "1000.0000",
"qty": "100",
"created_at": "2024-11-11 08:45:03",
"action": {
"edit": "marketplace/product/addset/4/type/simple/draft_id/6",
"delete": "marketplace/product/deletedraftproductdraft_id/6"
}
},
{
"id": "7",
"name": "posttestdrafttest2",
"sku": "testpostdraft2",
"price": "1000.0000",
"qty": "100",
"created_at": "2024-11-11 08:46:57",
"action": {
"edit": "marketplace/product/addset/4/type/simple/draft_id/7",
"delete": "marketplace/product/deletedraftproductdraft_id/7"
 }
}
]
}
]

33.Add and edit draft product:

Method: POST
API Resource: /rest/V1/mpapi/sellers/me/createdraftproduct

params:
{
"type": "simple",
"draftProductId": 62, only pass in the case of editing draft product
"set": 4,
"product": {
"category_ids": [ ],
"name": "postdrafttest2",
"description": "testing rest post draft1",
"short_description": "testing rest post draft1",
"sku": "testpostdraft2",
"price": 1000,
"special_price": 50,
"special_from_date": "04/07/2024",
"special_to_date":"04/12/2024",
"stock_data": {
"manage_stock": 1,
"use_config_manage_stock": 1
},
"quantity_and_stock_status": {
"qty": 100,
"is_in_stock": 1
},
"visibility": 4,
"tax_class_id": 1,
"product_has_weight": 1,
"weight": 10,
"url_key": "testingpostdraft",
"meta_title": "test",
"meta_keyword": "test",
"meta_description": "test",
"mp_product_cart_limit": 10,
"media_gallery": {
"images": {
"hdgahsf": {
"file": "/m/1/m1.jpg.tmp",
"removed":0
}
},
"image": "/m/1/m1.jpg.tmp",
"small_image": "/m/1/m1.jpg.tmp",
"thumbnail":"/m/1/m1.jpg.tmp"
}
}
}

Response:
[
{
"message": "The draft product has been successfully created",
"status": true
}
]

34. Delete Draft product

Method: POST
API Resource: /rest/V1/mpapi/sellers/me/deleteraftproduct

Params(required):

{
"draftId":7(pass draft id)
}

Response:

Response if the seller is authorised to delete the draft product.

[
{
"message": "Draft Product has been successfully deleted",
"status": true
}
]

Response if the seller is not authorised to delete the draft product.

[
{
"message": "You are not authorized to perform this action",
"status": false
}
]

35.Save Draft Product:

Method: POST
API Resource: /rest/V1/mpapi/sellers/me/savedraftproduct

Input:
draft_id:Int

Response:

[
{
"status": true,
"data": "{\"product_id\":\"1209\"}",
"message": "Product Added Successfully"
}
]

36.Api to list related,cross sell and upsell products at seller end:

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/relatedcrossupselllist

params(json):

{
"type": "related", //related,crosssell,upsell
"product_id": 1427, #(It is required to pass if type argument is passed in
api)
"page_size": 15,
"cur_page": 1,
"id_from": 1,
"id_to": 100,
"price_from": 100,
"price_to": 200,
"name": "configproduct1",
"attribute_set_id": 10,
"sku": "",
"status": 2
}

Response:

[
{
"total_count": 5,
"items": [
{
"id": "1201",
"name": "mkproduct1",
"sku": "mkproduct1",
"status": "Disabled",
"price": "$120.00",
"type": "Simple Product",
"attribute_set": "Default",
"thumbnail": null
},
{
"id": "1202",
"name": "mkproduct2",
"sku": "mkproduct2",
"status": "Enabled",
"price": "$700.00",
"type": "Simple Product",
"attribute_set": "Default",
"thumbnail": null
},
{
"id": "1204",
"name": "Test product",
"sku": "Test product",
"status": "Enabled",
"price": "$700.00",
"type": "Simple Product",
"attribute_set": "Default",
"thumbnail": null
},
{
"id": "1205",
"name": "product3",
 "sku": "product3",
"status": "Enabled",
"price": "$1,000.00",
"type": "Simple Product",
"attribute_set": "Default",
"thumbnail": null
},
{
"id": "1207",
"name": "product4",
"sku": "product4",
"status": "Enabled",
"price": "$700.00",
"type": "Simple Product",
"attribute_set": "Default",
"thumbnail": null
}
]
}
]

37. Upload Image for downloadable product

Method: POST
API Resource: /rest/V1/mpapi/uploaddownloadableimage

Params:

type: link,link_sample,sample

{
image: select an image by clicking on select file button

Response:

[
{
"name": "image (47).png",
"type": "image/png",
"error": 0,
"size": 92196,
"file": "/i/m/image_47_.png.tmp",
"url":
"/home/users/ragini.dwivedi/www/html/magento/EE247p2/pub/media/downloadable/tmp/
link_samples/i/m/image_47_.png",
"message": "Image has been successfully uploaded",
"success": true
}
]

38. Api to get draft product Info by draft id

Method: GET
API Resource: /rest/V1/mpapi/sellers/me/draftproductinfo

Params:
draftId: 1 #required

[
{
"id": "7",
"name": "posttestdrafttest2",
"sku": "testpostdraft2",
"price": "1000.0000",
"qty": "100",
"created_at": "2024-11-11 08:46:57",
"content":
"{\"draft_product_id\":6,\"type\":\"simple\",\"set\":4,\"product\":
{\"category_ids\":[],\"name\":\"posttestdrafttest2\",\"description\":\"testing rest
post draft1\",\"short_description\":\"testing rest post
draft1\",\"sku\":\"testpostdraft2\",\"price\":1000,\"special_price\":50,\"special_f
rom_date\":\"04\\/07\\/2024\",\"special_to_date\":\"04\\/12\\/2024\",\"stock_data\"
:{\"manage_stock\":1,\"use_config_manage_stock\":1},\"quantity_and_stock_status\":
{\"qty\":100,\"is_in_stock\":1},\"visibility\":4,\"tax_class_id\":1,\"product_has_w
eight\":1,\"weight\":10,\"url_key\":\"testingpostdraft\",\"meta_title\":\"test\",\"
meta_keyword\":\"test\",\"meta_description\":\"test\",\"mp_product_cart_limit\":10,
\"fulfilled_by\":0,\"product_image\":[{\"value_id\":\"\",\"file\":\"\\/m\\/1\\/
m1.jpg\",\"media_type\":\"image\",\"position\":0,\"disabled\":0,\"url\":\"http:\\/\
\/192.168.15.89\\/magento\\/EE247p2\\/pub\\/media\\/tmp\\/catalog\\/product\\/m\\/
1\\/m1.jpg\",\"path\":\"\\/home\\/users\\/ragini.dwivedi\\/www\\/html\\/magento\\/
EE247p2\\/pub\\/media\\/tmp\\/catalog\\/product\\/m\\/1\\/m1.jpg\"}]},\"links\":
{\"related\":[],\"crosssell\":[],\"upsell\":[]}}"
}
]

39. Api to get Seller details using Seller

Method: GET
API Resource: /rest/V1/mpapi/sellers/sellerbysellerid/:sellerid

Response:

[
{
"entity_id": "2",
"is_seller": "1",
"seller_id": "1",
"payment_source": "p1",
"twitter_id": "1",
"facebook_id": null,
"gplus_id": null,
"youtube_id": "youtun1",
"vimeo_id": "vimeoac1",
"instagram_id": null,
"pinterest_id": "p1",
"moleskine_id": "testmok",
"tiktok_id": "tik2",
"tw_active": "1",
"fb_active": "0",
"gplus_active": "0",
"youtube_active": "1",
"vimeo_active": "1",
"instagram_active": "0",
"pinterest_active": "1",
"moleskine_active": "1",
 "tiktok_active": "1",
"others_info": "test",
"banner_pic":
"http://192.168.15.89/magento/EE247p3/pub/media/avatar/Screenshot_from_2025-07-
02_19-59-24.png",
"shop_url": "dvfdv",
"shop_title": "st",
"logo_pic":
"http://192.168.15.89/magento/EE247p3/pub/media/avatar/noimage.png",
"company_locality": "comlocagraphql",
"country_pic": "AF",
"company_description": "<p>Company Description</p>",
"meta_keyword": "m1",
"meta_description": "md",
"background_width": null,
"store_id": "1",
"contact_number": "8957648569",
"return_policy": "<p>return1</p>",
"shipping_policy": "<p>shop1</p>",
"created_at": "2024-12-02 09:34:37",
"updated_at": "2025-07-03 12:46:22",
"admin_notification": "0",
"privacy_policy": "<p>priv1</p>",
"allowed_categories": "",
"allowed_attributeset_ids": "",
"is_separate_panel": null,
"low_stock_quantity": "100",
"fulfilment_image":
"http://192.168.15.89/magento/EE247p3/pub/media/avatar/Screenshot_from_2025-07-
02_19-59-24_1.png",
"fulfilment_text": "fulfil"
}
]