Product groups
Creating, reading, updating and deleting product groups
Gets the product groups in the store. Requires the Scopes.ViewProducts API key scope
Authorizations
Path parameters
storeIdstring · uuidRequired
The ID of the store to get the product groups in
pageinteger · int32Required
The page to select when viewing the groups
Query parameters
countinteger · int32Optional
The amount of groups to display in one page
Responses
200
The object was successfully returned.
401
You are not authorized, check your API key and try again.
403
You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
404
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
get
GET /stores/{storeId}/product-groups/{page} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*
{
"success": true,
"pages": 1,
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"url": "text",
"customDomain": "text",
"termsOfService": "text",
"copyright": "text",
"privacyPolicy": "text",
"preferredCurrency": "text",
"isVerified": true,
"featuredProduct": "[Circular Reference]",
"visits": 1,
"reviews": 1,
"rating": 1,
"resolvedTickets": 1,
"productsSold": 1,
"theme": {
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"socialMediaAccounts": {
"tikTok": "text",
"youTube": "text",
"twitter": "text",
"facebook": "text",
"discord": "text",
"telegram": "text",
"instagram": "text"
},
"profileImage": "text"
}
}
],
"order": 1
}
]
}Creates a new product group used to group products together as one product, requires the
Scopes.CreateProducts permission
Authorizations
Path parameters
storeIdstring · uuidRequired
The ID of the store to create the group in
Body
Form used to create a new product group
namestring · min: 3 · max: 64Required
The name of the product group, this is displayed on the store page and on the marketplace where the individual product name would be shown
Responses
200
The object was successfully created.
400
The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.
401
You are not authorized, check your API key and try again.
403
You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
404
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
post
POST /stores/{storeId}/product-groups HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}{
"success": true,
"message": "text",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"url": "text",
"customDomain": "text",
"termsOfService": "text",
"copyright": "text",
"privacyPolicy": "text",
"preferredCurrency": "text",
"isVerified": true,
"featuredProduct": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": "[Circular Reference]"
},
"visits": 1,
"reviews": 1,
"rating": 1,
"resolvedTickets": 1,
"productsSold": 1,
"theme": {
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"socialMediaAccounts": {
"tikTok": "text",
"youTube": "text",
"twitter": "text",
"facebook": "text",
"discord": "text",
"telegram": "text",
"instagram": "text"
},
"profileImage": "text"
}
}
],
"order": 1
}
}Updates an existing product group, this only can update the group properties, not add or remove products from the
group. Requires the Scopes.UpdateProducts permission
Authorizations
Path parameters
storeIdstring · uuidRequired
The ID of the store the product group belongs to
groupIdstring · uuidRequired
The ID of the group to update
Body
Form used to create a new product group
namestring · min: 3 · max: 64Required
The name of the product group, this is displayed on the store page and on the marketplace where the individual product name would be shown
Responses
200
The object was successfully updated.
400
The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.
401
You are not authorized, check your API key and try again.
403
You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
404
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
patch
PATCH /stores/{storeId}/product-groups/{groupId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}{
"success": true,
"message": "text",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"url": "text",
"customDomain": "text",
"termsOfService": "text",
"copyright": "text",
"privacyPolicy": "text",
"preferredCurrency": "text",
"isVerified": true,
"featuredProduct": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": "[Circular Reference]"
},
"visits": 1,
"reviews": 1,
"rating": 1,
"resolvedTickets": 1,
"productsSold": 1,
"theme": {
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"socialMediaAccounts": {
"tikTok": "text",
"youTube": "text",
"twitter": "text",
"facebook": "text",
"discord": "text",
"telegram": "text",
"instagram": "text"
},
"profileImage": "text"
}
}
],
"order": 1
}
}Returns the publicly visible product group that would usually be shown on your store. Does not require authorization.
Authorizations
Path parameters
groupIdstring · uuidRequired
The ID of the product group to view
Responses
200
The object was successfully updated.
400
The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.
404
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
get
GET /product-groups/{groupId}/view HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*
{
"success": true,
"message": "text",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"url": "text",
"customDomain": "text",
"termsOfService": "text",
"copyright": "text",
"privacyPolicy": "text",
"preferredCurrency": "text",
"isVerified": true,
"featuredProduct": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": "[Circular Reference]"
},
"visits": 1,
"reviews": 1,
"rating": 1,
"resolvedTickets": 1,
"productsSold": 1,
"theme": {
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"socialMediaAccounts": {
"tikTok": "text",
"youTube": "text",
"twitter": "text",
"facebook": "text",
"discord": "text",
"telegram": "text",
"instagram": "text"
},
"profileImage": "text"
}
}
],
"order": 1
}
}Removes a product from a product group, requires the Scopes.UpdateProducts permission
Authorizations
Path parameters
storeIdstring · uuidRequired
The ID of the store the group and product belongs to
groupIdstring · uuidRequired
The ID of the group to remove the product from
productIdstring · uuidRequired
The ID of the product to remove from the group
Responses
200
The object was successfully updated.
400
The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.
401
You are not authorized, check your API key and try again.
403
You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
404
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
delete
DELETE /stores/{storeId}/product-groups/{groupId}/{productId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*
{
"success": true,
"message": "text",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"url": "text",
"customDomain": "text",
"termsOfService": "text",
"copyright": "text",
"privacyPolicy": "text",
"preferredCurrency": "text",
"isVerified": true,
"featuredProduct": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": "[Circular Reference]"
},
"visits": 1,
"reviews": 1,
"rating": 1,
"resolvedTickets": 1,
"productsSold": 1,
"theme": {
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"socialMediaAccounts": {
"tikTok": "text",
"youTube": "text",
"twitter": "text",
"facebook": "text",
"discord": "text",
"telegram": "text",
"instagram": "text"
},
"profileImage": "text"
}
}
],
"order": 1
}
}Adds a product to a product group. Requires the Scopes.UpdateProducts permission
Authorizations
Path parameters
storeIdstring · uuidRequired
The ID of the store the group and product belongs to
groupIdstring · uuidRequired
The ID of the group to add the product to
productIdstring · uuidRequired
The ID of the product to add to the group
Responses
200
The object was successfully updated.
400
The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.
401
You are not authorized, check your API key and try again.
403
You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
404
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
patch
PATCH /stores/{storeId}/product-groups/{groupId}/{productId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*
{
"success": true,
"message": "text",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"url": "text",
"customDomain": "text",
"termsOfService": "text",
"copyright": "text",
"privacyPolicy": "text",
"preferredCurrency": "text",
"isVerified": true,
"featuredProduct": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-07-05T19:56:47.112Z",
"name": "text",
"description": "text",
"tags": [
"text"
],
"imageNames": [
"text"
],
"cost": 1,
"stock": 1,
"amountSold": 1,
"ignoreOutOfStock": true,
"isPinned": true,
"isDynamic": true,
"rating": 1,
"minimumQuantity": 1,
"maximumQuantity": 1,
"order": 1,
"visibility": 0,
"likes": 1,
"customValueKeys": [
"text"
],
"store": "[Circular Reference]"
},
"visits": 1,
"reviews": 1,
"rating": 1,
"resolvedTickets": 1,
"productsSold": 1,
"theme": {
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"socialMediaAccounts": {
"tikTok": "text",
"youTube": "text",
"twitter": "text",
"facebook": "text",
"discord": "text",
"telegram": "text",
"instagram": "text"
},
"profileImage": "text"
}
}
],
"order": 1
}
}Last updated
Was this helpful?