Create or update marketplace listing
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"marketplace_id": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"marketplace_item_sku": "<string>",
"marketplace_category": [
"<string>"
],
"marketplace_attribute": [
{
"attribute_id": "<string>",
"attribute_value": "<string>"
}
],
"marketplace_pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1
}
],
"marketplace_product_id": "<string>",
"marketplace_variant_id": "<string>",
"marketplace_item_id": "<string>",
"marketplace_promotion": {
"promotion_type": "discount",
"starts_at": "<string>",
"details": [
{
"discount_type": "percentage",
"discount_percent": 123,
"customer_group_id": "<string>",
"minimum_quantity": 1,
"maximum_quantity": 123,
"maximum_discount_amount": 123
}
],
"expires_at": "<string>"
},
"marketplace_subscription": [
{
"subscription_plan": "<string>",
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"billing_trial_days": 0,
"fulfill_separately": true,
"subscription_price": [
{
"suscription_price": 123,
"minimum_quantity": 1,
"customer_group_id": "<string>"
}
],
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123
}
]
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings"
payload = {
"marketplace_id": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"marketplace_item_sku": "<string>",
"marketplace_category": ["<string>"],
"marketplace_attribute": [
{
"attribute_id": "<string>",
"attribute_value": "<string>"
}
],
"marketplace_pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1
}
],
"marketplace_product_id": "<string>",
"marketplace_variant_id": "<string>",
"marketplace_item_id": "<string>",
"marketplace_promotion": {
"promotion_type": "discount",
"starts_at": "<string>",
"details": [
{
"discount_type": "percentage",
"discount_percent": 123,
"customer_group_id": "<string>",
"minimum_quantity": 1,
"maximum_quantity": 123,
"maximum_discount_amount": 123
}
],
"expires_at": "<string>"
},
"marketplace_subscription": [
{
"subscription_plan": "<string>",
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"billing_trial_days": 0,
"fulfill_separately": True,
"subscription_price": [
{
"suscription_price": 123,
"minimum_quantity": 1,
"customer_group_id": "<string>"
}
],
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
marketplace_id: '<string>',
product_id: '<string>',
variant_id: '<string>',
marketplace_item_sku: '<string>',
marketplace_category: ['<string>'],
marketplace_attribute: [{attribute_id: '<string>', attribute_value: '<string>'}],
marketplace_pricing: [
{
customer_group_id: '<string>',
cost_price: 123,
listing_price: 123,
selling_price: 123,
tax_rate: 123,
min_order_quantity: 1,
max_order_quantity: 123,
incremental_quantity: 1
}
],
marketplace_product_id: '<string>',
marketplace_variant_id: '<string>',
marketplace_item_id: '<string>',
marketplace_promotion: {
promotion_type: 'discount',
starts_at: '<string>',
details: [
{
discount_type: 'percentage',
discount_percent: 123,
customer_group_id: '<string>',
minimum_quantity: 1,
maximum_quantity: 123,
maximum_discount_amount: 123
}
],
expires_at: '<string>'
},
marketplace_subscription: [
{
subscription_plan: '<string>',
billing_interval: 123,
billing_frequency: 'monthly',
billing_limit: 123,
billing_trial_days: 0,
fulfill_separately: true,
subscription_price: [{suscription_price: 123, minimum_quantity: 1, customer_group_id: '<string>'}],
order_interval: 123,
order_frequency: 'monthly',
order_limit: 123
}
]
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'marketplace_id' => '<string>',
'product_id' => '<string>',
'variant_id' => '<string>',
'marketplace_item_sku' => '<string>',
'marketplace_category' => [
'<string>'
],
'marketplace_attribute' => [
[
'attribute_id' => '<string>',
'attribute_value' => '<string>'
]
],
'marketplace_pricing' => [
[
'customer_group_id' => '<string>',
'cost_price' => 123,
'listing_price' => 123,
'selling_price' => 123,
'tax_rate' => 123,
'min_order_quantity' => 1,
'max_order_quantity' => 123,
'incremental_quantity' => 1
]
],
'marketplace_product_id' => '<string>',
'marketplace_variant_id' => '<string>',
'marketplace_item_id' => '<string>',
'marketplace_promotion' => [
'promotion_type' => 'discount',
'starts_at' => '<string>',
'details' => [
[
'discount_type' => 'percentage',
'discount_percent' => 123,
'customer_group_id' => '<string>',
'minimum_quantity' => 1,
'maximum_quantity' => 123,
'maximum_discount_amount' => 123
]
],
'expires_at' => '<string>'
],
'marketplace_subscription' => [
[
'subscription_plan' => '<string>',
'billing_interval' => 123,
'billing_frequency' => 'monthly',
'billing_limit' => 123,
'billing_trial_days' => 0,
'fulfill_separately' => true,
'subscription_price' => [
[
'suscription_price' => 123,
'minimum_quantity' => 1,
'customer_group_id' => '<string>'
]
],
'order_interval' => 123,
'order_frequency' => 'monthly',
'order_limit' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings"
payload := strings.NewReader("{\n \"marketplace_id\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"marketplace_item_sku\": \"<string>\",\n \"marketplace_category\": [\n \"<string>\"\n ],\n \"marketplace_attribute\": [\n {\n \"attribute_id\": \"<string>\",\n \"attribute_value\": \"<string>\"\n }\n ],\n \"marketplace_pricing\": [\n {\n \"customer_group_id\": \"<string>\",\n \"cost_price\": 123,\n \"listing_price\": 123,\n \"selling_price\": 123,\n \"tax_rate\": 123,\n \"min_order_quantity\": 1,\n \"max_order_quantity\": 123,\n \"incremental_quantity\": 1\n }\n ],\n \"marketplace_product_id\": \"<string>\",\n \"marketplace_variant_id\": \"<string>\",\n \"marketplace_item_id\": \"<string>\",\n \"marketplace_promotion\": {\n \"promotion_type\": \"discount\",\n \"starts_at\": \"<string>\",\n \"details\": [\n {\n \"discount_type\": \"percentage\",\n \"discount_percent\": 123,\n \"customer_group_id\": \"<string>\",\n \"minimum_quantity\": 1,\n \"maximum_quantity\": 123,\n \"maximum_discount_amount\": 123\n }\n ],\n \"expires_at\": \"<string>\"\n },\n \"marketplace_subscription\": [\n {\n \"subscription_plan\": \"<string>\",\n \"billing_interval\": 123,\n \"billing_frequency\": \"monthly\",\n \"billing_limit\": 123,\n \"billing_trial_days\": 0,\n \"fulfill_separately\": true,\n \"subscription_price\": [\n {\n \"suscription_price\": 123,\n \"minimum_quantity\": 1,\n \"customer_group_id\": \"<string>\"\n }\n ],\n \"order_interval\": 123,\n \"order_frequency\": \"monthly\",\n \"order_limit\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"marketplace_id\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"marketplace_item_sku\": \"<string>\",\n \"marketplace_category\": [\n \"<string>\"\n ],\n \"marketplace_attribute\": [\n {\n \"attribute_id\": \"<string>\",\n \"attribute_value\": \"<string>\"\n }\n ],\n \"marketplace_pricing\": [\n {\n \"customer_group_id\": \"<string>\",\n \"cost_price\": 123,\n \"listing_price\": 123,\n \"selling_price\": 123,\n \"tax_rate\": 123,\n \"min_order_quantity\": 1,\n \"max_order_quantity\": 123,\n \"incremental_quantity\": 1\n }\n ],\n \"marketplace_product_id\": \"<string>\",\n \"marketplace_variant_id\": \"<string>\",\n \"marketplace_item_id\": \"<string>\",\n \"marketplace_promotion\": {\n \"promotion_type\": \"discount\",\n \"starts_at\": \"<string>\",\n \"details\": [\n {\n \"discount_type\": \"percentage\",\n \"discount_percent\": 123,\n \"customer_group_id\": \"<string>\",\n \"minimum_quantity\": 1,\n \"maximum_quantity\": 123,\n \"maximum_discount_amount\": 123\n }\n ],\n \"expires_at\": \"<string>\"\n },\n \"marketplace_subscription\": [\n {\n \"subscription_plan\": \"<string>\",\n \"billing_interval\": 123,\n \"billing_frequency\": \"monthly\",\n \"billing_limit\": 123,\n \"billing_trial_days\": 0,\n \"fulfill_separately\": true,\n \"subscription_price\": [\n {\n \"suscription_price\": 123,\n \"minimum_quantity\": 1,\n \"customer_group_id\": \"<string>\"\n }\n ],\n \"order_interval\": 123,\n \"order_frequency\": \"monthly\",\n \"order_limit\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"marketplace_id\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"marketplace_item_sku\": \"<string>\",\n \"marketplace_category\": [\n \"<string>\"\n ],\n \"marketplace_attribute\": [\n {\n \"attribute_id\": \"<string>\",\n \"attribute_value\": \"<string>\"\n }\n ],\n \"marketplace_pricing\": [\n {\n \"customer_group_id\": \"<string>\",\n \"cost_price\": 123,\n \"listing_price\": 123,\n \"selling_price\": 123,\n \"tax_rate\": 123,\n \"min_order_quantity\": 1,\n \"max_order_quantity\": 123,\n \"incremental_quantity\": 1\n }\n ],\n \"marketplace_product_id\": \"<string>\",\n \"marketplace_variant_id\": \"<string>\",\n \"marketplace_item_id\": \"<string>\",\n \"marketplace_promotion\": {\n \"promotion_type\": \"discount\",\n \"starts_at\": \"<string>\",\n \"details\": [\n {\n \"discount_type\": \"percentage\",\n \"discount_percent\": 123,\n \"customer_group_id\": \"<string>\",\n \"minimum_quantity\": 1,\n \"maximum_quantity\": 123,\n \"maximum_discount_amount\": 123\n }\n ],\n \"expires_at\": \"<string>\"\n },\n \"marketplace_subscription\": [\n {\n \"subscription_plan\": \"<string>\",\n \"billing_interval\": 123,\n \"billing_frequency\": \"monthly\",\n \"billing_limit\": 123,\n \"billing_trial_days\": 0,\n \"fulfill_separately\": true,\n \"subscription_price\": [\n {\n \"suscription_price\": 123,\n \"minimum_quantity\": 1,\n \"customer_group_id\": \"<string>\"\n }\n ],\n \"order_interval\": 123,\n \"order_frequency\": \"monthly\",\n \"order_limit\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"item": {
"product_id": "<string>",
"product_name": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"sku": "<string>",
"marketplace_id": "<string>",
"marketplace_name": "<string>",
"marketplace_slug": "<string>",
"status": "listed",
"marketplace_product_id": "<string>",
"marketplace_variant_id": "<string>",
"marketplace_item_id": "<string>",
"marketplace_item_sku": "<string>",
"marketplace_category": [
"<string>"
],
"marketplace_pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"tax_type": "GST"
}
],
"marketplace_attribute": [
{
"attribute_id": "<string>",
"attribute_value": "<string>"
}
],
"marketplace_promotion": {
"promotion_type": "discount",
"starts_at": "<string>",
"details": [
{
"discount_type": "percentage",
"discount_percent": 123,
"customer_group_id": "<string>",
"minimum_quantity": 1,
"maximum_quantity": 123,
"maximum_discount_amount": 123
}
],
"id": "<string>",
"expires_at": "<string>"
},
"marketplace_subscription": [
{
"subscription_plan": "<string>",
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"billing_trial_days": 0,
"fulfill_separately": true,
"subscription_price": [
{
"suscription_price": 123,
"minimum_quantity": 1,
"customer_group_id": "<string>"
}
],
"subscription_plan_id": "<string>",
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123
}
],
"sync_status": "success",
"last_synced_at": "2023-11-07T05:31:56Z",
"sync_error_message": "<string>",
"publication_status": "published",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"error": {
"fieldname": [
"<string>"
]
}
}{
"message": "Not authorized for given operation on the Resource.",
"success": false,
"code": "unauthorized"
}Catalog
Create or update marketplace listing
Create or update marketplace listing
POST
/
catalog
/
marketplace-listings
Create or update marketplace listing
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"marketplace_id": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"marketplace_item_sku": "<string>",
"marketplace_category": [
"<string>"
],
"marketplace_attribute": [
{
"attribute_id": "<string>",
"attribute_value": "<string>"
}
],
"marketplace_pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1
}
],
"marketplace_product_id": "<string>",
"marketplace_variant_id": "<string>",
"marketplace_item_id": "<string>",
"marketplace_promotion": {
"promotion_type": "discount",
"starts_at": "<string>",
"details": [
{
"discount_type": "percentage",
"discount_percent": 123,
"customer_group_id": "<string>",
"minimum_quantity": 1,
"maximum_quantity": 123,
"maximum_discount_amount": 123
}
],
"expires_at": "<string>"
},
"marketplace_subscription": [
{
"subscription_plan": "<string>",
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"billing_trial_days": 0,
"fulfill_separately": true,
"subscription_price": [
{
"suscription_price": 123,
"minimum_quantity": 1,
"customer_group_id": "<string>"
}
],
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123
}
]
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings"
payload = {
"marketplace_id": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"marketplace_item_sku": "<string>",
"marketplace_category": ["<string>"],
"marketplace_attribute": [
{
"attribute_id": "<string>",
"attribute_value": "<string>"
}
],
"marketplace_pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1
}
],
"marketplace_product_id": "<string>",
"marketplace_variant_id": "<string>",
"marketplace_item_id": "<string>",
"marketplace_promotion": {
"promotion_type": "discount",
"starts_at": "<string>",
"details": [
{
"discount_type": "percentage",
"discount_percent": 123,
"customer_group_id": "<string>",
"minimum_quantity": 1,
"maximum_quantity": 123,
"maximum_discount_amount": 123
}
],
"expires_at": "<string>"
},
"marketplace_subscription": [
{
"subscription_plan": "<string>",
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"billing_trial_days": 0,
"fulfill_separately": True,
"subscription_price": [
{
"suscription_price": 123,
"minimum_quantity": 1,
"customer_group_id": "<string>"
}
],
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
marketplace_id: '<string>',
product_id: '<string>',
variant_id: '<string>',
marketplace_item_sku: '<string>',
marketplace_category: ['<string>'],
marketplace_attribute: [{attribute_id: '<string>', attribute_value: '<string>'}],
marketplace_pricing: [
{
customer_group_id: '<string>',
cost_price: 123,
listing_price: 123,
selling_price: 123,
tax_rate: 123,
min_order_quantity: 1,
max_order_quantity: 123,
incremental_quantity: 1
}
],
marketplace_product_id: '<string>',
marketplace_variant_id: '<string>',
marketplace_item_id: '<string>',
marketplace_promotion: {
promotion_type: 'discount',
starts_at: '<string>',
details: [
{
discount_type: 'percentage',
discount_percent: 123,
customer_group_id: '<string>',
minimum_quantity: 1,
maximum_quantity: 123,
maximum_discount_amount: 123
}
],
expires_at: '<string>'
},
marketplace_subscription: [
{
subscription_plan: '<string>',
billing_interval: 123,
billing_frequency: 'monthly',
billing_limit: 123,
billing_trial_days: 0,
fulfill_separately: true,
subscription_price: [{suscription_price: 123, minimum_quantity: 1, customer_group_id: '<string>'}],
order_interval: 123,
order_frequency: 'monthly',
order_limit: 123
}
]
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'marketplace_id' => '<string>',
'product_id' => '<string>',
'variant_id' => '<string>',
'marketplace_item_sku' => '<string>',
'marketplace_category' => [
'<string>'
],
'marketplace_attribute' => [
[
'attribute_id' => '<string>',
'attribute_value' => '<string>'
]
],
'marketplace_pricing' => [
[
'customer_group_id' => '<string>',
'cost_price' => 123,
'listing_price' => 123,
'selling_price' => 123,
'tax_rate' => 123,
'min_order_quantity' => 1,
'max_order_quantity' => 123,
'incremental_quantity' => 1
]
],
'marketplace_product_id' => '<string>',
'marketplace_variant_id' => '<string>',
'marketplace_item_id' => '<string>',
'marketplace_promotion' => [
'promotion_type' => 'discount',
'starts_at' => '<string>',
'details' => [
[
'discount_type' => 'percentage',
'discount_percent' => 123,
'customer_group_id' => '<string>',
'minimum_quantity' => 1,
'maximum_quantity' => 123,
'maximum_discount_amount' => 123
]
],
'expires_at' => '<string>'
],
'marketplace_subscription' => [
[
'subscription_plan' => '<string>',
'billing_interval' => 123,
'billing_frequency' => 'monthly',
'billing_limit' => 123,
'billing_trial_days' => 0,
'fulfill_separately' => true,
'subscription_price' => [
[
'suscription_price' => 123,
'minimum_quantity' => 1,
'customer_group_id' => '<string>'
]
],
'order_interval' => 123,
'order_frequency' => 'monthly',
'order_limit' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings"
payload := strings.NewReader("{\n \"marketplace_id\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"marketplace_item_sku\": \"<string>\",\n \"marketplace_category\": [\n \"<string>\"\n ],\n \"marketplace_attribute\": [\n {\n \"attribute_id\": \"<string>\",\n \"attribute_value\": \"<string>\"\n }\n ],\n \"marketplace_pricing\": [\n {\n \"customer_group_id\": \"<string>\",\n \"cost_price\": 123,\n \"listing_price\": 123,\n \"selling_price\": 123,\n \"tax_rate\": 123,\n \"min_order_quantity\": 1,\n \"max_order_quantity\": 123,\n \"incremental_quantity\": 1\n }\n ],\n \"marketplace_product_id\": \"<string>\",\n \"marketplace_variant_id\": \"<string>\",\n \"marketplace_item_id\": \"<string>\",\n \"marketplace_promotion\": {\n \"promotion_type\": \"discount\",\n \"starts_at\": \"<string>\",\n \"details\": [\n {\n \"discount_type\": \"percentage\",\n \"discount_percent\": 123,\n \"customer_group_id\": \"<string>\",\n \"minimum_quantity\": 1,\n \"maximum_quantity\": 123,\n \"maximum_discount_amount\": 123\n }\n ],\n \"expires_at\": \"<string>\"\n },\n \"marketplace_subscription\": [\n {\n \"subscription_plan\": \"<string>\",\n \"billing_interval\": 123,\n \"billing_frequency\": \"monthly\",\n \"billing_limit\": 123,\n \"billing_trial_days\": 0,\n \"fulfill_separately\": true,\n \"subscription_price\": [\n {\n \"suscription_price\": 123,\n \"minimum_quantity\": 1,\n \"customer_group_id\": \"<string>\"\n }\n ],\n \"order_interval\": 123,\n \"order_frequency\": \"monthly\",\n \"order_limit\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"marketplace_id\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"marketplace_item_sku\": \"<string>\",\n \"marketplace_category\": [\n \"<string>\"\n ],\n \"marketplace_attribute\": [\n {\n \"attribute_id\": \"<string>\",\n \"attribute_value\": \"<string>\"\n }\n ],\n \"marketplace_pricing\": [\n {\n \"customer_group_id\": \"<string>\",\n \"cost_price\": 123,\n \"listing_price\": 123,\n \"selling_price\": 123,\n \"tax_rate\": 123,\n \"min_order_quantity\": 1,\n \"max_order_quantity\": 123,\n \"incremental_quantity\": 1\n }\n ],\n \"marketplace_product_id\": \"<string>\",\n \"marketplace_variant_id\": \"<string>\",\n \"marketplace_item_id\": \"<string>\",\n \"marketplace_promotion\": {\n \"promotion_type\": \"discount\",\n \"starts_at\": \"<string>\",\n \"details\": [\n {\n \"discount_type\": \"percentage\",\n \"discount_percent\": 123,\n \"customer_group_id\": \"<string>\",\n \"minimum_quantity\": 1,\n \"maximum_quantity\": 123,\n \"maximum_discount_amount\": 123\n }\n ],\n \"expires_at\": \"<string>\"\n },\n \"marketplace_subscription\": [\n {\n \"subscription_plan\": \"<string>\",\n \"billing_interval\": 123,\n \"billing_frequency\": \"monthly\",\n \"billing_limit\": 123,\n \"billing_trial_days\": 0,\n \"fulfill_separately\": true,\n \"subscription_price\": [\n {\n \"suscription_price\": 123,\n \"minimum_quantity\": 1,\n \"customer_group_id\": \"<string>\"\n }\n ],\n \"order_interval\": 123,\n \"order_frequency\": \"monthly\",\n \"order_limit\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/marketplace-listings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"marketplace_id\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"marketplace_item_sku\": \"<string>\",\n \"marketplace_category\": [\n \"<string>\"\n ],\n \"marketplace_attribute\": [\n {\n \"attribute_id\": \"<string>\",\n \"attribute_value\": \"<string>\"\n }\n ],\n \"marketplace_pricing\": [\n {\n \"customer_group_id\": \"<string>\",\n \"cost_price\": 123,\n \"listing_price\": 123,\n \"selling_price\": 123,\n \"tax_rate\": 123,\n \"min_order_quantity\": 1,\n \"max_order_quantity\": 123,\n \"incremental_quantity\": 1\n }\n ],\n \"marketplace_product_id\": \"<string>\",\n \"marketplace_variant_id\": \"<string>\",\n \"marketplace_item_id\": \"<string>\",\n \"marketplace_promotion\": {\n \"promotion_type\": \"discount\",\n \"starts_at\": \"<string>\",\n \"details\": [\n {\n \"discount_type\": \"percentage\",\n \"discount_percent\": 123,\n \"customer_group_id\": \"<string>\",\n \"minimum_quantity\": 1,\n \"maximum_quantity\": 123,\n \"maximum_discount_amount\": 123\n }\n ],\n \"expires_at\": \"<string>\"\n },\n \"marketplace_subscription\": [\n {\n \"subscription_plan\": \"<string>\",\n \"billing_interval\": 123,\n \"billing_frequency\": \"monthly\",\n \"billing_limit\": 123,\n \"billing_trial_days\": 0,\n \"fulfill_separately\": true,\n \"subscription_price\": [\n {\n \"suscription_price\": 123,\n \"minimum_quantity\": 1,\n \"customer_group_id\": \"<string>\"\n }\n ],\n \"order_interval\": 123,\n \"order_frequency\": \"monthly\",\n \"order_limit\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"item": {
"product_id": "<string>",
"product_name": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"sku": "<string>",
"marketplace_id": "<string>",
"marketplace_name": "<string>",
"marketplace_slug": "<string>",
"status": "listed",
"marketplace_product_id": "<string>",
"marketplace_variant_id": "<string>",
"marketplace_item_id": "<string>",
"marketplace_item_sku": "<string>",
"marketplace_category": [
"<string>"
],
"marketplace_pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"tax_type": "GST"
}
],
"marketplace_attribute": [
{
"attribute_id": "<string>",
"attribute_value": "<string>"
}
],
"marketplace_promotion": {
"promotion_type": "discount",
"starts_at": "<string>",
"details": [
{
"discount_type": "percentage",
"discount_percent": 123,
"customer_group_id": "<string>",
"minimum_quantity": 1,
"maximum_quantity": 123,
"maximum_discount_amount": 123
}
],
"id": "<string>",
"expires_at": "<string>"
},
"marketplace_subscription": [
{
"subscription_plan": "<string>",
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"billing_trial_days": 0,
"fulfill_separately": true,
"subscription_price": [
{
"suscription_price": 123,
"minimum_quantity": 1,
"customer_group_id": "<string>"
}
],
"subscription_plan_id": "<string>",
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123
}
],
"sync_status": "success",
"last_synced_at": "2023-11-07T05:31:56Z",
"sync_error_message": "<string>",
"publication_status": "published",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"error": {
"fieldname": [
"<string>"
]
}
}{
"message": "Not authorized for given operation on the Resource.",
"success": false,
"code": "unauthorized"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
SKU Required for physical product.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Provide product id if product already available in marketplace.
Provide variant id if variant already available in marketplace.
Provide item id if item already available in marketplace.
promotion_type = discount
- DiscountBasedPromotion
- FixedPricePromotion
- VolumeBasedPromotion
- FreeGoodsPromotion
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I