Skip to main content
GET
/
v1
/
collections
TypeScript SDK
import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// List product collections
const collections = await solifyn.collections.list();
console.log('Collections:', collections);
[
  {
    "id": "col_123",
    "name": "Summer Bundle",
    "status": "ACTIVE",
    "businessId": "biz_4r5t6y7u8i9o",
    "isPermanentlyDeleted": false,
    "createdAt": "2025-01-01T12:00:00Z",
    "updatedAt": "2025-01-01T12:00:00Z",
    "description": "Everything you need for summer.",
    "imageUrl": "https://example.com/image.png",
    "products": [
      {
        "id": "prod_NG0mkkz0Awitk",
        "quantity": 1
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Response

200 - application/json

Collections retrieved successfully.

​
id
string<uuid>
required

The collection ID

Example:

"col_123"

​
name
string
required

The name of the collection

Example:

"Summer Bundle"

​
status
enum<string>
required

Status of the collection

Available options:
ACTIVE,
ARCHIVED
Example:

"ACTIVE"

​
businessId
string
required

The unique identifier of the business owning this collection.

Example:

"biz_4r5t6y7u8i9o"

​
isPermanentlyDeleted
boolean
required

Indicates if the collection has been permanently deleted.

Example:

false

​
createdAt
string<date-time>
required

Timestamp when the collection was created

Example:

"2025-01-01T12:00:00Z"

​
updatedAt
string<date-time>
required

Timestamp when the collection was last updated

Example:

"2025-01-01T12:00:00Z"

​
description
string | null

A brief description of the collection

Example:

"Everything you need for summer."

​
imageUrl
string | null

URL of the collection image

Example:

"https://example.com/image.png"

​
products
object[]

List of product references (id + quantity). Full product details are available via GET /products/:id.