Version 2.1.1792967583 · latest Download OpenAPI Markdown

Package groups

Groups that organize packages so customers can browse and choose.

package-groupsPackagesAuthentication: Admin only5 endpoints

List package groups

GET/api/v2/package-groups
Authentication: Admin only

Query parameters

FieldTypeRequiredDescription
pageinteger— Page number, starting from 1
Default 1
page_sizeinteger— Items per page
Default 20
sortstring— Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`

Create package group

POST/api/v2/package-groups
Authentication: Admin only

Request body application/json

FieldTypeRequiredDescription
desstring— Description
namestringRequired Name
sortinteger— Display order (smaller first).

Get package group

GET/api/v2/package-groups/{id}
Authentication: Admin only

Update package group

PUT/api/v2/package-groups/{id}
Authentication: Admin only

Request body application/json

FieldTypeRequiredDescription
desstring— Description
namestringRequired Name
sortinteger— Display order (smaller first).

Delete package group

DELETE/api/v2/package-groups/{id}
Authentication: Admin only

Package groups object

FieldTypeRequiredDescription
created_atstring— Created at
read-only
desstring— Description
idinteger— Record ID
read-only
namestring— Name
sortinteger— Display order (smaller first).
updated_atstring— Updated at
read-only