Advanced uses and examples

The plugin also exposes its internal utilities so that you can use only the parts that you need without using the entire plugin. This is useful if you want to build your own ecommerce solution on top of Payload.

Using only the collections

You can import the collections directly from the plugin and add them to your Payload configuration. This way, you can use the collections without using the entire plugin:

createAddressesCollection

Use this to create the addresses collection. This collection is used to store customer addresses. It takes the following properties:

The access object can contain the following properties:

See the access control section for more details on each of these functions.

Example usage:

import { createAddressesCollection } from 'payload-plugin-ecommerce'

const Addresses = createAddressesCollection({
  access: {
    isAdmin,
    isAuthenticated,
    isCustomer,
    isDocumentOwner,
  },
  addressFields: [
    {
      name: 'company',
      type: 'text',
      label: 'Company',
    },
  ],
})

createCartsCollection

Use this to create the carts collection to store customer carts. It takes the following properties:

The access object can contain the following properties:

See the access control section for more details on each of these functions.

Example usage:

import { createCartsCollection } from 'payload-plugin-ecommerce'

const Carts = createCartsCollection({
  access: {
    isAdmin,
    isAuthenticated,
    isDocumentOwner,
  },
  enableVariants: true,
  currenciesConfig: {
    defaultCurrency: 'usd',
    currencies: [
      {
        code: 'usd',
        symbol: '$',
      },
      {
        code: 'eur',
        symbol: '€',
      },
    ],
  },
})

createOrdersCollection

Use this to create the orders collection to store customer orders. It takes the following properties:

The access object can contain the following properties:

See the access control section for more details on each of these functions.

Example usage:

import { createOrdersCollection } from 'payload-plugin-ecommerce'

const Orders = createOrdersCollection({
  access: {
    isAdmin,
    isDocumentOwner,
    adminOnlyFieldAccess,
  },
  enableVariants: true,
  currenciesConfig: {
    defaultCurrency: 'usd',
    currencies: [
      {
        code: 'usd',
        symbol: '$',
      },
      {
        code: 'eur',
        symbol: '€',
      },
    ],
  },
  addressFields: [
    {
      name: 'deliveryInstructions',
      type: 'text',
      label: 'Delivery Instructions',
    },
  ],
})

createTransactionsCollection

Use this to create the transactions collection to store payment transactions. It takes the following properties:

The access object can contain the following properties:

See the access control section for more details on each of these functions.

Example usage:

import { createTransactionsCollection } from 'payload-plugin-ecommerce'

const Transactions = createTransactionsCollection({
  access: {
    isAdmin,
  },
  enableVariants: true,
  currenciesConfig: {
    defaultCurrency: 'usd',
    currencies: [
      {
        code: 'usd',
        symbol: '$',
      },
      {
        code: 'eur',
        symbol: '€',
      },
    ],
  },
  addressFields: [
    {
      name: 'billingInstructions',
      type: 'text',
      label: 'Billing Instructions',
    },
  ],
  paymentMethods: [
    // Add your payment adapters here
  ],
})

createProductsCollection

Use this to create the products collection to store products. It takes the following properties:

The access object can contain the following properties:

See the access control section for more details on each of these functions.

Example usage:

import { createProductsCollection } from 'payload-plugin-ecommerce'

const Products = createProductsCollection({
  access: {
    isAdmin,
    adminOrPublishedStatus,
  },
  enableVariants: true,
  currenciesConfig: {
    defaultCurrency: 'usd',
    currencies: [
      {
        code: 'usd',
        symbol: '$',
      },
      {
        code: 'eur',
        symbol: '€',
      },
    ],
  },
  inventory: {
    enabled: true,
    trackByVariant: true,
    lowStockThreshold: 5,
  },
})

createVariantsCollection

Use this to create the variants collection to store product variants. It takes the following properties:

The access object can contain the following properties:

See the access control section for more details on each of these functions.

Example usage:

import { createVariantsCollection } from 'payload-plugin-ecommerce'

const Variants = createVariantsCollection({
  access: {
    isAdmin,
    adminOrPublishedStatus,
  },
  currenciesConfig: {
    defaultCurrency: 'usd',
    currencies: [
      {
        code: 'usd',
        symbol: '$',
      },
      {
        code: 'eur',
        symbol: '€',
      },
    ],
  },
  inventory: {
    enabled: true,
    lowStockThreshold: 5,
  },
})

createVariantTypesCollection

Use this to create the variantTypes collection to store variant types. It takes the following properties:

The access object can contain the following properties:

See the access control section for more details on each of these functions.

Example usage:

import { createVariantTypesCollection } from 'payload-plugin-ecommerce'

const VariantTypes = createVariantTypesCollection({
  access: {
    isAdmin,
    publicAccess,
  },
})

createVariantOptionsCollection

Use this to create the variantOptions collection to store variant options. It takes the following properties:

The access object can contain the following properties:

See the access control section for more details on each of these functions.

Example usage:

import { createVariantOptionsCollection } from 'payload-plugin-ecommerce'

const VariantOptions = createVariantOptionsCollection({
  access: {
    isAdmin,
    publicAccess,
  },
})

Typescript

There are several common types that you'll come across when working with this package. These are export from the package as well and are used across individual utilities as well.

CurrenciesConfig

Defines the supported currencies in Payload and the frontend. It has the following properties:

Currency

Defines a currency to be used in the application. It has the following properties:

The decimals is very important to provide as we store all prices as integers to avoid floating point issues. For example, if you're using USD, you would store a price of $10.00 as 1000 (10 * 10^2), so when formatting the price for display we need to know how many decimal places the currency supports.

CountryType

Used to define a country in address fields and supported countries lists. It has the following properties:

InventoryConfig

It's used to customise the inventory tracking settings on products and variants. It has the following properties: