Create a Product

Endpoint

POST /products/create

Required parameters

• title - VARCHAR(500) - The title of your product
• url - VARCHAR(100) - The vanity URL for your product. Must be unique and contain alphanumeric, underscore, hyphen, or dot characters only.
• currency - VARCHAR(3) - The lower-cased 3-letter ISO currency code for your product
• price - DECIMAL - The base price of your product
• pricing_model - VARCHAR(20) - The pricing model for your product, values can be:
  1. one-time - This is for one-time payments.
  2. subscription - This is for recurring payments.
  3. delayed - This is for delayed payments using credit card pre-authorization.
• display - VARCHAR(11) - The display for your product, values can be:
  1. featured - Product appears as a large splash image/carousel at the top of your storefront.
  2. listed - Product appears as a listing in a grid.
  3. unlisted - Product does not appear in storefront but is still accessible to anyone with its link.
  4. unpublished - Product is not accessible to the public whatsoever.

Optional parameters

• subtitle - VARCHAR(500) - The subtitle of your product, which appears below the title
• description - TEXT - The description for your product, which should be in HTML format.
• summary - TEXT - The summary for your product, which should be in HTML format.
• interval - VARCHAR(5) - The interval for your subscription product.
  Required if pricing_model is set to subscription.
  Values can be:
  1. day - The subscriber will be charged every interval_count day(s).
  2. week - The subscriber will be charged every interval_count week(s).
  3. month - The subscriber will be charged every interval_count month(s).
  4. year - The subscriber will be charged every interval_count year(s).
• interval_count - INT - How often to charge the subscriber based on interval_count.
  Required if pricing_model is set to subscription.
• trial_period_days - INT - Number of days of free trial before the subscriber is charged.
  Applicable only if pricing_model is set to subscription.
• collect_address_and_phone - BOOLEAN - Whether to collect buyer's address and phone number at checkout. Defaults to False.
• shipping_fee - DECIMAL - If this is a shipped product, this is the shipping fee for the product.
• shipping_type - VARCHAR(12) - The shipping fee type for your product. Values can be:
  1. flat - The shipping fee will be fixed regardless of the quantity of this product added to the cart.
  2. per_quantity - The shipping fee will be additive/cumulative and added per quantity of this product added to the cart.
• categories - ARRAY - List of categories under which to put this product. If a given category doesn't exist, it will be created.
• tags - ARRAY - List of tags to apply to this product. If a given tag doesn't exist, it will be created.
• productimages - ARRAY - List of URLs of images for this product. Make sure your URLs are publicly accessible.
• productfiles - ARRAY - List of URLs of files for this product. Make sure your URLs are publicly accessible.

Example request

  
    curl https://api.zylvie.com/products/create \
      -h "Authorization: Bearer e97f0aafe4884bc380c81fdb2347dc55" \
      -d "title=Beautiful Product A" \
      -d "url=beautiful-product-a" \
      -d "currency=usd" \
      -d "price=19.99" \
      -d "pricing_model=subscription" \
      -d "display=listed" \
      -d "subtitle=The most beautiful product in the world, you won't need any other!" \
      -d "description=<p>This is the best product ever.</p><p>Check out more <a href='#'>here</a>!</p>"
      -d "summary=<p>What you'll get:</p><ol><li>A good product</li><li>A generous refund policy</li><li>The best customer service in the world</li>" \
      -d "interval=month" \
      -d "interval_count=1" \
      -d "trial_period_days=" \
      -d "collect_address_and_phone=false" \
      -d "shipping_fee=2" \
      -d "shipping_type=per_quantity" \
      -d "categories[]=Online Courses" \
      -d "categories[]=Digital Downloads" \
      -d "categories[]=Business Resources" \
      -d "tags[]=passive-income" \
      -d "tags[]=entrepreneur" \
      -d "tags[]=marketing" \
      -d "tags[]=business-strategy" \
      -d "productimages[]=https://cdn.example.com/products/phone-blue-angle.jpg" \
      -d "productimages[]=https://cdn.example.com/products/phone-front-view.jpg" \
      -d "productimages[]=https://cdn.example.com/products/phone-features.jpg" \
      -d "productfiles[]=https://downloads.example.com/manuals/phone-user-guide.pdf" \
      -d "productfiles[]=https://downloads.example.com/specs/phone-technical-specs.pdf" \
      -d "productfiles[]=https://downloads.example.com/warranty/phone-warranty-card.pdf"
  

Example response

  
    {
      "id": "6v8Obm2M", //Product ID
      "created": 1690952000, //UTC timestamp
      "title": "Beautiful Product A",
      "url": "beautiful-product-a",
      "currency": "usd",
      "price": 19.99,
      "pricing_model": "subscription",
      "display": "listed",
      "subtitle": "The most beautiful product in the world, you won't need any other!",
      "description": "<p>This is the best product ever.</p><p>Check out more <a href='#'>here</a>!</p>",
      "summary": "<p>What you'll get:</p><ol><li>A good product</li><li>A generous refund policy</li><li>The best customer service in the world</li>",
      "interval": "month",
      "interval_count": 1,
      "trial_period_days": null,
      "collect_address_and_phone": false,
      "shipping_fee": 2,
      "shipping_type": "per_quantity",
      "categories": [
        "Online Courses",
        "Digital Downloads",
        "Business Resources"
      ],
      "tags": [
        "passive-income",
        "entrepreneur",
        "marketing",
        "business-strategy"
      ],
      "productimages": [
        "https://cdn.example.com/products/phone-blue-angle.jpg",
        "https://cdn.example.com/products/phone-front-view.jpg",
        "https://cdn.example.com/products/phone-features.jpg"
      ],
      "productfiles": [
        "https://downloads.example.com/manuals/phone-user-guide.pdf",
        "https://downloads.example.com/specs/phone-technical-specs.pdf",
        "https://downloads.example.com/warranty/phone-warranty-card.pdf"
      ]
    }