Overview
On this page, we’ll dive into the different group endpoints you can use to manage groups programmatically.
Groups are a way to help make your storefront navigable in SellApp — they are a collection of products you've grouped together in a tidy bunch.
On this page, we'll dive into the different group endpoints you can use to manage groups programmatically. We'll look at how to query, create, update, and delete groups, as well as how to add and remove products within groups.
Endpoints
- List all groups
- Create a group
- Retrieve a group
- Update a group
- Delete a group
- Add products to group
- Remove products from group
- List all products within group
- List specific product within group
The group model
The group model contains all the information about your groups, including what products are in the group and the group's name, description, and image.
Properties
- Name
idinteger- Description
The unique identifier for the group.
- Name
titlestring- Description
The group title.
- Name
orderinteger- Description
The order rank of the group.
- Name
imageobject- Description
The image belonging to the group.
- Name
unlistedboolean- Description
Whether the group is unlisted or not. If set to true, the group will only be accessible via a direct link.
- Name
created_attimestamp- Description
The time at which this group was first created.
- Name
updated_attimestamp- Description
The time at which this group was last updated.
- Name
store_idinteger- Description
The ID of the store this group belongs to.
- Name
section_idinteger- Description
The ID of the section this group belongs to.
- Name
section_orderinteger- Description
The order rank of the group within the section it belongs to.
- Name
products_linkedinteger- Description
The amount of products linked to this group.
- Name
productsarray- Description
The products linked to this group, containing three types of info:
id: The product IDtitle: The product titledescription: The product description