Overview
On this page, we’ll dive into the different section endpoints you can use to manage sections programmatically.
Sections are another way to make your SellApp storefront more navigable — they allow you to subdivide your storefront into overviewable parts/sections to streamline the customer browsing experience.
On this page, we'll dive into the different section endpoints you can use to manage sections programmatically. We'll look at how to create, update, and delete sections.
Endpoints
The section model
The section model contains all the information about the sections stores have, including the type, code, and discount amount.
Properties
- Name
idinteger- Description
The unique identifier for the section.
- Name
titlestring- Description
The section title.
- Name
slugstring- Description
The section slug.
- Name
hiddenboolean- Description
The section visibility. One of two values:
false: Section is not hidden and can be seen publicly.true: Section is hidden and can only be seen via direct link.
- Name
orderinteger- Description
The order of the section.
- Name
created_attimestamp- Description
The time at which this section was first created.
- Name
updated_attimestamp- Description
The time at which this section was last updated.
- Name
store_idinteger- Description
The ID of the store this section belongs to.
- Name
groups_linkedinteger- Description
The amount of groups linked to the section.
- Name
products_linkedinteger- Description
The amount of products linked to the section.
- Name
groupsarray- Description
An array of groups linked to the section, containing three types of info:
id: The group ID.title: The group title.group_product: The amount of products linked to the group.
- Name
productsarray- Description
An array of products linked to the section, containing three types of info:
id: The product ID.title: The product title.description: The product description.
Cancel a subscription immediately with a refund PATCH
To cancel immediately and refund the latest subscription payment, send cancelatperiodend: false with refundlastpayment: true.
List all sections GET
This endpoint allows you to retrieve a paginated list of all your sections. By default, a maximum of fifteen sections are shown per page.