0% found this document useful (0 votes)
1 views33 pages

User Guide

The document outlines various API calls for sellers, requiring seller authorization to access their profile, products, orders, and invoices. It includes methods for retrieving details, creating invoices, canceling orders, and managing shipments, along with the expected responses for each API call. Additionally, it provides endpoints for seller account creation and communication with admin or other sellers.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
1 views33 pages

User Guide

The document outlines various API calls for sellers, requiring seller authorization to access their profile, products, orders, and invoices. It includes methods for retrieving details, creating invoices, canceling orders, and managing shipments, along with the expected responses for each API call. Additionally, it provides endpoints for seller account creation and communication with admin or other sellers.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
You are on page 1/ 33

Seller API Calls : needs Seller authorization

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

1. Get self profile details


API Resource: rest/V1/mpapi/sellers/me
Method: GET
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
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": string,
"value": string,
"condition_type": string
}
]
}
]
},
"total_count": int
}

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
Params:
orderId: int
Response:
Case 1 : When Sucess
{
[
{
"invoice_id": string,
"message": string,
"status": int
}
]
}

Case 2 : When already created invoice


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

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": string,
"sendmailWarning": string,
"mainHeading": 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
}
]

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": 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
},
"shippingCarriers": [
{
"carrier": string,
"title": string,
"number": string
}
],
"items": [
{
"productName": string,
"sku": string,
"qty": int
}
],
"status": int
}
]
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 and admin both)


API Resource: mpapi/product/uploadproductimage
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", /** string */
"set": "4", /** string */
"product": {
"category_ids": [ "3" ], /** array */
"name": "testport", /** string */
"description": "testport", /** string */
"short_description": "", /** string */
"sku": "testport", /** string */
"price": "14", /** string */
"special_price": "", /** string */
"special_from_date": "", /** string */
"special_to_date": "", /** string */
"stock_data": {
"manage_stock": "1", /** string */
"use_config_manage_stock": "1" /** string */
},
"quantity_and_stock_status": {
"is_in_stock": "1" /** string */
},
"visibility": "4", /** string */
"tax_class_id": "0", /** string */
"product_has_weight": "1", /** string */
"weight": "11", /** string */
"meta_title": "", /** string */
"meta_keyword": "", /** string */
"meta_description": "", /** string */
"mp_product_cart_limit": "1", /** string */
"image": "", /** string */
"small_image": "", /** string */
"thumbnail": "", /** string */
"configurable_attributes_data": {
"93": { /** string
<super_attribute_id> */
"attribute_id": "93", /** string */
"code": "color", /** string */
"label": "Color", /** string */
"position": "0", /** string */
"values": {
"51": { /** string
<value_id> */
"include": "1", /** string */
"value_index": "51" /** string */
}
}
}
},
"product_length": "", /** string */
"product_width": "", /** string */
"product_height": "", /** string */
"fragile": "0" /** string */
},
"attributes": [
"93" /** string */
],
"variations-matrix": {
"51": { /** string
<value_id>*/
"image": "", /** string */
"name": "testport-Black", /** string */
"configurable_attribute": "{\"color\":\"51\"}", /** string */
"status": "1", /** string */
"sku": "testport-Black", /** string */
"price": "11.11", /** string */
"quantity_and_stock_status": { /** string */
"qty": "" /** string */
},
"weight": "11.11" /** string */
}
},
"associated_product_ids": [
"" /** string */
],
"affect_configurable_product_attributes": "1" /** string */
}

Response:
[
{
"error": 0, /** bool */
"product_id": "2155", /** string */
"message": "Product Added Successfully" /** string */
}
]

18. Save Seller Profile


API Resource: rest/V1/mpapi/sellers/me/saveprofile
Method: POST
Params:
{
"company_locality": string,
"contact_number": string,
"facebook_id": string,
"fb_active": string,
"gplus_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
}

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

19. Delete Seller Product


API Resource: rest/V1/mpapi/sellers/me/deleteProduct
Method: POST
Params:
{
productIds: string
}

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:/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:/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:/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:/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
}
]

You might also like