Create Product

Create a new product.

Path Parameters

  • site_namerequired

Query Parameters

    Request Body Parameters

    • pricerequired
    • productrequired
    • currencyrequired
    • unit_amountrequired
    • product_category_idrequired
    • taxoptional
    • dateoptional
    • slugoptional
    • orderoptional
    • customoptional
    • option1optional
    • option2optional
    • option3optional
    • recurringoptional
    • descriptionoptional
    • slug_prefixoptional
    • tax_behavioroptional
    • attachment_idsoptional
    • product_modifiedoptional
    • quantity_availableoptional
    • stripe_descriptionoptional

    Authentication Header

    • x-api-keyrequired
    ENDPOINT
    POST /v1/{site_name}/products
    REQUEST
    {
      "slug": "gbv-under-bushes-stars-vinyl",
      "order": 1,
      "price": 20,
      "product": "Guided By Voices - Under the Bushes Under the Stars",
      "currency": "USD",
      "description": "The 1996 classic album 'Under the Bushes Under the Stars' by Guided by Voices. This edition comes in a beautiful vinyl format, perfect for collectors and fans alike.",
      "unit_amount": 1,
      "quantity_available": 50,
      "stripe_description": "GBV - Under the Bushes",
      "product_category_id": 2
    }
    RESPONSE BODY
    {
      "slug": "gbv-bee-thousand-vinyl",
      "media": [
        {
          "link": "https://gbvstore.com/media/bee-thousand-vinyl.jpg",
          "size": "500x500",
          "title": "Bee Thousand Vinyl Cover",
          "width": 500,
          "height": 500,
          "caption": "Front cover of Bee Thousand vinyl.",
          "filesize": 102400,
          "media_id": 100,
          "file_name": "bee-thousand-vinyl.jpg",
          "site_name": "GBV Official Store",
          "media_date": "2024-03-20T00:00:00Z",
          "description": "Bee Thousand album cover art.",
          "is_original": true,
          "content_type": "image/jpeg",
          "is_thumbnail": false,
          "original_url": "https://gbvstore.com/media/bee-thousand-vinyl.jpg",
          "attachment_id": 200
        }
      ],
      "order": 1,
      "price": 25,
      "product": "Guided by Voices - Bee Thousand Vinyl",
      "currency": "USD",
      "product_id": 1,
      "description": "A reissue of the classic 1994 album 'Bee Thousand' by Guided by Voices on high-quality vinyl. Includes a digital download code.",
      "unit_amount": 1,
      "product_date": "2024-03-20T00:00:00Z",
      "product_modified": "2024-03-21T00:00:00Z",
      "quantity_available": 100,
      "stripe_description": "GBV Bee Thousand Vinyl",
      "product_category_id": 10,
      "stripe_product_id_live": "prod_live_1234",
      "stripe_product_id_test": "prod_test_5678"
    }
    RESPONSE STATUS CODE
    200