Archive Collection

Deactivate and move a collection to archives.

DELETE /v1/collections/{id}

TypeScript SDK

TypeScript

import { Solifyn } from 'solifyn';

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

// Archive a product collection
const collection = await solifyn.collections.archive('col_019e56a1...');
console.log('Collection Archived:', collection);

200

{
  "message": "Collection archived successfully"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Collection ID

Example:

"col_123"

Response

200 - application/json

Collection archived successfully.

message · string · required

Response message indicating the outcome of the action.

Example:

"Collection archived successfully"