Storefront API reference

Product Collection

Storefront Product Collection API endpoints

Endpoints

GET/products/collections
GET/products/collections/{collection_id}
GET/products/collections/{collection_id}/items

Get list of product collections

GET /products/collections

Query parameters

pageoptionalinteger

Page number for pagination

per_pageoptionalinteger

Entities per page

ids[]optionalinteger[]

Filter by collection IDs

slugs[]optionalstring[]

Filter by collection slugs

typeoptionalstring

Filter by collection type

sort[field]optionalstring

Field to sort by

Possible values: id, name.

sort[direction]optionalstring

Sort direction; defaults to asc.

Possible values: asc, desc.

Defaults to "asc".

Returnsobject

Product collections list response

curl https://api.subbly.co/storefront/v1/products/collections \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "name": "Summer Collection",
      "slug": "summer-collection",
      "type": "subscription",
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ]
}

Get product collection by ID

GET /products/collections/{collection_id}

Path parameters

collection_idRequiredinteger

Collection ID

ReturnsProductCollection

Product collection response

curl https://api.subbly.co/storefront/v1/products/collections/{collection_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "name": "Summer Collection",
  "slug": "summer-collection",
  "type": "subscription",
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Get list of collection groups with items

GET /products/collections/{collection_id}/items

Path parameters

collection_idRequiredinteger

Collection ID

Query parameters

pageoptionalinteger

Page number for pagination

per_pageoptionalinteger

Entities per page

expand[]optionalstring[]

List of relations to expand (e.g. product, items.variant)

Returnsobject

Collection groups list response

curl https://api.subbly.co/storefront/v1/products/collections/{collection_id}/items \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "product_id": 5,
      "product": {
        "id": 1,
        "bundle_id": 1,
        "bundle": {},
        "bundle_ruleset_id": 1,
        "bundle_ruleset": {},
        "slug": "yellow-t-shirt-with-pokemon-print",
        "type": "one_time",
        "name": "Yellow T-shirt with pokemon print",
        "description": "Yellow T-shirt with pokemon print",
        "delivery_info": "Free shipping on orders over $100",
        "collect_shipping_address": true,
        "gifting_enabled": true,
        "digital": false,
        "images": [
          {}
        ],
        "metadata": [
          {}
        ],
        "created_at": "2022-04-01 00:00:00",
        "updated_at": "2022-04-01 00:00:00",
        "gift_card": false,
        "gift_card_expiration": null,
        "variants": [
          {}
        ],
        "options": [
          {}
        ]
      },
      "items": [
        {
          "id": 1,
          "variant_id": 10,
          "product_id": 5,
          "position": 0,
          "variant": {}
        }
      ],
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ]
}