Products

Build one product catalog and reuse it across supported PayMongo Payment Channels.

Products lets you keep one catalog of the items you sell. Add a product once, then reuse it in supported Payment Channels such as Storefront and Order & Pay.

You can manage your catalog in the Dashboard or with the Products API.

When to use

Use Products when you sell more than one item or use more than one Payment Channel that displays a catalog, such as Storefront and Order & Pay.

Products is useful when you:

  • Want to maintain one catalog instead of separate item lists for each channel
  • Need to update product information without re-entering it in every channel
  • Sell items that come in different sizes, colors, or other options
  • Want to sync your catalog from your own inventory or POS system

Key Concepts

TermWhat it means
ProductAn item you sell. A product has a name, a description, images, and a price.
OptionA way that a product varies, such as Size or Color. Each option has a list of values, such as S, M, and L.
VariantOne combination of option values, such as Size: M / Color: Black. Each variant has its own price.

Add a Product in the Dashboard

  1. View the product list

    Go to Payment Channels → Products to review the items in your merchant catalog and find the product you want to manage.

    View the product list
  2. Create a product

    Add a product to your catalog so it can be used in supported Payment Channels.

    Create a product
  3. View product details

    Select a product from the list to review the information saved for that item.

    View product details
  4. Update a product

    Edit the product details to keep your catalog current across the supported Payment Channels that use it.

    Update a product
  5. Use Products in Payment Channels

    Add products from your catalog when setting up supported Payment Channels, so you can reuse the same product information across channels.

    Use Products in Storefront

    Products in Storefront

    Use Products in Order and Pay

    Products in Order and Pay

Manage Products with the API

Use the Products API to create and update your catalog from your own system, such as an inventory tool or POS. The steps below show the most common flow. For every field and parameter, see the Products API reference.

  1. Create a product

    Send the product details to Create a product. name, description, type, and status are required.

    Use external_code to store your own SKU. Each external_code must be unique in your account.

    curl -X POST https://api.paymongo.com/v1/products \
      -u sk_test_xxxxxxxx: \
      -H "Content-Type: application/json" \
      -d '{
        "name": "Premium T-Shirt",
        "description": "100% cotton, unisex",
        "type": "physical",
        "status": "active",
        "price": 150000,
        "currency": "PHP",
        "external_code": "tee-001"
      }'

    The response returns the new product. Save its id for the next steps.

    {
      "data": {
        "id": "prdct_abc123",
        "name": "Premium T-Shirt",
        "price": 150000,
        "currency": "PHP",
        "status": "active",
        "has_variants": false,
        ...
      }
    }
  2. Add options and variants

    To sell the product in different versions, use Replace a product's variant matrix.

    • options lists each option and its values.
    • variants lists each combination. Use option_values to name the combination, and set a price for each variant.
    curl -X PUT https://api.paymongo.com/v1/products/prdct_abc123/variants \
      -u sk_test_xxxxxxxx: \
      -H "Content-Type: application/json" \
      -d '{
        "options": [
          { "name": "Size", "values": ["S", "M", "L"] }
        ],
        "variants": [
          { "option_values": { "Size": "S" }, "price": 150000, "external_code": "tee-001-s" },
          { "option_values": { "Size": "M" }, "price": 150000, "external_code": "tee-001-m" },
          { "option_values": { "Size": "L" }, "price": 165000, "external_code": "tee-001-l" }
        ]
      }'

    The response returns the options and the variants. Each variant has an id that starts with prdvar_.

    Send the full set every time

    This request replaces all of the product's options and variants. To add a value later, such as size XL, send every option and variant again with the new value. Variants that are not in the request are removed.

  3. Update a product

    To change product details, send only the fields that change to Update a product.

    curl -X PATCH https://api.paymongo.com/v1/products/prdct_abc123 \
      -u sk_test_xxxxxxxx: \
      -H "Content-Type: application/json" \
      -d '{
        "description": "100% cotton, unisex. Pre-shrunk.",
        "status": "active"
      }'
  4. Update a variant

    To change one variant, such as its price, send the fields to Update a variant.

    curl -X PATCH https://api.paymongo.com/v1/products/prdct_abc123/variants/prdvar_abc123 \
      -u sk_test_xxxxxxxx: \
      -H "Content-Type: application/json" \
      -d '{
        "price": 160000
      }'
  5. List and retrieve products

    Use List products to read your catalog. Use q to search by name or description, and limit to set the page size.

    curl "https://api.paymongo.com/v1/products?q=shirt&limit=20" \
      -u sk_test_xxxxxxxx:

    If has_more is true, request the next page with after set to the id of the last product in the list.

    Use Get a product to retrieve one product with its options and variants. Add images_format=url to receive image URLs instead of file IDs.

    curl "https://api.paymongo.com/v1/products/prdct_abc123?images_format=url" \
      -u sk_test_xxxxxxxx:
  6. Remove products and variants

    • To remove a product from your catalog, use Delete a product.
    • To remove one variant, use Delete a variant. You cannot delete a product's default variant or its last active variant.

Did this page help you?