Products

Products

curl --request GET \
  --url https://api.marzipan.co/v1/products \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "2e2805a1-738e-4118-8a8b-f9431f0e210c",
      "name": "Cellar Selection Malbec",
      "slug": "cellar-selection-malbec-2015",
      "description": "Id laboris ad aliqua exercitation dolore. Ad, aliqua exercitation dolore est culpa. Dolore est culpa id duis duis labore dolore do ex.",
      "productType": "physical",
      "sku": "CSMALBC2015",
      "collection": "Store",
      "status": "active",
      "image": {
        "id": "0736c529-a33d-4b8c-8126-eb69779dcdad",
        "path": "1/0736c529-a33d-4b8c-8126-eb69779dcdad.jpg",
        "src": "https://marzipan-cloud-dev.b-cdn.net/1/0736c529-a33d-4b8c-8126-eb69779dcdad.jpg",
        "alt": "Cellar Selection Malbec 2015 bottle",
        "mimeType": "image/jpeg",
        "filename": "0736c529-a33d-4b8c-8126-eb69779dcdad.jpg"
      },
      "price": "£24.99",
      "salePrice": null,
      "subscriberPrice": null,
      "createdAt": "2024-02-05T23:22:56.000000Z",
      "updatedAt": "2024-02-05T23:22:56.000000Z",
      "storeSlug": "store",
      "subscriptionsSlug": null,
      "availability": "all",
      "upsellProducts": []
    },
    {
      "id": "df0d13db-1332-4461-b3d1-b2774d47ff5f",
      "name": "Chardonnay",
      "slug": "chardonnay-2015",
      "description": "Lorem sed id, culpa. Culpa id duis duis labore dolore do ex. Duis duis labore, dolore.",
      "productType": "physical",
      "sku": "CHARD2015",
      "collection": "Store",
      "status": "active",
      "image": {
        "id": "1b978a90-3ecb-4f37-b480-9fb81882176e",
        "path": "1/1b978a90-3ecb-4f37-b480-9fb81882176e.jpg",
        "src": "https://marzipan-cloud-dev.b-cdn.net/1/1b978a90-3ecb-4f37-b480-9fb81882176e.jpg",
        "alt": "Chardonnay 2015 bottle",
        "mimeType": "image/jpeg",
        "filename": "1b978a90-3ecb-4f37-b480-9fb81882176e.jpg"
      },
      "price": "£23.99",
      "salePrice": null,
      "subscriberPrice": null,
      "createdAt": "2024-02-05T23:22:56.000000Z",
      "updatedAt": "2024-02-05T23:22:56.000000Z",
      "storeSlug": "store",
      "subscriptionsSlug": null,
      "availability": "all",
      "upsellProducts": []
    },
    {
      "id": "084b80ef-d16d-4531-a25f-40b7ff4c744b",
      "name": "Discovery Club",
      "slug": "discovery-club",
      "description": "Laborum adipiscing, tempor cillum. Cillum exercitation sed officia mollit do dolore.",
      "productType": "subscription",
      "sku": "DISCCLUB",
      "collection": "Club",
      "status": "active",
      "image": {
        "id": "bc1a0d61-e7f9-44d3-ae53-1475b5f9395d",
        "path": "1/bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg",
        "src": "https://marzipan-cloud-dev.b-cdn.net/1/bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg",
        "alt": "Discovery Club subscription box",
        "mimeType": "image/jpeg",
        "filename": "bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg"
      },
      "price": "from £0.00",
      "salePrice": null,
      "subscriberPrice": null,
      "createdAt": "2024-02-05T23:22:56.000000Z",
      "updatedAt": "2024-02-05T23:22:56.000000Z",
      "storeSlug": null,
      "subscriptionsSlug": "club",
      "availability": "all",
      "upsellProducts": [],
      "billing_frequency": 6,
      "pricing_type": "per_item"
    }
  ],
  "links": {
    "first": "https://api.marzipan.co/v1/products?page=1",
    "last": "https://api.marzipan.co/v1/products?page=5",
    "prev": null,
    "next": "https://api.marzipan.co/v1/products?page=2"
  },
  "meta": {
    "currentPage": 1,
    "from": 1,
    "path": "https://api.marzipan.co/v1/products",
    "perPage": 15,
    "to": 15
  }
}

GET

products

Products

curl --request GET \
  --url https://api.marzipan.co/v1/products \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "2e2805a1-738e-4118-8a8b-f9431f0e210c",
      "name": "Cellar Selection Malbec",
      "slug": "cellar-selection-malbec-2015",
      "description": "Id laboris ad aliqua exercitation dolore. Ad, aliqua exercitation dolore est culpa. Dolore est culpa id duis duis labore dolore do ex.",
      "productType": "physical",
      "sku": "CSMALBC2015",
      "collection": "Store",
      "status": "active",
      "image": {
        "id": "0736c529-a33d-4b8c-8126-eb69779dcdad",
        "path": "1/0736c529-a33d-4b8c-8126-eb69779dcdad.jpg",
        "src": "https://marzipan-cloud-dev.b-cdn.net/1/0736c529-a33d-4b8c-8126-eb69779dcdad.jpg",
        "alt": "Cellar Selection Malbec 2015 bottle",
        "mimeType": "image/jpeg",
        "filename": "0736c529-a33d-4b8c-8126-eb69779dcdad.jpg"
      },
      "price": "£24.99",
      "salePrice": null,
      "subscriberPrice": null,
      "createdAt": "2024-02-05T23:22:56.000000Z",
      "updatedAt": "2024-02-05T23:22:56.000000Z",
      "storeSlug": "store",
      "subscriptionsSlug": null,
      "availability": "all",
      "upsellProducts": []
    },
    {
      "id": "df0d13db-1332-4461-b3d1-b2774d47ff5f",
      "name": "Chardonnay",
      "slug": "chardonnay-2015",
      "description": "Lorem sed id, culpa. Culpa id duis duis labore dolore do ex. Duis duis labore, dolore.",
      "productType": "physical",
      "sku": "CHARD2015",
      "collection": "Store",
      "status": "active",
      "image": {
        "id": "1b978a90-3ecb-4f37-b480-9fb81882176e",
        "path": "1/1b978a90-3ecb-4f37-b480-9fb81882176e.jpg",
        "src": "https://marzipan-cloud-dev.b-cdn.net/1/1b978a90-3ecb-4f37-b480-9fb81882176e.jpg",
        "alt": "Chardonnay 2015 bottle",
        "mimeType": "image/jpeg",
        "filename": "1b978a90-3ecb-4f37-b480-9fb81882176e.jpg"
      },
      "price": "£23.99",
      "salePrice": null,
      "subscriberPrice": null,
      "createdAt": "2024-02-05T23:22:56.000000Z",
      "updatedAt": "2024-02-05T23:22:56.000000Z",
      "storeSlug": "store",
      "subscriptionsSlug": null,
      "availability": "all",
      "upsellProducts": []
    },
    {
      "id": "084b80ef-d16d-4531-a25f-40b7ff4c744b",
      "name": "Discovery Club",
      "slug": "discovery-club",
      "description": "Laborum adipiscing, tempor cillum. Cillum exercitation sed officia mollit do dolore.",
      "productType": "subscription",
      "sku": "DISCCLUB",
      "collection": "Club",
      "status": "active",
      "image": {
        "id": "bc1a0d61-e7f9-44d3-ae53-1475b5f9395d",
        "path": "1/bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg",
        "src": "https://marzipan-cloud-dev.b-cdn.net/1/bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg",
        "alt": "Discovery Club subscription box",
        "mimeType": "image/jpeg",
        "filename": "bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg"
      },
      "price": "from £0.00",
      "salePrice": null,
      "subscriberPrice": null,
      "createdAt": "2024-02-05T23:22:56.000000Z",
      "updatedAt": "2024-02-05T23:22:56.000000Z",
      "storeSlug": null,
      "subscriptionsSlug": "club",
      "availability": "all",
      "upsellProducts": [],
      "billing_frequency": 6,
      "pricing_type": "per_item"
    }
  ],
  "links": {
    "first": "https://api.marzipan.co/v1/products?page=1",
    "last": "https://api.marzipan.co/v1/products?page=5",
    "prev": null,
    "next": "https://api.marzipan.co/v1/products?page=2"
  },
  "meta": {
    "currentPage": 1,
    "from": 1,
    "path": "https://api.marzipan.co/v1/products",
    "perPage": 15,
    "to": 15
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Query Parameters

collection

string

Filter products by collection slug or name. Products will be ordered by their position in the collection.

attr

object

Filter products by attributes using deep object notation. Each attribute filter accepts comma-separated values for OR matching.

Format: attr[attribute_slug]=value1,value2

Example: attr[color]=red,blue&attr[size]=large This returns products that are (red OR blue) AND large.

Show child attributes

attr.{key}]

string

sort

string

Sort products by field and direction. Format: field.direction (e.g., price.asc, name.desc). Multiple sort options can be comma-separated.

limit

integer

Limit the number of results returned. Maximum 50 per page.

Required range: 1 <= x <= 50

page

integer

Page number for pagination.

Required range: x >= 1

per_page

integer

default:50

Number of items per page. Default is 50.

Required range: 1 <= x <= 50

include

enum<string>

Comma-separated list of related resources to include in the response.

Available options: linkedSubscriptions (includes full subscription details for products with linked subscriptions).

Available options:

linkedSubscriptions

Response

200 - application/json

products

data

object[]

Show child attributes

data.id

string<uuid>

Unique identifier for the product

data.name

string

Product name

data.slug

string

URL-friendly product identifier

data.url

string

Full URL to the product page

data.description

string

Product description

data.product_type

enum<string>

Type of product

Available options:

physical,

event,

subscription,

bundle

data.subscription_type

enum<string>

Type of subscription. Only present for subscription products

Available options:

picknmix,

variable

data.sku

string

Stock Keeping Unit

data.collections

object[]

Collections this product belongs to

Show child attributes

data.collections.id

string<uuid>

Unique identifier for the collection

data.collections.name

string

Collection name

data.collections.description

string

Collection description

data.collections.slug

string

URL-friendly collection identifier

data.collections.attributes

object[]

Collection attributes

data.status

enum<string>

Product status - automatically set to out_of_stock when quantity is 0

Available options:

active,

inactive,

out_of_stock

data.images

object

Product images organized by type

Show child attributes

data.images.product

object[]

Main product images

Show child attributes

data.images.product.id

string<uuid>

Unique identifier for the image

data.images.product.path

string

Relative path to the image file

data.images.product.src

string<uri>

Full URL to access the image

data.images.product.alt

string | null

Alternative text for accessibility

data.images.product.mimeType

string

MIME type of the image (e.g., image/jpeg, image/png)

data.images.product.filename

string

Original filename of the uploaded image

data.images.labels

object

Show child attributes

data.images.labels.front

object[]

Front label images

Show child attributes

data.images.labels.front.id

string<uuid>

Unique identifier for the image

data.images.labels.front.path

string

Relative path to the image file

data.images.labels.front.src

string<uri>

Full URL to access the image

data.images.labels.front.alt

string | null

Alternative text for accessibility

data.images.labels.front.mimeType

string

MIME type of the image (e.g., image/jpeg, image/png)

data.images.labels.front.filename

string

Original filename of the uploaded image

data.images.labels.back

object[]

Back label images

Show child attributes

data.images.labels.back.id

string<uuid>

Unique identifier for the image

data.images.labels.back.path

string

Relative path to the image file

data.images.labels.back.src

string<uri>

Full URL to access the image

data.images.labels.back.alt

string | null

Alternative text for accessibility

data.images.labels.back.mimeType

string

MIME type of the image (e.g., image/jpeg, image/png)

data.images.labels.back.filename

string

Original filename of the uploaded image

data.primaryImage

object

Primary product image

Show child attributes

data.primaryImage.id

string<uuid>

Unique identifier for the image

data.primaryImage.path

string

Relative path to the image file

data.primaryImage.src

string<uri>

Full URL to access the image

data.primaryImage.alt

string | null

Alternative text for accessibility

data.primaryImage.mimeType

string

MIME type of the image (e.g., image/jpeg, image/png)

data.primaryImage.filename

string

Original filename of the uploaded image

data.price

string

Formatted price (e.g., £10.00). For pick-and-mix subscriptions with per-item pricing, may show 'from £X.XX'

data.salePrice

string | null

Formatted sale price if on sale

data.subscriberPrice

string | null

Special price for subscribers. Not shown for subscription products

data.createdAt

string<date-time>

Creation timestamp

data.updatedAt

string<date-time>

Last update timestamp

data.store_slug

string

Store URL slug

data.subscriptions_slug

string

Subscriptions URL slug

data.availability

enum<string>

Product availability

Available options:

all,

subscribers

data.upsell_products

object[]

Upsell products with simplified data

Show child attributes

data.upsell_products.id

string

Product ID

data.upsell_products.name

string

Product name

data.upsell_products.sku

string

Product SKU

data.upsell_products.price

string

Formatted price

data.upsell_products.sale_price

string | null

Formatted sale price

data.upsell_products.subscriber_price

string | null

Formatted subscriber price

data.linkedSubscriptions

object[]

Full details of linked subscriptions. Only included when requested via the include query parameter.

Show child attributes

data.linkedSubscriptions.id

string<uuid>

Subscription ID

data.linkedSubscriptions.name

string

Subscription name

data.linkedSubscriptions.options

object

Subscription options

data.linkedSubscriptions.status

string

Subscription status

data.linkedSubscriptions.start_date

string<date>

Subscription start date

data.linkedSubscriptions.end_date

string<date>

Subscription end date

data.linkedSubscriptions.next_billing_date

string<date>

Next billing date

data.linkedSubscriptions.billing_interval

integer

Billing interval in months

data.linkedSubscriptions.created_at

string<date-time>

Creation timestamp

data.billing_frequency

integer

Billing frequency in months. Only present for subscription products

data.billing_frequencies

integer[]

Available billing frequencies. Only present for subscription products

data.pricing_type

enum<string>

Pricing type for subscriptions. Only present for subscription products

Available options:

fixed,

per_item

data.bundle_items

object[]

Items included in bundle. Only present for bundle products

data.attributes

object[]

Product attributes like color, size, etc.

data.options

object[]

Product options with their possible values

Get Started

Account

CMS

Subscriptions

Search

Products

Authorizations

Query Parameters

Response