0% found this document useful (0 votes)
15 views87 pages

Userguide For GraphQL

The document outlines various GraphQL API calls for accessing marketplace and seller-related data, including marketplace landing page details, seller lists, seller products, reviews, and configurations. It provides specific queries and their corresponding responses, detailing the structure and data returned for each API call. The document serves as a reference for developers to interact with the marketplace API without needing authorization for guest users, while some resources require seller authorization.
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)
15 views87 pages

Userguide For GraphQL

The document outlines various GraphQL API calls for accessing marketplace and seller-related data, including marketplace landing page details, seller lists, seller products, reviews, and configurations. It provides specific queries and their corresponding responses, detailing the structure and data returned for each API call. The document serves as a reference for developers to interact with the marketplace API without needing authorization for guest users, while some resources require seller authorization.
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/ 87

GraphQL API Calls :

-----------------------
API Type : Query
-----------------------

Guest User Accessible Resources (No authorization needed API resource)


--------

1. To get marketplace landing page details


Query :
query MarketplaceLandingPage {
marketplaceLandingPage {
aboutImage
headTitle
pageLayout
banner {
content
image
label
}
layoutOne {
bannerContent
bannerDisplay
bannerImage
iconsDisplay
marketplacelabel1
marketplacelabel2
marketplacelabel3
marketplacelabel4
icons {
image
label
}
}
layoutThree {
bannerContent
bannerDisplay
bannerImage
iconsDisplay
marketplacebutton
marketplacelabel1
marketplacelabel2
marketplacelabel3
icons {
image
label
}
}
layoutTwo {
bannerContent
bannerDisplay
bannerImage
marketplacebutton
}
sellers {
profileurl
sellerIcon
sellerProductCount
shopTitle
products {
id
name
thumbnail
type
}
}
}
}

Response :
{
"data": {
"marketplaceLandingPage": {
"aboutImage": "Turn Your Passion Into a Business",
"headTitle": "Turn Your Passion Into a Business",
"pageLayout": 3,
"banner": [
{
"content": "Sell with usWe are largest growing community to
sell online, Come and Join us.",
"image": "<base_url>/media/marketplace/banner/sell-page-2-hero-
[Link]",
"label": "Open your shop"
}
],
"layoutOne": {
"bannerContent": "<h1>Sell with us</h1><h2>We are largest growing
community to sell online, Come and Join us.</h2>",
"bannerDisplay": "0",
"bannerImage": "<base_url>/media/marketplace/banner/sell-page-
[Link]",
"iconsDisplay": "1",
"marketplacelabel1": "Turn Your Passion Into a Business",
"marketplacelabel2": "Sellers with Taste",
"marketplacelabel3": "More than 500 shop owners have joined us last
month",
"marketplacelabel4": "Why to sell with us",
"icons": [
{
"image": "<base_url>/media/marketplace/icon/icon-register-
[Link]",
"label": "Register Yourself"
},
{
"image": "<base_url>/media/marketplace/icon/icon-add-
[Link]",
"label": "Add Products"
},
{
"image": "<base_url>/media/marketplace/icon/icon-start-
[Link]",
"label": "Start Selling"
},
{
"image": "<base_url>/media/marketplace/icon/icon-collect-
[Link]",
"label": "Generate Revenues"
}
]
},
"layoutThree": {
"bannerContent": "<h1>Sell with us</h1><h2>We are largest growing
community to sell online, Come and Join us.</h2>",
"bannerDisplay": "1",
"bannerImage": "<base_url>/media/marketplace/banner/sell-page-2-
[Link]",
"iconsDisplay": "0",
"marketplacebutton": "Open your shop",
"marketplacelabel1": "Really easy to setup and customize",
"marketplacelabel2": "Why to sell with us",
"marketplacelabel3": "Open your online shop & Explore a new world
of market with more then millions of shoppers",
"icons": [
{
"image": "<base_url>/media/marketplace/icon/sell-page-2-
[Link]",
"label": "Create an Account"
},
{
"image": "<base_url>/media/marketplace/icon/sell-page-2-
[Link]",
"label": "Customize your Profile"
},
{
"image": "<base_url>/media/marketplace/icon/sell-page-2-
[Link]",
"label": "Add your Details"
},
{
"image": "<base_url>/media/marketplace/icon/sell-page-2-
[Link]",
"label": "Add your Product Listing"
},
{
"image": "<base_url>/media/marketplace/icon/sell-page-2-
[Link]",
"label": "Sell your Product and Earn Profits"
}
]
},
"layoutTwo": {
"bannerContent": "<h1>Have you got something exciting</h1><h2>Come
On! Sell with us.</h2>",
"bannerDisplay": "1",
"bannerImage": "<base_url>/media/marketplace/banner/sell-page-1-
[Link]",
"marketplacebutton": "Open your shop"
},
"sellers": [
{
"profileurl": "[Link]",
"sellerIcon": "<base_url>/media/avatar/Screenshot_from_2023-08-
01_11-[Link]",
"sellerProductCount": "50",
"shopTitle": "test seller",
"products": [
{
"id": 1241,
"name": "vi1",
"thumbnail":
"<base_url>/static/version1695028166/graphql/_view/en_US/Magento_Catalog/images/
product/placeholder/.jpg",
"type": "virtual"
}
]
}
]
}
}
}

2. To get Seller List


Query :
query SellersList {
sellersList(
filter: {
is_seller: {
eq: 1
}
}
) {
total_count
items {
admin_notification
background_width
allowed_categories
banner_pic
company_description
company_locality
contact_number
country_pic
created_at
entity_id
facebook_id
fb_active
gplus_active
gplus_id
instagram_active
instagram_id
is_seller
logo_pic
meta_description
meta_keyword
moleskine_active
moleskine_id
others_info
payment_source
pinterest_active
pinterest_id
privacy_policy
return_policy
seller_id
shipping_policy
shop_title
shop_url
store_id
tw_active
twitter_id
updated_at
vimeo_active
vimeo_id
youtube_active
youtube_id
}
}
}

Response :
{
"data": {
"sellersList": {
"total_count": 6,
"items": [
{
"admin_notification": "0",
"allowed_categories": "",
"background_width": null,
"banner_pic": null,
"company_description": null,
"company_locality": null,
"contact_number": null,
"country_pic": null,
"created_at": "2023-04-17 [Link]",
"entity_id": "1",
"facebook_id": null,
"fb_active": "0",
"gplus_active": "0",
"gplus_id": null,
"instagram_active": "0",
"instagram_id": null,
"is_seller": "1",
"logo_pic": null,
"meta_description": null,
"meta_keyword": null,
"moleskine_active": "0",
"moleskine_id": null,
"others_info": null,
"payment_source": null,
"pinterest_active": "0",
"pinterest_id": null,
"privacy_policy": null,
"return_policy": null,
"seller_id": "1",
"shipping_policy": null,
"shop_title": null,
"shop_url": "[Link]",
"store_id": "0",
"tw_active": "0",
"twitter_id": null,
"updated_at": "2023-06-23 [Link]",
"vimeo_active": "0",
"vimeo_id": null,
"youtube_active": "0",
"youtube_id": null
}
]
}
}
}

3. To Get Seller Product


Query :
query GetSellerProduct {
getSellerProduct(
filter: {seller_id: {eq: "6"}}, pageSize: 25, currentPage: 1,sort: { price:
DESC }) {
items {
name
sku
price_range {
minimum_price {
regular_price {
value
currency
}
}
}
}
page_info {
page_size
current_page
}
}
}

Response :
{
"data": {
"getSellerProduct": {
"items": [
{
"name": "product1",
"sku": "test1-2",
"price_range": {
"minimum_price": {
"regular_price": {
"value": 120,
"currency": "BRL"
}
}
}
}
],
"page_info": {
"page_size": 25,
"current_page": 1
}
}
}
}

4. To Get Seller Review


Query :
query GetSellerReview {
getSellerReview(
id: 1
) {
total_count
items {
admin_notification
buyer_email
buyer_id
created_at
entity_id
feed_nickname
feed_price
feed_quality
feed_review
feed_summary
feed_value
seller_id
seller_pending_notification
status
updated_at
}
}
}

Response :
{
"data": {
"getSellerReview": {
"total_count": 2,
"items": [
{
"admin_notification": "0",
"buyer_email": null,
"buyer_id": "4",
"created_at": "2023-06-19 [Link]",
"entity_id": "1",
"feed_nickname": "Ashish test",
"feed_price": "80",
"feed_quality": "60",
"feed_review": "test best ",
"feed_summary": "testtt",
"feed_value": "60",
"seller_id": "1",
"seller_pending_notification": "1",
"status": "1",
"updated_at": "2023-06-19 [Link]"
}
]
}
}
}

5. To Get Seller Review Details


Query :
query GetSellerReviewDetails {
getSellerReviewDetails(
id: 1
) {
total_count
items {
admin_notification
buyer_email
buyer_id
created_at
entity_id
feed_nickname
feed_price
feed_quality
feed_review
feed_summary
feed_value
seller_id
seller_pending_notification
status
updated_at
}
}
}

Response :
{
"data": {
"getSellerReviewDetails": {
"total_count": 1,
"items": [
{
"admin_notification": "0",
"buyer_email": null,
"buyer_id": "4",
"created_at": "2023-06-19 [Link]",
"entity_id": "1",
"feed_nickname": "Ashish test",
"feed_price": "80",
"feed_quality": "60",
"feed_review": "test best ",
"feed_summary": "testtt",
"feed_value": "60",
"seller_id": "1",
"seller_pending_notification": "1",
"status": "1",
"updated_at": "2023-06-19 [Link]"
}
]
}
}
}

6. To Get Seller/Product Flag Configuration


Query :
query MpReportConfig {
mpReportConfig {
reportProduct
reportProductGuestStatus
reportProductLabel
reportSeller
reportSellerGuestStatus
reportSellerLabel
reportProductReasons {
id
label
}
reportSellerReasons {
id
label
}
}
}

Response :
{
"data": {
"mpReportConfig": {
"reportProduct": "1",
"reportProductGuestStatus": "0",
"reportProductLabel": "Report Product",
"reportSeller": "1",
"reportSellerGuestStatus": "1",
"reportSellerLabel": "Report Seller",
"reportProductReasons": [
{
"id": "1",
"label": "test"
},
{
"id": "2",
"label": "dummy"
},
{
"id": "other_reason",
"label": "Other"
}
],
"reportSellerReasons": [
{
"id": "1",
"label": "reason1"
},
{
"id": "other_reason",
"label": "Other"
}
]
}
}
}

7. To Get Seller Details using Seller Id.

Query :

query sellerDetailsBySellerId {
sellerDetailsBySellerId(
sellerId:1
) {
sellerdetails {
background_width
company_description
company_locality
contact_number
country_pic
banner_pic
created_at
seller_info {
name
email
}
entity_id
facebook_id
fb_active
gplus_active
gplus_id
instagram_active
instagram_id
is_seller
logo_pic
meta_description
meta_keyword
moleskine_active
moleskine_id
order_count
others_info
payment_source
pinterest_active
pinterest_id
privacy_policy
product_count
return_policy
seller_id
seller_rating
shipping_policy
shop_title
shop_url
store_id
tw_active
twitter_id
updated_at
vimeo_active
vimeo_id
youtube_active
youtube_id
tiktok_id
tiktok_active
admin_notification
allowed_categories

}
}
}

Response :

{
"data": {
"sellerDetailsBySellerId": {
"sellerdetails": {
"background_width": null,
"company_description": "<p>Company Description</p>",
"company_locality": "comlocagraphql",
"contact_number": "8957648569",
"country_pic": "[Link]",
"banner_pic":
"[Link]
02_19-[Link]",
"created_at": "2024-12-02 [Link]",
"seller_info": {
"name": "John Smith",
"email": "raginidwivedi.mg368@[Link]"
},
"entity_id": "2",
"facebook_id": null,
"fb_active": "0",
"gplus_active": "0",
"gplus_id": null,
"instagram_active": "0",
"instagram_id": null,
"is_seller": "1",
"logo_pic":
"[Link]
"meta_description": "md",
"meta_keyword": "m1",
"moleskine_active": "1",
"moleskine_id": "testmok",
"order_count": "27",
"others_info": "test",
"payment_source": "p1",
"pinterest_active": "1",
"pinterest_id": "p1",
"privacy_policy": "<p>priv1</p>",
"product_count": "4",
"return_policy": "<p>return1</p>",
"seller_id": "1",
"seller_rating": "0",
"shipping_policy": "<p>shop1</p>",
"shop_title": "st",
"shop_url": "dvfdv",
"store_id": "1",
"tw_active": "1",
"twitter_id": "1",
"updated_at": "2025-07-03 [Link]",
"vimeo_active": "1",
"vimeo_id": "vimeoac1",
"youtube_active": "1",
"youtube_id": "youtun1",
"tiktok_id": "tik2",
"tiktok_active": "1",
"admin_notification": "0",
"allowed_categories": ""
}
}
}
}

(Seller User Accessible resources)


Seller authorization needed API resource

1. To Get Seller Profile


Query :
query SellerSelf {
sellerSelf {
admin_notification
allowed_categories
background_width
banner_pic
company_description
company_locality
contact_number
country_pic
created_at
entity_id
facebook_id
fb_active
gplus_active
gplus_id
instagram_active
instagram_id
is_seller
logo_pic
meta_description
meta_keyword
moleskine_active
moleskine_id
others_info
payment_source
pinterest_active
pinterest_id
privacy_policy
return_policy
seller_id
shipping_policy
shop_title
shop_url
status
store_id
tw_active
twitter_id
updated_at
vimeo_active
vimeo_id
youtube_active
youtube_id
}
}

Response :
{
"data": {
"sellerSelf": {
"admin_notification": "0",
"allowed_categories": "",
"background_width": null,
"banner_pic": null,
"company_description": null,
"company_locality": null,
"contact_number": null,
"country_pic": null,
"created_at": "2023-04-17 [Link]",
"entity_id": "1",
"facebook_id": null,
"fb_active": "0",
"gplus_active": "0",
"gplus_id": null,
"instagram_active": "0",
"instagram_id": null,
"is_seller": "1",
"logo_pic": null,
"meta_description": null,
"meta_keyword": null,
"moleskine_active": "0",
"moleskine_id": null,
"others_info": null,
"payment_source": null,
"pinterest_active": "0",
"pinterest_id": null,
"privacy_policy": null,
"return_policy": null,
"seller_id": "1",
"shipping_policy": null,
"shop_title": null,
"shop_url": "[Link]",
"status": null,
"store_id": "0",
"tw_active": "0",
"twitter_id": null,
"updated_at": "2023-06-23 [Link]",
"vimeo_active": "0",
"vimeo_id": null,
"youtube_active": "0",
"youtube_id": null
}
}
}

2. To Get Seller Recently added Product


Query :

query SellerSelfProduct {
sellerSelfProduct {
items {
mageproduct_id
name
sku
type
price
url
website_id
is_salable
}
}
}

Response :
{
"data": {
"sellerSelfProduct": {
"items": [
{
"mageproduct_id": "1237",
"name": "duplicate3",
"sku": "duplicate3",
"type": "simple",
"price": "1001.000000",
"url": "[Link]
"website_id": null,
"is_salable": 1
},
{
"mageproduct_id": "1235",
"name": "duplicate2",
"sku": "duplicate2",
"type": "simple",
"price": "1001.000000",
"url": "[Link]
"website_id": null,
"is_salable": 1
},
{
"mageproduct_id": "1233",
"name": "shoes product56",
"sku": "new-shoes-p30",
"type": "virtual",
"price": "1001.000000",
"url": "[Link]
"website_id": null,
"is_salable": 1
},
{
"mageproduct_id": "1230",
"name": "downloadtest1",
"sku": "downloadtest1",
"type": "downloadable",
"price": "14.000000",
"url": "[Link]
"website_id": null,
"is_salable": 1
}
]
}
}
}

3. To Get Seller Order List


Query :
query SellerOrderList {
sellerOrderList(
filter: {
seller_id: {
eq: 1
}
}
) {
total_count
items {
actual_seller_amount
applied_coupon_amount
commission_rate
cpprostatus
created_at
currency_rate
entity_id
is_coupon
is_paid
is_shipping
is_withdrawal_requested
magebuyer_id
magepro_name
magepro_price
mageproduct_id
magequantity
magerealorder_id
order_id
order_item_id
paid_status
parent_item_id
seller_id
total_amount
total_commission
total_tax
trans_id
updated_at
}
}
}

Response :
{
"data": {
"sellerOrderList": {
"total_count": 2,
"items": [
{
"actual_seller_amount": "40.0000",
"applied_coupon_amount": "0.0000",
"commission_rate": "20.0000",
"cpprostatus": "0",
"created_at": "2023-06-19 [Link]",
"currency_rate": "1.0000",
"entity_id": "1",
"is_coupon": "1",
"is_paid": "0",
"is_shipping": "1",
"is_withdrawal_requested": "0",
"magebuyer_id": "1",
"magepro_name": "test111",
"magepro_price": "50.0000",
"mageproduct_id": "4",
"magequantity": "1",
"magerealorder_id": "000000002",
"order_id": "2",
"order_item_id": "2",
"paid_status": "0",
"parent_item_id": null,
"seller_id": "1",
"total_amount": "50.0000",
"total_commission": "10.0000",
"total_tax": "0.0000",
"trans_id": "0",
"updated_at": "2023-06-19 [Link]"
}
]
}
}
}

4. To Get Seller Order Sale List


Query :
query SellerOrderSales {
sellerOrderSales {
total_count
items {
carrier_name
coupon_amount
created_at
creditmemo_id
entity_id
invoice_id
is_canceled
order_id
order_status
product_ids
refunded_coupon_amount
refunded_shipping_charges
seller_id
seller_pending_notification
shipment_id
shipping_charges
tax_to_seller
total_tax
tracking_number
updated_at
}
}
}

Response :
{
"data": {
"sellerOrderSales": {
"total_count": 2,
"items": [
{
"carrier_name": null,
"coupon_amount": "0.0000",
"created_at": "2023-06-19 [Link]",
"creditmemo_id": "0",
"entity_id": "1",
"invoice_id": "0",
"is_canceled": "0",
"order_id": "2",
"order_status": "pending",
"product_ids": "4",
"refunded_coupon_amount": "0.0000",
"refunded_shipping_charges": "0.0000",
"seller_id": "1",
"seller_pending_notification": "1",
"shipment_id": "0",
"shipping_charges": "0.0000",
"tax_to_seller": "1",
"total_tax": "0.0000",
"tracking_number": null,
"updated_at": "2023-06-19 [Link]"
}
]
}
}
}

5. To Get Seller Shipment Details


Query :
query SellerGetShipmentDetails {
sellerGetShipmentDetails(
orderId: 73,
shipmentId: 18
) {
mainHeading
sendmailAction
sendmailWarning
subHeading
billingAddressData {
title
address {
country_code
firstname
lastname
middlename
region
region_id
country_code
street
postcode
city
telephone
}
}
shippingMethodData {
method
title
}
shippingCarriers {
carrier
number
title
}
shippingAddressData {
title
address {
country_code
firstname
lastname
middlename
region
region_id
country_code
street
postcode
city
telephone

}
}
paymentMethodData {
method
title
}
orderData {
dateLabel
dateValue
label
statusLabel
statusValue
title
}
items {
productName
qty
sku
}
buyerData {
emailLabel
emailValue
nameLabel
nameValue
title
}
}
}

Response :
{
"data": {
"sellerGetShipmentDetails": {
"mainHeading": "View Shipment Details",
"sendmailAction": "Send Email To Customer",
"sendmailWarning": "Are you sure you want to send shipment email to
customer?",
"subHeading": "Shipment #2000000005 | 2024-10-14 [Link]",
"billingAddressData": {
"title": "Billing Address",
"address": {
"country_code": "US",
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"region": "American Samoa",
"region_id": "3",
"street": [
"Green str, 67"
],
"postcode": "23481",
"city": "CityM",
"telephone": "3468676"
}
},
"shippingMethodData": {
"method": "Flat Rate - Fixed",
"title": "Shipping Information"
},
"shippingCarriers": [
{
"carrier": "Custom Value",
"number": "435345",
"title": null
}
],
"shippingAddressData": {
"title": "Shipping Address",
"address": {
"country_code": "TW",
"firstname": "test",
"lastname": "test2",
"middlename": null,
"region": "Alabama",
"region_id": "0",
"street": [
"street"
],
"postcode": "272155",
"city": "merut",
"telephone": "08976567890"
}
},
"paymentMethodData": {
"method": "Check / Money order",
"title": "Payment Method"
},
"orderData": {
"dateLabel": "Order Date",
"dateValue": "2024-10-14 [Link]",
"label": "Order # 2000000010",
"statusLabel": "Order Status",
"statusValue": "Complete",
"title": "Order Information"
},
"items": [
{
"productName": "productimg",
"qty": 1,
"sku": "testim1"
},
{
"productName": "tproduct1",
"qty": 1,
"sku": "bike"
}
],
"buyerData": {
"emailLabel": "Email",
"emailValue": "raginidwivedi.mg368@[Link]",
"nameLabel": "Customer Name",
"nameValue": "Ragini Dwivedi",
"title": "Buyer Information"
}
}
}
}

6. To Get Seller Invoice Details


Query :
query SellerGetInvoiceDetails {
sellerGetInvoiceDetails(
orderId: 73,
invoiceId: 14
) {
mainHeading
sendmailAction
sendmailWarning
subHeading
billingAddressData {
title
address {
country_code
firstname
lastname
middlename
region
region_id
country_code
street
postcode
city
telephone
}
}
buyerData {
emailLabel
emailValue
nameLabel
nameValue
title
}
items {
adminComission
adminComissionFormatted
price
priceFormatted
productName
subTotal
subTotalFormatted
vendorTotal
vendorTotalFormatted
}
totalVendorAmount {
title
value
valueFormatted
}
totalOrderedAmount {
title
value
valueFormatted
}
totalAdminComission {
title
value
valueFormatted
}
tax {
title
value
valueFormatted
}
subtotal {
title
value
valueFormatted
}
shippingMethodData {
method
title
}
shippingAddressData {
title
address {
country_code
firstname
lastname
middlename
region
region_id
country_code
street
postcode
city
telephone
}
}
shipping {
title
value
valueFormatted
}
paymentMethodData {
method
title
}
orderData {
dateLabel
dateValue
label
statusLabel
statusValue
title
}
}
}

Response :
{
"data": {
"sellerGetInvoiceDetails": {
"mainHeading": "View Invoice Details",
"sendmailAction": "Send Email To Customer",
"sendmailWarning": "Are you sure you want to send order email to
customer?",
"subHeading": "Invoice #000000001 - Paid | 2024-12-06 [Link]",
"billingAddressData": {
"title": "Billing Address",
"address": {
"country_code": "TR",
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"region": null,
"region_id": null,
"street": [
"street"
],
"postcode": "272155",
"city": "merut",
"telephone": "08976567890"
}
},
"buyerData": {
"emailLabel": "Email",
"emailValue": "raginidwivedi.mg368@[Link]",
"nameLabel": "Customer Name",
"nameValue": "John Smith",
"title": "Buyer Information"
},
"items": [
{
"adminComission": "560.0000",
"adminComissionFormatted": "$560.00",
"price": "700",
"priceFormatted": "$700.00",
"productName": "product1",
"subTotal": "3500",
"subTotalFormatted": "$3,500.00",
"vendorTotal": "2240.0000",
"vendorTotalFormatted": "$2,240.00"
}
],
"totalVendorAmount": {
"title": "Total Vendor Amount",
"value": "2240",
"valueFormatted": "$2,240.00"
},
"totalOrderedAmount": {
"title": "Total Ordered Amount",
"value": "3500",
"valueFormatted": "$3,500.00"
},
"totalAdminComission": {
"title": "Total Admin Commission",
"value": "560",
"valueFormatted": "$560.00"
},
"tax": {
"title": "Total Tax",
"value": "0",
"valueFormatted": "$0.00"
},
"subtotal": {
"title": "Subtotal",
"value": "3500",
"valueFormatted": "$3,500.00"
},
"shippingMethodData": {
"method": "Flat Rate - Fixed",
"title": "Shipping Information"
},
"shippingAddressData": {
"title": "Shipping Address",
"address": {
"country_code": "TR",
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"region": null,
"region_id": "0",
"street": [
"street"
],
"postcode": "272155",
"city": "merut",
"telephone": "08976567890"
}
},
"shipping": {
"title": "Shipping & Handling",
"value": "0",
"valueFormatted": "$0.00"
},
"paymentMethodData": {
"method": "Check / Money order",
"title": "Payment Method"
},
"orderData": {
"dateLabel": "Order Date",
"dateValue": "2024-12-24 [Link]",
"label": "Order # 000000004",
"statusLabel": "Order Status",
"statusValue": "Processing",
"title": "Order Information"
}
}
}
}

7. To Get Seller Credit Memo Details


Query :
query SellerGetCreditmemoDetails {
sellerGetCreditmemoDetails(orderId:101, creditmemoId: 1) {
mainHeading
sendmailAction
sendmailWarning
subHeading
billingAddressData {
title
address {
country_code
firstname
lastname
middlename
region
region_id
country_code
street
postcode
city
telephone
}
}
buyerData {
emailLabel
emailValue
nameLabel
nameValue
title
}
items {
adminComission
adminComissionFormatted
price
priceFormatted
productName
subTotal
subTotalFormatted
vendorTotal
vendorTotalFormatted
}
totalVendorAmount {
title
value
valueFormatted
}
totalOrderedAmount {
title
value
valueFormatted
}
totalAdminComission {
title
value
valueFormatted
}
paymentMethodData {
method
title
}
orderData {
dateLabel
dateValue
label
statusLabel
statusValue
title
}
shippingAddressData {
title
address {
country_code
firstname
lastname
middlename
region
region_id
country_code
street
postcode
city
telephone
}
}
shippingMethodData {
method
title
}
subtotal {
title
value
valueFormatted
}
tax {
title
value
valueFormatted
}
shipping {
title
value
valueFormatted
}
}
}

Response :
{
"data": {
"sellerGetCreditmemoDetails": {
"mainHeading": "Credit Memo Information",
"sendmailAction": "Send Email To Customer",
"sendmailWarning": "Are you sure you want to send order email to customer?",
"subHeading": "Credit Memo #2000000001 - Refunded | 2024-10-15 [Link]",
"billingAddressData": {
"title": "Billing Address",
"address": {
"country_code": "US",
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"region": "Alabama",
"region_id": "0",
"street": [
"Green str, 67"
],
"postcode": "272155",
"city": "merut",
"telephone": "3468676"
}
},
"buyerData": {
"emailLabel": "Email",
"emailValue": "raginidwivedi.mg368@[Link]",
"nameLabel": "Customer Name",
"nameValue": "Ragini123 Dwivedi",
"title": "Buyer Information"
},
"items": [
{
"adminComission": null,
"adminComissionFormatted": "€0.00",
"price": "76",
"priceFormatted": "€76.00",
"productName": "restp1",
"subTotal": "80",
"subTotalFormatted": "€80.00",
"vendorTotal": "72.0000",
"vendorTotalFormatted": "€72.00"
}
],
"totalVendorAmount": {
"title": "Total Vendor Amount",
"value": "72",
"valueFormatted": "€72.00"
},
"totalOrderedAmount": {
"title": "Total Ordered Amount",
"value": "80",
"valueFormatted": "€80.00"
},
"totalAdminComission": {
"title": "Total Admin Commission",
"value": "0",
"valueFormatted": "€0.00"
},
"paymentMethodData": {
"method": "Check / Money order",
"title": "Payment Method"
},
"orderData": {
"dateLabel": "Order Date",
"dateValue": "2024-12-12 [Link]",
"label": "Order # 000000092",
"statusLabel": "Order Status",
"statusValue": "Complete",
"title": "Order Information"
},
"shippingAddressData": {
"title": "Shipping Address",
"address": {
"country_code": "TW",
"firstname": "test",
"lastname": "test2",
"middlename": null,
"region": "Alabama",
"region_id": "0",
"street": [
"street"
],
"postcode": "272155",
"city": "merut",
"telephone": "08976567890"
}
},
"shippingMethodData": {
"method": "Flat Rate - Fixed",
"title": "Shipping Information"
},
"subtotal": {
"title": "Subtotal",
"value": "80",
"valueFormatted": "€80.00"
},
"tax": {
"title": "Total Tax",
"value": "0",
"valueFormatted": "€0.00"
},
"shipping": {
"title": "Shipping & Handling",
"value": "0",
"valueFormatted": "€0.00"
}
}
}
}

8. To Get Seller Details By Product SKU


Query :
query SellerByProductSku {
sellerByProductSku(
productSku: "restdownloadable5"
) {
message
seller {
admin_notification
allowed_categories
background_width
banner_pic
company_description
company_locality
contact_number
country_pic
created_at
seller_info {
email
name
}
entity_id
facebook_id
fb_active
gplus_active
gplus_id
instagram_active
instagram_id
is_seller
logo_pic
meta_description
meta_keyword
moleskine_active
moleskine_id
order_count
orders_count
others_info
payment_source
pinterest_active
pinterest_id
privacy_policy
product_count
return_policy
seller_id
seller_rating
shipping_policy
shop_title
shop_url
store_id
tw_active
twitter_id
updated_at
vimeo_active
vimeo_id
youtube_active
youtube_id
}
}
}

Response :
{
"data": {
"sellerByProductSku": {
"message": "Success",
"seller": {
"admin_notification": "0",
"allowed_categories": "2,35,5",
"background_width": null,
"banner_pic": "[Link]",
"company_description": "<p>dis</p>",
"company_locality": "comlocagraphql",
"contact_number": "7906948573",
"country_pic": "IN",
"created_at": "2024-08-06 [Link]",
"seller_info": {
"email": "raginidwivedi.mg368@[Link]",
"name": "Ragini123 Dwivedi"
},
"entity_id": "2",
"facebook_id": "f1",
"fb_active": "1",
"gplus_active": null,
"gplus_id": null,
"instagram_active": "1",
"instagram_id": "ins1",
"is_seller": "1",
"logo_pic": "[Link]
[Link]",
"meta_description": "md",
"meta_keyword": "m1",
"moleskine_active": "1",
"moleskine_id": "testmok",
"order_count": "53",
"orders_count": null,
"others_info": "dfgdf",
"payment_source": "p1",
"pinterest_active": "1",
"pinterest_id": "p1",
"privacy_policy": "<p>priv1</p>",
"product_count": "76",
"return_policy": "<p>return1</p>",
"seller_id": "1",
"seller_rating": "3.6",
"shipping_policy": "<p>shop1</p>",
"shop_title": "st",
"shop_url": "jhhmkhj",
"store_id": "1",
"tw_active": "1",
"twitter_id": "1",
"updated_at": "2024-11-28 [Link]",
"vimeo_active": "1",
"vimeo_id": "vimeoac1",
"youtube_active": "1",
"youtube_id": "youtun1"
}
}
}
}

-----------------------
API Type : Mutation
-----------------------

9. Make Seller Review


Query :
mutation MakeSellerReview {
makeSellerReview(
sellerId: 1
feedback: {
buyer_email: "test@[Link]",
buyer_id: 1,
feed_nickname: "test",
feed_price: 20,
feed_quality: 20,
feed_review: "40",
feed_summary: "test",
feed_value: 60
}
) {
message
review_id
status
}
}

Response :
{
"data": {
"makeSellerReview": {
"message": "Your review successfully saved",
"review_id": 10,
"status": 1
}
}
}

10. Create Seller Account


Query :
mutation CreateSellerAccount {
createSellerAccount(
customer: {
email: "test9@[Link]",
firstname: "test wk",
is_seller: true,
is_subscribed: true,
lastname: "WK",
password: "Admin123"
}
) {
customer {
allow_remote_shopping_assistance
created_at
date_of_birth
email
firstname
gender
group_id
id
is_subscribed
lastname
middlename
prefix
suffix
taxvat
}
}
}

Response :
{
"data": {
"createSellerAccount": {
"customer": {
"allow_remote_shopping_assistance": false,
"created_at": "2023-07-11 [Link]",
"date_of_birth": null,
"email": "test9@[Link]",
"firstname": "test wk",
"gender": null,
"group_id": null,
"id": null,
"is_subscribed": true,
"lastname": "WK",
"middlename": null,
"prefix": null,
"suffix": null,
"taxvat": null
}
}
}
}

11. Add Seller Product


Case 1. Simple Product :
Query:
Create product with single image:
mutation SellerAddProduct {
sellerAddProduct(
type: "simple",
set: 4,
product:
{
description: "Test Product description",
name: "shoes product",
price: 1001,
product_has_weight:1
weight:20
quantity_and_stock_status: {is_in_stock: 1, qty: 10},
sku: "new-shoes-p1",
stock_data: {manage_stock: 1,
use_config_manage_stock: 0},
visibility: 4,
image: "wk/product/198983831/image/[Link] [Link]",
thumbnail: "wk/product/198983831/image/[Link] [Link]",
small_image: "wk/product/198983831/image/[Link] [Link]",
swatch_image: "wk/product/198983831/image/[Link] [Link]",
media_gallery:
{images: [
{file: "wk/product/198983831/image/[Link] [Link]",
label: "Webkul Mug",
media_type: "image",
value_id: "", removed: "0"}]}}) {
status
message
data
}
}

Response:
{
"data": {
"sellerAddProduct": {
"status": true,
"message": "Product Added Successfully",
"data": "{\"product_id\":\"1383\"}"
}
}
}

Create product with multiple Images:

mutation SellerAddProduct {
sellerAddProduct(
type: "simple"
set: 4
product: {
description: "Webkul Product"
name: "Webkul Test Product"
price: 1001
product_has_weight:1
weight:20
quantity_and_stock_status: { is_in_stock: 1, qty: 10 }
sku: "wk-prod"
stock_data: { manage_stock: 1, use_config_manage_stock: 0 }
visibility: 4
image: "wk/product/1630126432/image/[Link] [Link]"
thumbnail: "wk/product/1630126432/image/[Link]
[Link]"
small_image: "wk/product/1630126432/image/[Link]
[Link]"
swatch_image: "wk/product/1630126432/image/[Link]
[Link]"
media_gallery: {
images: [
{
file: "wk/product/1630126432/image/[Link]
[Link]"
label: "Shoes"
media_type: "image"
value_id: ""
removed: "0"
},
{
file: "wk/product/1630126432/image/[Link]
[Link]"
label: "T-shirt"
media_type: "image"
value_id: ""
removed: "0"
},
{
file: "wk/product/1630126432/image/[Link]
[Link]"
label: "Webkul T-shirt"
media_type: "image"
value_id: ""
removed: "0"
}
]
}
}
) {
data
message
status
}
}

Response:
{
"data": {
"sellerAddProduct": {
"error": 0,
"message": "Product Added Successfully",
"product_id": "383"
}
}
}

Case 2. Configurable Product :


mutation SellerAddProduct {
sellerAddProduct(
type: "configurable"
set: 4
product: {
category_ids: [3], #Array
mp_product_cart_limit: 1,
description: "configtest1",
name: "configtest1",
price: 321,
product_has_weight: 1,
quantity_and_stock_status: {
is_in_stock: 1
qty:30
},
short_description: "test123",
sku: "configtest1",
stock_data: {
manage_stock: 1,
use_config_manage_stock: 1
},
visibility: 4,
weight: 44,
configurable_attributes_data: {
attribute_id: 93,
attribute_data: {
attribute_id: 93,
code: "color",
label: "Black",
position: 0,
values: {
include: 1,
value_index: 328
}
}
}
}
attributes: ["93"] #Array
affectConfigurableProductAttributes: 1
associatedProductIds: [""]
variationsMatrix: [
{
image:"wk/product/625868206/image/[Link]",
name: "config30-Black",
configurable_attribute: "{\"color\":\"328\"}",
status: 1,
sku: "config30-Black",
price: 11,
quantity_and_stock_status: {
qty: 11
is_in_stock:1
},
weight: 11
}
]
) {
status
data
message
}
}

Response :
{
"data": {
"sellerAddProduct": {
"status": true,
"data": "{\"product_id\":\"1221\"}",
"message": "Product Added Successfully"
}
}
}

Case 3: Virtual Product

mutation SellerAddProduct {
sellerAddProduct(
type: "virtual"
set: 4
product: {
entity_id:1224
category_ids: [3],
mp_product_cart_limit: 1,
description: "vitual1",
name: "vitual1",
price: 321,
quantity_and_stock_status: {
is_in_stock: 1
qty:30
},

short_description: "vitu7",
sku: "vitu7",
stock_data: {
manage_stock: 1,
use_config_manage_stock: 1
},
visibility: 4,
image: "wk/product/1923476623/image/[Link]",
thumbnail: "wk/product/1923476623/image/[Link]",
small_image: "wk/product/1923476623/image/[Link]",
swatch_image: "wk/product/1923476623/image/[Link]",
media_gallery:
{images: [
{file: "wk/product/1923476623/image/[Link]",
label: "Webkul Mug",
media_type: "image",
value_id: "", removed: "0"}]}

}
) {
status
data
message
}
}

Response:

{
"data": {
"sellerAddProduct": {
"status": true,
"data": "{\"product_id\":1224}",
"message": "Product Added Successfully"
}
}
}

Upload image for downlodable product:

mutation uploadDownloadableImage {
uploadDownloadableImage(
type:"link" #link_sample,link,sample
imageName:"[Link]"
imageEncoded:"" #base64 encoded value of image
) {
status
message
url
file
}
}

Response:

{
"data": {
"uploadDownloadableImage": {
"status": true,
"message": "Images uploaded successfully.",
"url":
"/home/users/[Link]/www/html/magento/EE247p2/pub/media/downloadable/tmp/
links/wk/product/1972535893/image/[Link]",
"file": "wk/product/1972535893/image/[Link]"
}
}
}

Case 4: Downloadable Product


mutation SellerAddProduct {
sellerAddProduct(
type: "downloadable"
set: 4
product: {
category_ids: [3],
mp_product_cart_limit: 1,
description: "d9",
name: "d9",
price: 321,
quantity_and_stock_status: {
is_in_stock: 1
qty:30
},
short_description: "d8",
sku: "d9"
stock_data: {
manage_stock: 1,
use_config_manage_stock: 1
},
visibility: 4.
links_purchased_separately:1,
links_title:"Testing link title", #Title for link
samples_title:"Testing samples title" # Title for Samples
}
isDownloadable:true
downloadable:{
link: [{
title:"test1"
price:20.34
link_id:0
type:"file"
link_url:""
file: "[{\"file\":\"\/wk\/product\/1972535893\/image\/wkimage-
[Link]\",\"name\":\"wkimage-
[Link]\",\"size\":213222,\"status\":\"new\"}]"
is_shareable:1
number_of_downloads:5 # (Only Pass when download limit is limited)
# is_unlimited:1 # (Only Pass when download limit is unlimited)
sample:{
type:"file", # use value "url" in case providing url for downloadable
product
file: "[{\"file\":\"\/wk\/product\/1972535893\/image\/wkimage-
[Link]\",\"name\":\"wkimage-
[Link]\",\"size\":213222,\"status\":\"new\"}]",
url: ""
}
}],
,
sample: [{sort_order: 1, is_delete: 0, sample_id: 0, title: "sdvds",
type: "file", file: "[{\"file\":\"/wk/product/1658501029/image/wkimage-
[Link]\",\"name\":\"wkimage-
[Link]\",\"size\":213222,\"status\":\"new\"}]", sample_url: ""
}]
}
) {
status
data
message
}
}

Response:
{
"data": {
"sellerAddProduct": {
"status": true,
"data": "{\"product_id\":\"1225\"}",
"message": "Product Added Successfully"
}
}
}

Case 5: For save and duplicate product,need to pass one extra parameter
back:"duplicate"

Query:
mutation SellerAddProduct {
sellerAddProduct(
type: "simple",
back:"duplicate",
set: 4,
product:
{
description: "Test Product description",
name: "duplicate2",
short_description:"test"
price: 1001,
quantity_and_stock_status:
{ is_in_stock: 1,
qty: 10
},
product_has_weight:1
weight:10
sku: "duplicate2",
stock_data: {
manage_stock: 1,
use_config_manage_stock: 0
},
visibility: 4,
},

) {
status
message
data
}
}
Response:

{
"data": {
"sellerAddProduct": {
"status": true,
"message": "Product Added and duplicated Successfully",
"data": "{\"product_id\":\"1242\"}"
}
}
}

Case 6. Create product with crossell,upsell and related product data:

mutation SellerAddProduct {
sellerAddProduct(
type: "simple",
set: 4,
product:
{
description: "Test Product description",
name: "jacket product-p6",
price: 1001,
entity_id:1251
product_has_weight:1,
weight:20
quantity_and_stock_status: {is_in_stock: 1, qty: 10},
sku: "new-jacket-p6",
stock_data: {manage_stock: 1,
use_config_manage_stock: 0},
visibility: 4,
}
links: {
crosssell: [{
id:"1202"
name: "mkproduct2"
status : "Enabled",
attribute_set : "Default"
sku: "mkproduct2"
price : "700.00"
thumbnail:
"[Link]
luma/en_US/Magento_Catalog/images/product/placeholder/[Link]"
position : 1
record_id : 38
}],
related: [{
id:"1202"
name: "mkproduct2"
status : "Enabled",
attribute_set : "Default"
sku: "mkproduct2"
price : "700.00"
thumbnail:
"[Link]
luma/en_US/Magento_Catalog/images/product/placeholder/[Link]"
position : 1
record_id : 38
}]
}
) {
status
message
data
}
}

12. Report Seller


Query :
Case 1. By Guest:
mutation ReportSeller {
reportSeller(
sellerId: 6,
reason: "test",
name: "test",
email: "test@[Link]"
) {
message
}
}

Case 2. By Seller Token:


mutation ReportSeller {
reportSeller(
sellerId: 6,
reason: "test"
) {
message
}
}

Response :
{
"data": {
"reportSeller": {
"message": "Seller Flag saved succesfully"
}
}
}

13. Report Product


Query :
Case 1. By Guest:
mutation ReportProduct {
reportProduct(
productId: 2149,
reason: "test"
) {
message
}
}

Case 2. By Seller Token:


mutation ReportProduct {
reportProduct(
productId: 2149
reason: "test"
name: "test user"
email: "wk@[Link]"
) {
message
}
}

Response :
Case 1. When Success:
{
"data": {
"reportProduct": {
"message": "Product Flag saved succesfully"
}
}
}

14. Seller Cancel Order


Query :
mutation SellerCancelOrder {
sellerCancelOrder(
orderId: 7
) {
message
status
}
}

Response :
Case 1. When Success:
{
"data": {
"reportProduct": {
"message": "The order has been cancelled."
"status": "success",
}
}
}

Case 2. When Not permission:


{
"data": {
"reportProduct": {
"message": "You are not permitted to cancel this order."
"status": "error",
}
}
}

15. Seller Create Credit Memo


Query :
mutation SellerCreateCreditmemo {
sellerCreateCreditmemo(
orderId: 2
invoiceId: 1
creditmemo: {
do_offline: true,
comment_text: "test",
is_visible_on_front: true,
items: {
qty: 1,
back_to_stock: true,
itemId: 1
}
send_email: true,
shipping_amount: 11,
adjustment_negative: 10,
adjustment_positive: 20,
comment_customer_notify: 1
}
) {
id
message
status
}
}

Response :
Case 1. When Success:
{
"data": {
"sellerCreateCreditmemo": {
"id": "10",
"message": "You created the credit memo."
"status": 1,
}
}
}

Case 2. When Failed:


{
"data": {
"sellerCreateCreditmemo": {
"message": "Invalid Request"
"status": 0,
}
}
}

16. Seller Mail To Admin


Query :
mutation SellerMailToAdmin {
sellerMailToAdmin(
query: "test121",
subject: "test data"
) {
message
}
}

Response :
{
"data": {
"sellerMailToAdmin": {
"message": "The message has been sent."
}
}
}

17. Seller Mail To Seller


Query :
mutation SellerMailToSeller {
sellerMailToSeller(
subject: "test121",
query: "test data",
productId: 7
) {
message
}
}

Response :
Case 1. When Success:
{
"data": {
"sellerMailToSeller": {
"message": "Mail sent successfully !!"
"status": "1"
}
}
}

Case 2. When Failed:


{
"data": {
"sellerMailToSeller": {
"message": "Invalid Request"
"status": "0"
}
}
}

18. Contact Seller By Seller Id


Query :
mutation ContactSellerBySellerId {
contactSellerBySellerId(
subject: "test11",
query: "sdasdas",
sellerId: 1
) {
message
}
}

Response :
Case 1. When Success:
{
"data": {
"contactSellerBySellerId": {
"message": "Mail sent successfully !!"
}
}
}

Case 2. When Failed:


{
"data": {
"contactSellerBySellerId": {
"message": "Invalid Seller"
}
}
}

19. Become Seller


Query :
mutation SellerBecomePartner {
sellerBecomePartner(
shopUrl: "test1",
isSeller: 1
) {
message
status
}
}

Response :
Case 1. When Success:
{
"data": {
"sellerBecomePartner": {
"message": "Profile information was successfully saved"
"status": "1"
}
}
}

Case 2. When Already:


{
"data": {
"SellerBecomePartner": {
"message": "already seller"
"status": "0"
}
}
}

Case 3. When ShopURL already exist:


{
"data": {
"SellerBecomePartner": {
"message": "Shop URL already exist please set another."
"status": "0"
}
}
}

20. Save Seller Profile


Query :
mutation SaveSellerProfile {
saveSellerProfile(
input: {
company_locality: "comlocagraphql",
# company_banner: { file_name: "[Link]"},
# company_logo: {file_name: "[Link]"},
#fulfil_image: {file_name: "[Link]"},
analytic_id: "analytic1",
facebook_id: "f1",
fb_active: "1",
instagram_active: "1",
instagram_id: "ins1",
meta_description: "md",
meta_keyword: "m1",
payment_source: "p1",
pinterest_active: "1",
pinterest_id: "p1",
privacy_policy: "priv1",
return_policy: "return1",
shipping_policy: "shop1",
shop_title: "st",
taxvat: "1234",
tw_active: "1",
twitter_id: "1",
vimeo_active: "1",
vimeo_id: "vimeoac1",
youtube_active: "1",
youtube_id: "youtun1",
moleskine_active: "1",
moleskine_id: "testmok",
tiktok_active: "1",
low_stock_quantity:100,
company_description:"dis",
fulfilment_text:"fulfil"
tiktok_id: "tik2"}
)
{
message
status
}}

{
"data": {
"saveSellerProfile": {
"message": "Seller Profile Saved Successfully",
"status": true
}
}
}

21. Delete Seller Product


Query :
mutation DeleteSellerProducts {
deleteSellerProducts(
productIds: [1]
) {
message
status
}
}

Response :
Case 1. When Failed:
{
"data": {
"deleteSellerProducts": {
"message": "Not Deleted",
"status": false
}
}
}

Case 2. When Success:


{
"data": {
"deleteSellerProducts": {
"message": "Products are successfully deleted from your account.",
"status": true
}
}
}

21. API to get store configuration data

Query:

query{
storeConfig {
marketplace_general_settings_admin_name
marketplace_min_order_settings_min_order_status
marketplace_min_order_settings_amount
marketplace_min_order_settings_for_seller
marketplace_profile_settings_seller_profile_display
marketplace_profile_settings_profile_type
marketplace_profile_settings_banner
marketplace_profile_settings_card_type
marketplace_profile_settings_activecolorpicker
marketplace_profile_settings_seller_policy_approval
marketplace_profile_settings_url_rewrite
marketplace_profile_settings_auto_url_rewrite
marketplace_profile_settings_vendor_featured

marketplace_review_settings_review_status
marketplace_layered_navigation_enable
marketplace_layered_navigation_admin_name
marketplace_sitemap_enable
marketplace_sitemap_allow_profile_url
marketplace_sitemap_profile_url_changefreq
marketplace_sitemap_profile_url_priority
marketplace_sitemap_allow_collection_url
marketplace_sitemap_collection_url_changefreq
marketplace_sitemap_collection_url_priority

marketplace_producthint_settings_product_hint_status
marketplace_producthint_settings_product_category
marketplace_producthint_settings_product_name
marketplace_producthint_settings_product_des
marketplace_producthint_settings_product_sdes
marketplace_producthint_settings_product_sku
marketplace_producthint_settings_product_sku
marketplace_producthint_settings_product_price
marketplace_producthint_settings_product_sprice
marketplace_producthint_settings_product_sdate
marketplace_producthint_settings_product_edate
marketplace_producthint_settings_product_qty
marketplace_producthint_settings_product_stock
marketplace_producthint_settings_product_tax
marketplace_producthint_settings_product_weight
marketplace_producthint_settings_product_image
marketplace_producthint_settings_product_enable

marketplace_profilehint_settings_profile_hint_status
marketplace_profilehint_settings_become_seller
marketplace_profilehint_settings_shopurl_seller
marketplace_profilehint_settings_profile_tw
marketplace_profilehint_settings_profile_fb
marketplace_profilehint_settings_profile_inst
marketplace_profilehint_settings_profile_google
marketplace_profilehint_settings_profile_youtube
marketplace_profilehint_settings_profile_vimeo
marketplace_profilehint_settings_profile_pin
marketplace_profilehint_settings_profile_cn
marketplace_profilehint_settings_profile_bc
marketplace_profilehint_settings_profile_shop
marketplace_profilehint_settings_profile_banner
marketplace_profilehint_settings_profile_logo
marketplace_profilehint_settings_profile_loc
marketplace_profilehint_settings_profile_desciption
marketplace_profilehint_settings_returnpolicy
marketplace_profilehint_settings_shippingpolicy
marketplace_profilehint_settings_profile_country
marketplace_profilehint_settings_profile_meta
marketplace_profilehint_settings_profile_mdesc
marketplace_profilehint_settings_profile_bank
marketplace_profilehint_settings_profile_tax
}
}

Response:

{
"data": {
"storeConfig": {
"marketplace_general_settings_admin_name": "Admin",
"marketplace_min_order_settings_min_order_status": null,
"marketplace_min_order_settings_amount": null,
"marketplace_min_order_settings_for_seller": null,
"marketplace_profile_settings_seller_profile_display": "1",
"marketplace_profile_settings_profile_type": "1",
"marketplace_profile_settings_banner": "default/[Link]",
"marketplace_profile_settings_card_type": "1",
"marketplace_profile_settings_activecolorpicker": "0",
"marketplace_profile_settings_seller_policy_approval": "1",
"marketplace_profile_settings_url_rewrite": "1",
"marketplace_profile_settings_auto_url_rewrite": "0",
"marketplace_profile_settings_vendor_featured": "1",
"marketplace_review_settings_review_status": "0",
"marketplace_layered_navigation_enable": "0",
"marketplace_layered_navigation_admin_name": "Admin",
"marketplace_sitemap_enable": null,
"marketplace_sitemap_allow_profile_url": null,
"marketplace_sitemap_profile_url_changefreq": "daily",
"marketplace_sitemap_profile_url_priority": "0.5",
"marketplace_sitemap_allow_collection_url": "1",
"marketplace_sitemap_collection_url_changefreq": "daily",
"marketplace_sitemap_collection_url_priority": "0.5",
"marketplace_producthint_settings_product_hint_status": "1",
"marketplace_producthint_settings_product_category": "test",
"marketplace_producthint_settings_product_name": "test",
"marketplace_producthint_settings_product_des": "test",
"marketplace_producthint_settings_product_sdes": "test",
"marketplace_producthint_settings_product_sku": "test",
"marketplace_producthint_settings_product_price": "test",
"marketplace_producthint_settings_product_sprice": null,
"marketplace_producthint_settings_product_sdate": null,
"marketplace_producthint_settings_product_edate": null,
"marketplace_producthint_settings_product_qty": "test",
"marketplace_producthint_settings_product_stock": "test",
"marketplace_producthint_settings_product_tax": "test",
"marketplace_producthint_settings_product_weight": "test",
"marketplace_producthint_settings_product_image": "test",
"marketplace_producthint_settings_product_enable": "test",
"marketplace_profilehint_settings_profile_hint_status": "0",
"marketplace_profilehint_settings_become_seller": null,
"marketplace_profilehint_settings_shopurl_seller": null,
"marketplace_profilehint_settings_profile_tw": null,
"marketplace_profilehint_settings_profile_fb": null,
"marketplace_profilehint_settings_profile_inst": null,
"marketplace_profilehint_settings_profile_google": null,
"marketplace_profilehint_settings_profile_youtube": null,
"marketplace_profilehint_settings_profile_vimeo": null,
"marketplace_profilehint_settings_profile_pin": null,
"marketplace_profilehint_settings_profile_cn": null,
"marketplace_profilehint_settings_profile_bc": null,
"marketplace_profilehint_settings_profile_shop": null,
"marketplace_profilehint_settings_profile_banner": null,
"marketplace_profilehint_settings_profile_logo": null,
"marketplace_profilehint_settings_profile_loc": null,
"marketplace_profilehint_settings_profile_desciption": null,
"marketplace_profilehint_settings_returnpolicy": null,
"marketplace_profilehint_settings_shippingpolicy": null,
"marketplace_profilehint_settings_profile_country": null,
"marketplace_profilehint_settings_profile_meta": null,
"marketplace_profilehint_settings_profile_mdesc": null,
"marketplace_profilehint_settings_profile_bank": null,
"marketplace_profilehint_settings_profile_tax": null
}
}
}

22. Seller Dashboard API

Query :

query SellerDashboard {
sellerDashboard {
title
seller_report(duration: {from: "2024-08-28", to: "2024-08-28"}) {
seller_order {
graphx_value
graph_data
total_order
processing_order
complete_order
cancelled_order
percent_compare
}
topselling_product {
name
url
qty
image
}
top_customer {
total_top_customer
percent_compare
top_customer_data {
customer_base_total
order_count
name
email
billing_telephone
}
}
top_category {
id
percentage
category
}
sale_data {
graphx_value
graph_data
total_sale
total_sale_amount
total_payout
remaining_payout
commission_paid
percent_compare
}
average_order_value {
graphx_value
graph_data
avg_order_value
avg_order_value_formatted
percent_compare
}
}
seller_activity {
latest_order {
mageproduct_id
created_at
status
actual_seller_amount
shipping_address
images {
image
name
qty
}
}
seller_activity_notification {
message
date
}
seller_latest_review_comment {
comment
price
value
quality
name
created_at
}
seller_rating {
price_percent {
star5
star4
star3
star2
star1
}
value_percent {
star5
star4
star3
star2
star1
}
quality_percent {
star5
star4
star3
star2
star1
}
}
}
}
}

Response:

{
"data": {
"sellerDashboard": {
"title": [
"Seller Report",
"Seller Activities"
],
"seller_report": {
"seller_order": {
"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\"]",
"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,7,34,6,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]",
"total_order": 47,
"processing_order": 8,
"complete_order": 16,
"cancelled_order": 12,
"percent_compare": 100
},
"topselling_product": [
{
"name": "mkproduct1",
"url": "[Link]
"qty": 50,
"image":
"[Link]
[Link]"
},
{
"name": "mkproduct2",
"url": "[Link]
"qty": 3,
"image":
"[Link]
[Link]"
},
{
"name": "product3",
"url": "[Link]
"qty": 1,
"image":
"[Link]
[Link]"
}
],
"top_customer": {
"total_top_customer": 1,
"percent_compare": 100,
"top_customer_data": [
{
"customer_base_total": "$7,088.00",
"order_count": 45,
"name": "Ragini Dwivedi",
"email": "raginidwivedi.mg368@[Link]",
"billing_telephone": "08976567890"
}
]
},
"top_category": [
{
"id": 2,
"percentage": 100,
"category": "Default Category"
}
],
"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\"]",
"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,\"120.0000\",\"3460.0000\",\"1480.0000\",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]",
"total_sale": "$5,060.00",
"total_sale_amount": "5060",
"total_payout": "$96.00",
"remaining_payout": "$3,472.00",
"commission_paid": "$24.00",
"percent_compare": 100
},
"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\"]",
"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,96,159.52941176471,197.33333333333,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]",
"avg_order_value": "154.89361702128",
"avg_order_value_formatted": "$154.89",
"percent_compare": 100
}
},
"seller_activity": {
"latest_order": [
{
"mageproduct_id": "000000048",
"created_at": "2024-10-17 [Link]",
"status": "complete",
"actual_seller_amount": 800,
"shipping_address": "street,merut,272155",
"images": [
{
"image":
"[Link]
[Link]",
"name": "mkproduct2",
"qty": 1
}
]
},
{
"mageproduct_id": "000000047",
"created_at": "2024-10-17 [Link]",
"status": "closed",
"actual_seller_amount": 96,
"shipping_address": "street,merut,272155",
"images": [
{
"image":
"[Link]
[Link]",
"name": "mkproduct2",
"qty": 1
}
]
},
{
"mageproduct_id": "000000046",
"created_at": "2024-10-17 [Link]",
"status": "canceled",
"actual_seller_amount": 0,
"shipping_address": "street,merut,272155",
"images": [
{
"image":
"[Link]
[Link]",
"name": "mkproduct2",
"qty": 1
}
]
},
{
"mageproduct_id": "000000041",
"created_at": "2024-10-16 [Link]",
"status": "pending",
"actual_seller_amount": 656,
"shipping_address": "street,merut,272155",
"images": [
{
"image":
"[Link]
[Link]",
"name": "mkproduct2",
"qty": 1
}
]
},
{
"mageproduct_id": "000000040",
"created_at": "2024-10-16 [Link]",
"status": "complete",
"actual_seller_amount": 96,
"shipping_address": "street,merut,272155",
"images": [
{
"image":
"[Link]
[Link]",
"name": "mkproduct2",
"qty": 1
}
]
},
{
"mageproduct_id": "000000039",
"created_at": "2024-10-16 [Link]",
"status": "processing",
"actual_seller_amount": 96,
"shipping_address": "street,merut,272155",
"images": [
{
"image":
"[Link]
[Link]",
"name": "mkproduct2",
"qty": 1
}
]
},
{
"mageproduct_id": "000000038",
"created_at": "2024-10-16 [Link]",
"status": "canceled",
"actual_seller_amount": 96,
"shipping_address": "street,merut,272155",
"images": [
{
"image":
"[Link]
[Link]",
"name": "mkproduct2",
"qty": 1
}
]
},
{
"mageproduct_id": "000000004",
"created_at": "2024-10-15 [Link]",
"status": "pending",
"actual_seller_amount": 96,
"shipping_address": "street,merut,272155",
"images": [
{
"image":
"[Link]
[Link]",
"name": "mkproduct1",
"qty": 1
}
]
},
{
"mageproduct_id": "000000003",
"created_at": "2024-10-15 [Link]",
"status": "pending",
"actual_seller_amount": 96,
"shipping_address": "CompanyName,Green str, 67,CityM,Alabama,22290",
"images": [
{
"image":
"[Link]
[Link]",
"name": "mkproduct1",
"qty": 1
}
]
}
],
"seller_activity_notification": [
{
"message": "shreya pandey gives 4.3 star rating.",
"date": "08 November 24 [Link]"
},
{
"message": "You have recieved payment for #000000008 order. Mode of
payment is Manual.",
"date": "15 October 24 [Link]"
}
],
"seller_latest_review_comment": [
{
"comment": "testing seller review test",
"price": 5,
"value": 4,
"quality": 4,
"name": "shreya pandey",
"created_at": "2024-11-08 [Link]"
}
],
"seller_rating": {
"price_percent": {
"star5": 100,
"star4": 0,
"star3": 0,
"star2": 0,
"star1": 0
},
"value_percent": {
"star5": 0,
"star4": 100,
"star3": 0,
"star2": 0,
"star1": 0
},
"quality_percent": {
"star5": 0,
"star4": 100,
"star3": 0,
"star2": 0,
"star1": 0
}
}
}
}
}
}
23. Get seller's order list

Query:

query SellerOrdersList {
sellerOrdersList(filter: {
type: "all/pending/processing/cancelled/holded/closed/complete", #required
pageSize:5
curPage:1
order_id: "magerealorder_id", #optional
customer_name: "Firstname Lastname", #optional
purchase_from: "01-09-2024", #optional
puchase_to: "17-09-2024", #optional
status: "status" #optional
}
) {
order {
count
label
}
items {
order_id
purchased_on
purchase_total {
amount
amount_formatted
}
base_total {
amount
amount_formatted
}
products {
name
url
ordered
invoiced
shipped
cancelled
refunded
}
customer
status
order_id
}
}
}

Response:

{
"data": {
"sellerOrdersList": {
"order": [
{
"count": "53",
"label": "All Orders"
},
{
"count": "30",
"label": "Pending"
},
{
"count": "3",
"label": "Processing"
},
{
"count": "0",
"label": "On Hold"
},
{
"count": "12",
"label": "Complete"
},
{
"count": "5",
"label": "Closed"
},
{
"count": "3",
"label": "Canceled"
}
],
"items": [
{
"order_id": "000000093",
"purchased_on": "2024-12-12 [Link]",
"purchase_total": {
"amount": 855.855,
"amount_formatted": "€855.86"
},
"base_total": {
"amount": 900.9,
"amount_formatted": "$900.90"
},
"products": [
{
"product_id": "1623",
"name": null,
"url": "[Link]
[Link]",
"ordered": 1,
"invoiced": null,
"shipped": null,
"cancelled": null,
"refunded": null
}
],
"customer": "Ragini123 Dwivedi",
"status": "Pending",
"entity_id": 102
}
]
}
}
}
24. Get seller order view data

Query:

query sellerOrderView {
sellerOrderView(id: 77) {
order_id
status
date
can_invoice
can_ship
can_cancel
can_refund
items {
product_name
sku
price
tax_amount
tax_amount_formatted
discount_amount
discount_amount_formatted
price_formatted
price_formatted
qty {
ordered
shipped
invoiced
cancelled
}
admin_commission
admin_commission_formatted
vendor_total
vendor_total_formatted
subtotal
subtotal_formatted
}
subtotal {
title
value
value_formatted
}
total_vendor_amount {
title
value
value_formatted
}
total_admin_commision {
title
value
value_formatted
}
total_ordered_amount {
title
value
value_formatted
}
tax {
title
value
value_formatted
}
discount {
title
value
value_formatted
}
buyer_data {
title
name_label
name_value
email_label
email_value
}
order_info {
title
shipping_address {
title
address {
country_code
firstname
lastname
middlename
region
region_id
country_code
street
postcode
city
telephone
}
}
shipping_method {
title
method
}
billing_address {
title
address {
country_code
firstname
lastname
middlename
region
region_id
country_code
street
postcode
city
telephone
}
}
payment_method {
title
method
}
}
}
}

Response:
{
"data": {
"sellerOrderView": {
"order_id": "000000004",
"status": "Processing",
"date": "2024-12-24 [Link]",
"can_invoice": true,
"can_ship": true,
"can_cancel": true,
"can_refund": false,
"items": [
{
"product_name": "product1",
"sku": "product1",
"tax_amount": "0.0000",
"tax_amount_formatted": "$0.00",
"discount_amount": "0.0000",
"discount_amount_formatted": "$0.00",
"price_formatted": "$700.00",
"price": "700",
"qty": {
"ordered": 5,
"shipped": 1,
"invoiced": 1,
"cancelled": 0
},
"admin_commission": "560.0000",
"admin_commission_formatted": "$560.00",
"vendor_total": "2240.0000",
"vendor_total_formatted": "$2,240.00",
"subtotal": "3500.0000",
"subtotal_formatted": "$3,500.00"
}
],
"subtotal": {
"title": "Subtotal",
"value": "3500",
"value_formatted": "$3,500.00"
},
"total_vendor_amount": {
"title": "Total Vendor Amount",
"value": "2240",
"value_formatted": "$2,240.00"
},
"total_admin_commision": {
"title": "Total Admin Commission",
"value": "560",
"value_formatted": "$560.00"
},
"total_ordered_amount": {
"title": "Total Ordered Amount",
"value": "3500",
"value_formatted": "$3,500.00"
},
"tax": {
"title": "Total Tax",
"value": "0",
"value_formatted": "$0.00"
},
"discount": {
"title": "Discount",
"value": "0",
"value_formatted": "$0.00"
},
"buyer_data": {
"title": "Buyer Information",
"name_label": "Customer Name",
"name_value": "John Smith",
"email_label": "Email",
"email_value": "raginidwivedi.mg368@[Link]"
},
"order_info": {
"title": "Order Information",
"shipping_address": {
"title": "Shipping Address",
"address": {
"country_code": "TR",
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"region": null,
"region_id": "0",
"street": [
"street"
],
"postcode": "272155",
"city": "merut",
"telephone": "08976567890"
}
},
"shipping_method": {
"title": "Shipping Information",
"method": "Flat Rate - Fixed"
},
"billing_address": {
"title": "Billing Address",
"address": {
"country_code": "TR",
"firstname": "John",
"lastname": "Smith",
"middlename": null,
"region": null,
"region_id": null,
"street": [
"street"
],
"postcode": "272155",
"city": "merut",
"telephone": "08976567890"
}
},
"payment_method": {
"title": "Payment Method",
"method": "Check / Money order"
}
}
}
}
}
[Link]: If the order id does not belongs to the current seller

{
"errors": [
{
"message": "You dont have permission to view this order.",
"locations": [
{
"line": 12,
"column": 3
}
],
"path": [
"sellerOrderView"
],
"extensions": {
"category": "graphql-authorization"
}
}
],
"data": {
"sellerOrderView": null
}
}

[Link] order mail to customer by seller

Query:

mutation sendOrderMailToCustomer {
sendOrderMailToCustomer(orderId:69) {
message
status
}
}

Response:

{
"data": {
"sendOrderMailToCustomer": {
"message": "You sent the order email.",
"status": true
}
}
}

25. Seller Invoice List API

Query:
query SellerInvoiceList {
sellerInvoiceList(
orderId:49 #required
pageSize:10 #required
curPage:1 #required
) {
items {
invoice_id
bill_to_name
created_at
status
amount
view
}
}
}

Response:

{
"data": {
"sellerInvoiceList": {
"items": [
{
"invoice_id": 41,
"bill_to_name": "Ragini Dwivedi",
"created_at": "2024-10-17 [Link]",
"status": "Paid",
"amount": "$1,000.00",
"view": "marketplace/order_invoice/view/order_id/49/invoice_id/41"
}
]
}
}
}

26. Seller Shipment List API

query SellerShipmentList {
sellerShipmentList(
orderId:49 #required
pageSize:10 #required
curPage:1 #required
) {
items {
shipment_id
ship_to_name
ship_date
quantity
entity_id
}
}
}

Response:

{
"data": {
"sellerShipmentList": {
"items": [
{
"shipment_id": "000000004",
"ship_to_name": "John Smith",
"ship_date": "2024-12-24 [Link]",
"quantity": 1,
"entity_id": 4
}
]
}
}
}

26. Seller Creditmemo List API

Query:
query SellerCreditmemoList {
sellerCreditmemoList(
orderId:49 #required
pageSize:10 #required
curPage:1 #required
) {
items {
creditmemo_id
bill_to_name
created_at
status
amount
view
}
}
}

Response:

{
"data": {
"sellerCreditmemoList": {
"items": [
{
"creditmemo_id": "000000003",
"bill_to_name": "Ragini Dwivedi",
"created_at": "2024-11-08 [Link]",
"status": "Refunded",
"amount": "$1,000.00",
"view": "marketplace/order_creditmemo/view/order_id/49/creditmemo_id/3"
}
]
}
}
}

27. Get seller's customer

Query:

#Filter,pageSize and currentPage is optional.


query sellerCustomer {
sellerCustomer(
filter :"{\"name\":\"test
test2\",\"email\":\"\",\"billing_telephone\":\"\",\"billing_full\":\"\"}"
pageSize:2,currentPage:1) {
total_count
customer_data {
name
email
contact_number
gender
address
base_total
base_total
order_count
order_link
}
}
}

Response:

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

28. Seller Transaction List

Query:

query sellerTransactions {
sellerTransactions(
filter: {
pageSize:1 #(optional)
curPage:1 #(optional)
#id_from:1 #(optional)
#id_to:5 #(optional)
#transaction_id:"tr-d6jS54OB1h4" #(optional)
#purchased_on_from:"01-09-2024" #(optional)
#puchased_on_to:"02-10-2024" #(optional)
}
) {
total_seller_earning
total_seller_earning_formatted
total_sale
total_sale_formatted
tax
tax_formatted
commission
commission_formatted
total_payout
total_payout_formatted
remaining_payout
remaining_payout_formatted
button_show
tax
items {
id
purchased_on
transaction_amount
transaction_amount_formatted
transaction_id
message
}
}
}

Response:
{
"data": {
"sellerTransactions": {
"total_seller_earning": "560",
"total_seller_earning_formatted": "$560.00",
"total_sale": "700",
"total_sale_formatted": "$700.00",
"tax": "0",
"tax_formatted": "$0.00",
"commission": "140.0000",
"commission_formatted": "$140.00",
"total_payout": "560.0000",
"total_payout_formatted": "$560.00",
"remaining_payout": "0.0000",
"remaining_payout_formatted": "$0.00",
"button_show": false,
"items": [
{
"id": "1",
"purchased_on": "2024-12-24 [Link]",
"transaction_amount": "2800.0000",
"transaction_amount_formatted": "$2,800.00",
"transaction_id": "tr-LGOsaFU3y3h",
"message": "DVSVS"
},
{
"id": "2",
"purchased_on": "2024-12-26 [Link]",
"transaction_amount": "560.0000",
"transaction_amount_formatted": "$560.00",
"transaction_id": "tr-K9uP6BXTxny",
"message": "test"
}
]
}
}
}

[Link] transaction View

Query:
query sellerTransactionView {
sellerTransactionView(
id:1 #(required)
) {
transaction_id
transaction_info {
date
amount
amount_formatted
type
comment_message
method
}
transaction_order_info {
order_id
product_name
price
price_formatted
qty
total_price
total_price_formatted
total_tax
total_tax_formatted
total_discount
total_discount_formatted
total_shipping
total_shipping_formatted
total_commission
total_commission_formatted
subtotal
}
}
}

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

[Link] Earning API


Query:

query sellerEarnings {
sellerEarnings(filter:{
period: "day", #required ("day","month","year")
from: "2024-07-01",
to: "2024-10-22",
page_size:20,
cur_page:1
}) {
datasets
labels
total_count
items {
interval
orders
total_amount
total_earnings
total_discount_amount
admin_commision
}
}
}

Response:

When period value is set as "day" -


{
"data": {
"sellerEarnings": {
"datasets": "[672,5434,1184]",
"labels": "[\"15\\/10\\/2024\",\"16\\/10\\/2024\",\"17\\/10\\/2024\"]",
"total_count": 3,
"items": [
{
"interval": "Oct 15, 2024",
"orders": 7,
"total_amount": "$840.00",
"total_earnings": "$672.00",
"total_discount_amount": "$0.00",
"admin_commision": "$168.00"
},
{
"interval": "Oct 16, 2024",
"orders": 34,
"total_amount": "$6,780.00",
"total_earnings": "$5,424.00",
"total_discount_amount": "$0.00",
"admin_commision": "$1,356.00"
},
{
"interval": "Oct 17, 2024",
"orders": 6,
"total_amount": "$1,480.00",
"total_earnings": "$1,184.00",
"total_discount_amount": "$0.00",
"admin_commision": "$296.00"
}
]
}
}
}

When period value is set as "month"-

{
"data": {
"sellerEarnings": {
"datasets": "[7290]",
"labels": "[\"10\\/2024\"]",
"total_count": 1,
"items": [
{
"interval": "10/2024",
"orders": 47,
"total_amount": "$9,100.00",
"total_earnings": "$7,280.00",
"total_discount_amount": "$0.00",
"admin_commision": "$1,820.00"
}
]
}
}
}

When period value is set as "year"-

{
"data": {
"sellerEarnings": {
"datasets": "[7290]",
"labels": "[\"2024\"]",
"total_count": 1,
"items": [
{
"interval": "2024",
"orders": 47,
"total_amount": "$9,100.00",
"total_earnings": "$7,280.00",
"total_discount_amount": "$0.00",
"admin_commision": "$1,820.00"
}
]
}
}
}

[Link] to save SellerPdf Header Info

Mutation:

mutation savePdfHeaderInfo {
savePdfHeaderInfo(othersInfo:"test") {
message
status
}
}

Response:

{
"data": {
"savePdfHeaderInfo": {
"message": "Information has been saved successfully",
"status": true
}
}
}

32. Api to get Pdf header Info


Query:

query getPdfHeaderInfo {
getPdfHeaderInfo {
data
}
}

Response:

{
"data": {
"getPdfHeaderInfo": {
"data": "test"
}
}
}

[Link] Review list API

query SellerSelfReviewList {
sellerSelfReviewList(
filter:{ #filter is 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:"test reviewtest review"
# customer_name:"John Smith"
# status:1

}) {
total_count
items {
id
price_rating
value_rating
quality_rating
feed_summary
feed_review
customer_name
status
created_at
}

}
}

Response:

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

[Link] seller allowed product attribute set

Query:

query sellerProductAttributeSet{
sellerProductAttributeSet {
value
label
}
}

Response:

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

35. Get seller's allowed product type list

Query:

query SellerAllowedProductType {
sellerAllowedProductType {
value
label
}
}

Response:

{
"data": {
"sellerAllowedProductType": [
{
"value": "simple",
"label": "Simple"
},
{
"value": "downloadable",
"label": "Downloadable"
},
{
"value": "virtual",
"label": "Virtual"
},
{
"value": "configurable",
"label": "Configurable"
}
]
}
}
[Link] published news for seller Api
Query:
//If page size and curPage value is not given then maximum 4 items will get in the
repsonse

query sellerPublishedNewsList {
sellerPublishedNewsList(
pageSize:1
curPage:1
) {

total_count
name
items {
id
content
created_at
read_status
}
}
}

Response:

{
"data": {
"sellerPublishedNewsList": {
"total_count": 2,
"name": "Admin",
"items": [
{
"id": 3,
"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>",
"created_at": "2024-10-17 [Link]",
"read_status": 1
}
]
}
}
}
[Link] Mark news read Api.

Mutation:

mutation markNewsRead {
markNewsRead(
id:1 #Pass id if you want to mark read to particular news
) {
message
status
}
}

Response:

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

38. Save seller shop Url Data

Mutation :

mutation SellerSaveShopUrl {
sellerSaveShopUrl(input: {
profile_request_url: "test2",
collection_request_url: "test3",
review_request_url: "test4",
location_request_url: "test5",
policy_request_url: "test6"}) {
message
status
}
}

Response:

{
"data": {
"sellerSaveShopUrl": {
"message": "The URL Rewrite has been saved",
"status": true
}
}
}

[Link] seller shop Url Data

Query:

query SellerGetShopUrl {
sellerGetShopUrl {
profile_target_url
profile_request_url
collection_target_url
collection_request_url
review_target_url
review_request_url
location_target_url
location_request_url
policy_request_url
}
}

Response:

{
"data": {
"sellerGetShopUrl": {
"profile_target_url": "dvfdv",
"profile_request_url": "d1",
"collection_target_url": "dvfdv",
"collection_request_url": "d2",
"review_target_url": "dvfdv",
"review_request_url": "d3",
"location_target_url": "dvfdv",
"location_request_url": "d4",
"policy_request_url": "d5"
}
}
}

Seller configurable product attribute related Api


40. Delete attribute by attribute Id

Mutation:
mutation deleteSellerConfigAttribute {
deleteSellerConfigAttribute
(id:243 #required
) {
message
status
}
}

Response:

{
"data": {
"deleteSellerConfigAttribute": {
"message": "Attribute has been successfully deleted",
"status": true
}
}
}

[Link] Listing Api:

//filter is optional
query sellerConfigAttrList {
sellerConfigAttrList(
filter:{
page_size:30
cur_page:1
attribute_code:"mkcolor"
# frontend_label:"Color"
# attribute_id:93
# is_required:1
# is_user_defined:1
# is_visible:1
# is_searchable:1
# is_comparable:1
}
) {
total_count
items {
attribute_id
attribute_code
frontend_label
is_required
is_user_defined
is_visible
scope
is_searchable
is_comparable
action {
edit
delete
}
}
}
}

Response:

{
"data": {
"sellerConfigAttrList": {
"total_count": 1,
"items": [
{
"attribute_id": 243,
"attribute_code": "mkcolor",
"frontend_label": "mkcolor",
"is_required": true,
"is_user_defined": true,
"is_visible": true,
"scope": "Global",
"is_searchable": false,
"is_comparable": false,
"action": {
"edit": "marketplace/product_attribute/new/attribute_id/243",
"delete": "marketplace/product_attribute/delete/attribute_id/243"
}
}
]
}
}
}
[Link] config Attrbute create Api

mutation addConfigAttribute {
addConfigAttribute(
attributeCode:"gtre"
attributeLabel:"sdfsd"
valRequired:true
attroptions : [
{
admin:"red"
store:"red1"
},
{
admin:"blue"
store:"blue1"
}
]
default:1 #Index of attroptions array which you want to set as default
) {
message
status
}
}

Response:

{
"data": {
"addConfigAttribute": {
"message": "Attribute has been updated sucessfully",
"status": true
}
}
}

43. Edit Seller Config Attribute Api

Pass one extra param attributeId in case you want to edit the attribute

Mutation:

mutation addConfigAttribute {
addConfigAttribute(
attributeId: 208
attributeCode:"gtre"
attributeLabel:"sdfsd"
valRequired:true
attroptions : [
{
admin:"red"
store:"red1"
},
{
admin:"blue"
store:"blue1"
}
]
default:1 #Index of attroptions array which you want to set as default
) {
message
status
}
}
Response:
{
"data": {
"addConfigAttribute": {
"message": "Attribute has been updated sucessfully",
"status": true
}
}
}

44. Get Seller Config Attribute Information by Attribute Id

Query:

query getConfigAttrDataById{
getConfigAttrDataById(
attributeId:243 #required
) {
attribute_code
attribute_label
frontend_input
val_required
default_value
store_options
options
}
}

Response:

{
"data": {
"getConfigAttrDataById": {
"attribute_code": "gtre",
"attribute_label": "sdfsd",
"frontend_input": "select",
"val_required": "1",
"default_value": "294,292",
"store_options": [
"blue1",
"blue1",
"red1",
"red1"
],
"options": "{\"totalRecords\":4,\"items\":
[{\"option_id\":\"292\",\"attribute_id\":\"243\",\"sort_order\":\"0\",\"value\":\"b
lue\"},
{\"option_id\":\"294\",\"attribute_id\":\"243\",\"sort_order\":\"0\",\"value\":\"bl
ue\"},
{\"option_id\":\"291\",\"attribute_id\":\"243\",\"sort_order\":\"0\",\"value\":\"re
d\"},
{\"option_id\":\"293\",\"attribute_id\":\"243\",\"sort_order\":\"0\",\"value\":\"re
d\"}]}"
}
}
}

Seller Draft product related Api

[Link] product listing Api


Query:

query SellerDraftProductList {
sellerDraftProductList(
filter:{ #optional
page_size:10
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
}) {
total_count
items {
id
name
sku
price
qty
created_at
action {
edit
delete
}
}

}
}

Response:

{
"data": {
"sellerDraftProductList": {
"total_count": 2,
"items": [
{
"id": 4,
"name": "draftmk1",
"sku": "new-shoes-p2",
"price": "1000.0000",
"qty": 10,
"created_at": "2024-11-08 [Link]",
"action": {
"edit": "marketplace/product/addset/4/type/simple/draft_id/4",
"delete": "marketplace/product/deletedraftproductdraft_id/4"
}
},
{
"id": 5,
"name": "draftmk1",
"sku": "new-shoes-p3",
"price": "1000.0000",
"qty": 10,
"created_at": "2024-11-08 [Link]",
"action": {
"edit": "marketplace/product/addset/4/type/simple/draft_id/5",
"delete": "marketplace/product/deletedraftproductdraft_id/5"
}
}
]
}
}
}

[Link] Draft Product:

Mutation:

mutation deleteDraftProduct {
deleteDraftProduct(
id:2 #required
) {
message
status
}
}

Response:

{
"data": {
"deleteDraftProduct": {
"message": "Draft Product has been successfully deleted",
"status": true
}
}
}

47. Create draft product:

mutation sellerAddDraftProduct {
sellerAddDraftProduct(
type: "simple",
# draftProductId:53, //It is required in case of editing draft product data.
set: 4,
product:
{
category_ids:[],
special_price:50
short_description:"",
description: "Draft marketplace 1",
name: "draftmk1",
price: 1000,
special_from_date:"10/03/2024"
special_to_date:"20/12/2024"
mp_product_cart_limit:10
meta_title:"",
meta_keyword:"",
meta_description:"",
tax_class_id:12,
product_has_weight:12,
url_key:"testdraft1"
quantity_and_stock_status: {is_in_stock: 1, qty: 10},
sku: "new-shoes-p3",
stock_data: {manage_stock: 1,
use_config_manage_stock: 0},
visibility: 4,
# image: "wk/product/1630126432/image/[Link]",
# thumbnail: "wk/product/1630126432/image/[Link]",
# small_image: "wk/product/1630126432/image/[Link]",
# swatch_image: "wk/product/1630126432/image/[Link]",
# media_gallery:
# {images: [
# {file: "wk/product/1630126432/image/[Link]",
# label: "Webkul Mug",
# position:1,
# media_type: "image",
# disabled:0,
# value_id: "", removed: "0"},
# {file: "wk/product/1630126432/image/[Link]",
# label: "Webkul Mug",
# position:1,
# media_type: "image",
# disabled:0,
# value_id: "", removed: "0"}

# ]}
}

) {
status
message
data
}
}

Response:

{
"data": {
"sellerAddDraftProduct": {
"status": true,
"message": "The draft product has been successfully created",
"data": null
}
}
}

48. Edit draft product data:

Pass extra field draftProductId in the sellerAddDraftProduct Api to edit the draft
product.

[Link] draft product info by draft Id

Query:
query sellerDraftProductInfoById {
sellerDraftProductInfoById(
draftId:70 #required
) {
name
sku
price
qty
content
created_at
}
}

Response:

{
"data": {
"sellerDraftProductInfoById": {
"name": "draftmk1",
"sku": "new-shoes-p2",
"price": 1000,
"qty": 10,
"content": "{\"type\":\"simple\",\"set\":4,\"product\":{\"category_ids\":
[],\"description\":\"Draft marketplace
1\",\"meta_description\":\"\",\"meta_keyword\":\"\",\"meta_title\":\"\",\"mp_produc
t_cart_limit\":10,\"name\":\"draftmk1\",\"price\":1000,\"product_has_weight\":12,\"
quantity_and_stock_status\":
{\"is_in_stock\":1,\"qty\":10},\"short_description\":\"\",\"sku\":\"new-shoes-
p2\",\"special_from_date\":\"10\\/03\\/2024\",\"special_price\":50,\"special_to_dat
e\":\"20\\/12\\/2024\",\"stock_data\":
{\"manage_stock\":1,\"use_config_manage_stock\":0},\"tax_class_id\":12,\"url_key\":
\"testdraft1\",\"visibility\":4,\"fulfilled_by\":0,\"product_image\":[]},\"links\":
{\"related\":[],\"crosssell\":[],\"upsell\":[]}}",
"created_at": "2024-11-08 [Link]"
}
}
}

50. Save Draft product:

mutation saveDraftProduct {
saveDraftProduct(
draftId: 3 #required
) {
status
message
data
}
}

Response:

{
"data": {
"saveDraftProduct": {
"status": true,
"message": "Product Added Successfully",
"data": "{\"product_id\":\"1208\"}"
}
}
}

Seller product related Api

51. Get seller's product list

Query:
Params-
type : enable/disable/out_of_stock/pending/low_stock
pageSize: pageSize,
curPage:curPage

query SellerProductList {
sellerProductList(
type: "enable",
pageSize: 1,
curPage:1
filter: {
sku:"string"
type_id:"string" #simple,configurable,virtual,downloadable
created_from: "02-10-2024"
created_to: ""
deny_reason:"deny" #(only when type = "deny)
price_from:700 #(only when type ="enable")
price_to:1000 #(only when type ="enable")
visibility:4
name:"r1"
attribute_set_id:10
}

) {
total_enabled
total_disabled
total_low_stock
total_out_of_stock
total_denied
total_pending
items {
id
uid
name
sku
attribute_set_id
special_from_date
special_to_date
url_key
deny_reason {
reason
}
stock_status
type_id
price {
minimalPrice {
adjustments {
description
}
}
}
thumbnail {
url
label
position
disabled
}
price_range {
minimum_price {
regular_price {
value
currency
}
}
}
qty
qty_sold {
qty
link
}
qty_pending {
qty
}
qty_confirmed {
qty
}
product_status
}
}
}
Response:

{
"data": {
"sellerProductList": {
"total_enabled": 6,
"total_disabled": 1,
"total_low_stock": 5,
"total_out_of_stock": 0,
"total_denied": 1,
"total_pending": 0,
"items": [
{
"id": 1201,
"uid": "MTIwMQ==",
"name": "mkproduct1",
"sku": "mkproduct1",
"attribute_set_id": 4,
"special_from_date": null,
"special_to_date": null,
"url_key": "mkproduct1",
"deny_reason": {
"reason": "<p>dvgdsfvbdf</p>"
},
"stock_status": "IN_STOCK",
"type_id": "simple",
"price": {
"minimalPrice": {
"adjustments": []
}
},
"thumbnail": {
"url":
"[Link]
Magento/luma/en_US/Magento_Catalog/images/product/placeholder/[Link]",
"label": "mkproduct1",
"position": null,
"disabled": null
},
"price_range": {
"minimum_price": {
"regular_price": {
"value": 120,
"currency": "USD"
}
}
},
"qty": 60,
"qty_sold": {
"qty": 50,
"link": "marketplace/order/salesdetail/id/1201"
},
"qty_pending": {
"qty": 15
},
"qty_confirmed": {
"qty": 28
},
"product_status": "disabled"
}
]
}
}
}

[Link] image for product:

mutation UploadImage {
uploadImage(
type:#product(for uploading image for product),profile( for uploading image for
seller profile)
imageEncoded: "", #base64Image value of image
imageName: "Shoes new") {
file
message
status
url
}
}

[Link] to list related,cross sell and upsell products at seller end:

Query:

query relatedCrossUpsellList {
relatedCrossUpsellList(
filter:{
type:"related", #related,crosssell,upsell
product_id:1225 #(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:String
attribute_set_id:10
sku:String
product_type:"configurable"
#simple,configurable,virtual,downloadable,grouped,bundle
status:2

}
) {
total_count
items {
id
thumbnail
name
attribute_set
status
type
sku
price
related # get in case when type argument is "related"
upsell # get in case when type argument is "upsell"
crosssell # get in case when type argument is "crosssell"

}
}
}

Response:

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

54. Get seller's allowed product category list

Query:
query sellerAllowedProductCategory {
sellerAllowedProductCategory {
category_ids
}
}

Response:

query sellerAllowedProductCategory {
sellerAllowedProductCategory {
category_ids
}
}

55. Seller Create Order Shipment

mutation sellerCreateShipment {
sellerCreateShipment(
orderId:119
trackingId:"fdsgdfgdf"
carrier:"dfhgf"
shipment: {
comment_text: "testing12",
items:{ #optional (if items is not passed then shipment will be created of
all items)
qty: 1,
item_id: 136
}
,
send_email: true,
comment_customer_notify: true
is_visible_on_front:true
}
) {
message
status
}
}

Response:
{
"data": {
"sellerCreateShipment": {
"message": "The shipment has been created. The shipping label has been
created.",
"status": true
}
}
}

You might also like