Create a custom group
curl --request POST \
--url https://mm-api.merchantspring.io/customGroups \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"channelId": "<string>",
"merchantId": "<string>",
"groupName": "<string>",
"products": [
{
"sellerSku": "<string>"
}
],
"brands": [
"<string>"
],
"groupId": "<string>"
}
'import requests
url = "https://mm-api.merchantspring.io/customGroups"
payload = {
"channelId": "<string>",
"merchantId": "<string>",
"groupName": "<string>",
"products": [{ "sellerSku": "<string>" }],
"brands": ["<string>"],
"groupId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelId: '<string>',
merchantId: '<string>',
groupName: '<string>',
products: [{sellerSku: '<string>'}],
brands: ['<string>'],
groupId: '<string>'
})
};
fetch('https://mm-api.merchantspring.io/customGroups', 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://mm-api.merchantspring.io/customGroups",
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([
'channelId' => '<string>',
'merchantId' => '<string>',
'groupName' => '<string>',
'products' => [
[
'sellerSku' => '<string>'
]
],
'brands' => [
'<string>'
],
'groupId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://mm-api.merchantspring.io/customGroups"
payload := strings.NewReader("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"products\": [\n {\n \"sellerSku\": \"<string>\"\n }\n ],\n \"brands\": [\n \"<string>\"\n ],\n \"groupId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://mm-api.merchantspring.io/customGroups")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"products\": [\n {\n \"sellerSku\": \"<string>\"\n }\n ],\n \"brands\": [\n \"<string>\"\n ],\n \"groupId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/customGroups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"products\": [\n {\n \"sellerSku\": \"<string>\"\n }\n ],\n \"brands\": [\n \"<string>\"\n ],\n \"groupId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.This response has no body data.Custom Group
Create a custom group
Create a new custom product group for a channel.
POST
/
customGroups
Create a custom group
curl --request POST \
--url https://mm-api.merchantspring.io/customGroups \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"channelId": "<string>",
"merchantId": "<string>",
"groupName": "<string>",
"products": [
{
"sellerSku": "<string>"
}
],
"brands": [
"<string>"
],
"groupId": "<string>"
}
'import requests
url = "https://mm-api.merchantspring.io/customGroups"
payload = {
"channelId": "<string>",
"merchantId": "<string>",
"groupName": "<string>",
"products": [{ "sellerSku": "<string>" }],
"brands": ["<string>"],
"groupId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelId: '<string>',
merchantId: '<string>',
groupName: '<string>',
products: [{sellerSku: '<string>'}],
brands: ['<string>'],
groupId: '<string>'
})
};
fetch('https://mm-api.merchantspring.io/customGroups', 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://mm-api.merchantspring.io/customGroups",
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([
'channelId' => '<string>',
'merchantId' => '<string>',
'groupName' => '<string>',
'products' => [
[
'sellerSku' => '<string>'
]
],
'brands' => [
'<string>'
],
'groupId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://mm-api.merchantspring.io/customGroups"
payload := strings.NewReader("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"products\": [\n {\n \"sellerSku\": \"<string>\"\n }\n ],\n \"brands\": [\n \"<string>\"\n ],\n \"groupId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://mm-api.merchantspring.io/customGroups")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"products\": [\n {\n \"sellerSku\": \"<string>\"\n }\n ],\n \"brands\": [\n \"<string>\"\n ],\n \"groupId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/customGroups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"products\": [\n {\n \"sellerSku\": \"<string>\"\n }\n ],\n \"brands\": [\n \"<string>\"\n ],\n \"groupId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.This response has no body data.Authorizations
Body
application/json
Custom group details
Either products or brands must be provided (not both)
Show child attributes
Show child attributes
Optional. The ID of an existing custom group, as returned by the GET custom groups endpoint. Providing this value will completely overwrite the existing group. To add or remove individual items instead, use the PATCH endpoint.
Response
Was this page helpful?
⌘I