Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Product Collections

Get Product Collection

Retrieves the product collection.

get/v1/product-collections/{productCollectionId}

Response

Returns a product collection object if a valid identifier was provided in the path.

idstring required

Product collection ID.

namestring required

Unique user-defined product collection name.

type'STATIC' | 'AUTO_UPDATE' required

Describes whether the product collection is dynamic (products come in and leave based on set criteria) or static (manually selected products).

created_atstring date-time required

Timestamp representing the date and time when the product collection was created. The value is shown in the ISO 8601 format.

object'products_collection' required

The type of the object represented by JSON. This object stores information about the static product collection.

Example response

{
  "name": "All Products",
  "products": [
    {
      "id": "prod_0a41bcf807c5fcaaf6"
    }
  ],
  "created_at": "2021-12-09T12:51:29.898Z"
}