🗃️Product groups

Creating, reading, updating and deleting product groups

Get product groups

Gets the product groups in the store. Requires the Scopes.ViewProducts API key scope

GEThttps://api.sellsn.io/stores/{storeId}/product-groups/{page}

Path parameters

storeId*string (uuid)

The ID of the store to get the product groups in

page*integer (int32)

The page to select when viewing the groups

Query parameters

Response

The object was successfully returned.

Body

successboolean

Whether the operation was successful

pagesinteger (int32)

The amount of pages there are

datanullable array of PublicGroupedProduct (object)

The data for the page

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/product-groups/{page}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2024-09-16T23:22:43.473Z",
      "name": "text",
      "products": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2024-09-16T23:22:43.473Z",
          "name": "text",
          "description": "text",
          "tags": [
            "text"
          ],
          "imageNames": [
            "text"
          ],
          "cost": 0,
          "ignoreOutOfStock": false,
          "isPinned": false,
          "isDynamic": false,
          "rating": 0,
          "visibility": 0,
          "customValueKeys": [
            "text"
          ],
          "store": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2024-09-16T23:22:43.473Z",
            "name": "text",
            "description": "text",
            "url": "text",
            "customDomain": "text",
            "termsOfService": "text",
            "copyright": "text",
            "privacyPolicy": "text",
            "preferredCurrency": "text",
            "isVerified": false,
            "rating": 0,
            "theme": {},
            "socialMediaAccounts": {
              "tikTok": "text",
              "youTube": "text",
              "twitter": "text",
              "facebook": "text",
              "discord": "text",
              "telegram": "text",
              "instagram": "text"
            },
            "profileImage": "text"
          }
        }
      ]
    }
  ]
}

Create product group

Creates a new product group used to group products together as one product, requires the Scopes.CreateProducts permission

POSThttps://api.sellsn.io/stores/{storeId}/product-groups

Path parameters

storeId*string (uuid)

The ID of the store to create the group in

Body

The form that contains the new group datas

name*string

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

Response

The object was successfully created.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataPublicGroupedProduct (object)

A grouped product is a list of products that have been compressed into one product that a customer can choose a 'style' or 'variant' for

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/product-groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:22:43.473Z",
    "name": "text",
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:22:43.473Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 0,
        "ignoreOutOfStock": false,
        "isPinned": false,
        "isDynamic": false,
        "rating": 0,
        "visibility": 0,
        "customValueKeys": [
          "text"
        ],
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2024-09-16T23:22:43.473Z",
          "name": "text",
          "description": "text",
          "url": "text",
          "customDomain": "text",
          "termsOfService": "text",
          "copyright": "text",
          "privacyPolicy": "text",
          "preferredCurrency": "text",
          "isVerified": false,
          "rating": 0,
          "theme": {},
          "socialMediaAccounts": {
            "tikTok": "text",
            "youTube": "text",
            "twitter": "text",
            "facebook": "text",
            "discord": "text",
            "telegram": "text",
            "instagram": "text"
          },
          "profileImage": "text"
        }
      }
    ]
  }
}

Update product group

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

PATCHhttps://api.sellsn.io/stores/{storeId}/product-groups/{groupId}

Path parameters

storeId*string (uuid)

The ID of the store the product group belongs to

groupId*string (uuid)

The ID of the group to update

Body

The form containing the new group details

name*string

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

Response

The object was successfully updated.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataPublicGroupedProduct (object)

A grouped product is a list of products that have been compressed into one product that a customer can choose a 'style' or 'variant' for

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/product-groups/{groupId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:22:43.473Z",
    "name": "text",
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:22:43.473Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 0,
        "ignoreOutOfStock": false,
        "isPinned": false,
        "isDynamic": false,
        "rating": 0,
        "visibility": 0,
        "customValueKeys": [
          "text"
        ],
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2024-09-16T23:22:43.473Z",
          "name": "text",
          "description": "text",
          "url": "text",
          "customDomain": "text",
          "termsOfService": "text",
          "copyright": "text",
          "privacyPolicy": "text",
          "preferredCurrency": "text",
          "isVerified": false,
          "rating": 0,
          "theme": {},
          "socialMediaAccounts": {
            "tikTok": "text",
            "youTube": "text",
            "twitter": "text",
            "facebook": "text",
            "discord": "text",
            "telegram": "text",
            "instagram": "text"
          },
          "profileImage": "text"
        }
      }
    ]
  }
}

View product group

Returns the publicly visible product group that would usually be shown on your store. Does not require authorization.

GEThttps://api.sellsn.io/product-groups/{groupId}/view

Path parameters

groupId*string (uuid)

The ID of the product group to view

Response

The object was successfully updated.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataPublicGroupedProduct (object)

A grouped product is a list of products that have been compressed into one product that a customer can choose a 'style' or 'variant' for

Request

const response = await fetch('https://api.sellsn.io/product-groups/{groupId}/view', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:22:43.473Z",
    "name": "text",
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:22:43.473Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 0,
        "ignoreOutOfStock": false,
        "isPinned": false,
        "isDynamic": false,
        "rating": 0,
        "visibility": 0,
        "customValueKeys": [
          "text"
        ],
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2024-09-16T23:22:43.473Z",
          "name": "text",
          "description": "text",
          "url": "text",
          "customDomain": "text",
          "termsOfService": "text",
          "copyright": "text",
          "privacyPolicy": "text",
          "preferredCurrency": "text",
          "isVerified": false,
          "rating": 0,
          "theme": {},
          "socialMediaAccounts": {
            "tikTok": "text",
            "youTube": "text",
            "twitter": "text",
            "facebook": "text",
            "discord": "text",
            "telegram": "text",
            "instagram": "text"
          },
          "profileImage": "text"
        }
      }
    ]
  }
}

Remove product from group

Removes a product from a product group, requires the Scopes.UpdateProducts permission

DELETEhttps://api.sellsn.io/stores/{storeId}/product-groups/{groupId}/{productId}

Path parameters

storeId*string (uuid)

The ID of the store the group and product belongs to

groupId*string (uuid)

The ID of the group to remove the product from

productId*string (uuid)

The ID of the product to remove from the group

Response

The object was successfully updated.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataPublicGroupedProduct (object)

A grouped product is a list of products that have been compressed into one product that a customer can choose a 'style' or 'variant' for

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/product-groups/{groupId}/{productId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:22:43.473Z",
    "name": "text",
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:22:43.473Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 0,
        "ignoreOutOfStock": false,
        "isPinned": false,
        "isDynamic": false,
        "rating": 0,
        "visibility": 0,
        "customValueKeys": [
          "text"
        ],
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2024-09-16T23:22:43.473Z",
          "name": "text",
          "description": "text",
          "url": "text",
          "customDomain": "text",
          "termsOfService": "text",
          "copyright": "text",
          "privacyPolicy": "text",
          "preferredCurrency": "text",
          "isVerified": false,
          "rating": 0,
          "theme": {},
          "socialMediaAccounts": {
            "tikTok": "text",
            "youTube": "text",
            "twitter": "text",
            "facebook": "text",
            "discord": "text",
            "telegram": "text",
            "instagram": "text"
          },
          "profileImage": "text"
        }
      }
    ]
  }
}

Add product to group

Adds a product to a product group. Requires the Scopes.UpdateProducts permission

PATCHhttps://api.sellsn.io/stores/{storeId}/product-groups/{groupId}/{productId}

Path parameters

storeId*string (uuid)

The ID of the store the group and product belongs to

groupId*string (uuid)

The ID of the group to add the product to

productId*string (uuid)

The ID of the product to add to the group

Response

The object was successfully updated.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataPublicGroupedProduct (object)

A grouped product is a list of products that have been compressed into one product that a customer can choose a 'style' or 'variant' for

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/product-groups/{groupId}/{productId}', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:22:43.473Z",
    "name": "text",
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:22:43.473Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 0,
        "ignoreOutOfStock": false,
        "isPinned": false,
        "isDynamic": false,
        "rating": 0,
        "visibility": 0,
        "customValueKeys": [
          "text"
        ],
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2024-09-16T23:22:43.473Z",
          "name": "text",
          "description": "text",
          "url": "text",
          "customDomain": "text",
          "termsOfService": "text",
          "copyright": "text",
          "privacyPolicy": "text",
          "preferredCurrency": "text",
          "isVerified": false,
          "rating": 0,
          "theme": {},
          "socialMediaAccounts": {
            "tikTok": "text",
            "youTube": "text",
            "twitter": "text",
            "facebook": "text",
            "discord": "text",
            "telegram": "text",
            "instagram": "text"
          },
          "profileImage": "text"
        }
      }
    ]
  }
}

PreviousProducts NextTickets

Last updated 5 months ago

{ "success": false, "message": "text", "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "dateCreated": "2024-09-16T23:22:43.473Z", "name": "text", "products": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "dateCreated": "2024-09-16T23:22:43.473Z", "name": "text", "description": "text", "tags": [ "text" ], "imageNames": [ "text" ], "cost": 0, "ignoreOutOfStock": false, "isPinned": false, "isDynamic": false, "rating": 0, "visibility": 0, "customValueKeys": [ "text" ], "store": { "id": "123e4567-e89b-12d3-a456-426614174000", "dateCreated": "2024-09-16T23:22:43.473Z", "name": "text", "description": "text", "url": "text", "customDomain": "text", "termsOfService": "text", "copyright": "text", "privacyPolicy": "text", "preferredCurrency": "text", "isVerified": false, "rating": 0, "theme": {}, "socialMediaAccounts": { "tikTok": "text", "youTube": "text", "twitter": "text", "facebook": "text", "discord": "text", "telegram": "text", "instagram": "text" }, "profileImage": "text" } } ] } }

{ "success": false, "data": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "dateCreated": "2024-09-16T23:22:43.473Z", "name": "text", "products": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "dateCreated": "2024-09-16T23:22:43.473Z", "name": "text", "description": "text", "tags": [ "text" ], "imageNames": [ "text" ], "cost": 0, "ignoreOutOfStock": false, "isPinned": false, "isDynamic": false, "rating": 0, "visibility": 0, "customValueKeys": [ "text" ], "store": { "id": "123e4567-e89b-12d3-a456-426614174000", "dateCreated": "2024-09-16T23:22:43.473Z", "name": "text", "description": "text", "url": "text", "customDomain": "text", "termsOfService": "text", "copyright": "text", "privacyPolicy": "text", "preferredCurrency": "text", "isVerified": false, "rating": 0, "theme": {}, "socialMediaAccounts": { "tikTok": "text", "youTube": "text", "twitter": "text", "facebook": "text", "discord": "text", "telegram": "text", "instagram": "text" }, "profileImage": "text" } } ] } ] }

const response = await fetch('https://api.sellsn.io/stores/{storeId}/product-groups', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text" }), }); const data = await response.json();

const response = await fetch('https://api.sellsn.io/stores/{storeId}/product-groups/{groupId}', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text" }), }); const data = await response.json();