Sign in
Product

Create a new product.

Create a new product.

post/admin/products.json

Request body

Example request

{
  "product": {
    "body_html": "<p>It's the small iPod with a big idea: Video.<p>",
    "custom_options": [
      {
        "active": true,
        "default_value": "default value",
        "default_value_index": 1,
        "font_family": "arial",
        "font_path": "https://example.com/font_path.tff",
        "help_text": "example",
        "id": "123443",
        "label": "example label",
        "name": "example name",
        "placeholder": "example",
        "rules": [
          {
            "conditions": [
              {
                "relation": "equals",
                "value": "Hair"
              }
            ],
            "show_option_ids": [
              "1123123",
              "3453567"
            ]
          }
        ],
        "type": "text",
        "validations": {
          "allowed_characters": [
            "symbol"
          ],
          "max_length": 50,
          "min_size": 50,
          "required": true
        },
        "values": [
          {
            "text": "Option text",
            "value": "Option value"
          }
        ]
      }
    ],
    "display_options": {
      "group_options_by": 1
    },
    "handle": "ipod-nano-8gb",
    "images": [
      {
        "position": 1,
        "src": "https://theme.hstatic.net/1000003443/1000386436/14/partner-shopbase.jpg?v=3381"
      }
    ],
    "metafields_global_description_tag": "It's the small iPod with a big idea: Video.",
    "metafields_global_title_tag": "IPod Nano - White, 8GB",
    "options": [
      {
        "id": 1002,
        "name": "color",
        "position": 1,
        "product_id": 632910392,
        "values": [
          "red",
          " blue",
          " green"
        ]
      }
    ],
    "product_availability": 7,
    "product_type": "Cult Products",
    "published": true,
    "tags": "Emotive, Flash Memory, MP3, Music",
    "title": "IPod Nano - 8GB",
    "variants": [
      {
        "barcode": "9 788073 400972",
        "compare_at_price": 200,
        "fulfillment_service": "shopbase",
        "id": 632910392,
        "image_id": 434522,
        "inventory_management": "shopbase",
        "inventory_quantity": 100,
        "is_default": true,
        "option1": "IPOD2008PINK",
        "price": 100,
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "title": "IPod Nano - 8GB",
        "weight": 12,
        "weight_unit": "12"
      }
    ],
    "vendor": "Apple"
  }
}

Response

OK

Example response

{
  "product": {
    "body_html": "<p>It's the small iPod with a big idea: Video.<p>",
    "custom_options": [
      {
        "active": true,
        "default_value": "default value",
        "default_value_index": 1,
        "font_family": "arial",
        "font_path": "https://example.com/font_path.tff",
        "help_text": "example",
        "id": "123443",
        "label": "example label",
        "name": "example name",
        "placeholder": "example",
        "rules": [
          {
            "conditions": [
              {
                "relation": "equals",
                "value": "Hair"
              }
            ],
            "show_option_ids": [
              "1123123",
              "3453567"
            ]
          }
        ],
        "type": "text",
        "validations": {
          "allowed_characters": [
            "symbol"
          ],
          "max_length": 50,
          "min_size": 50,
          "required": true
        },
        "values": [
          {
            "text": "Option text",
            "value": "Option value"
          }
        ]
      }
    ],
    "display_options": {
      "group_options_by": 1
    },
    "fulfillment_services": [
      {
        "can_remove_mapping": true,
        "is_mapped": true,
        "service_name": "Service name"
      }
    ],
    "handle": "ipod-nano-8gb",
    "id": 632910392,
    "image": {
      "alt_text": "ipod-nano-xin",
      "height": 480,
      "id": 850703190,
      "position": 1,
      "product_id": 632910392,
      "src": "https://img.btdmp.com/products/ipod-nano.png",
      "width": 640
    },
    "images": [
      {
        "alt_text": "ipod-nano-xin",
        "height": 480,
        "id": 850703190,
        "position": 1,
        "product_id": 632910392,
        "src": "https://img.btdmp.com/products/ipod-nano.png",
        "width": 640
      }
    ],
    "metafields_global_description_tag": "It's the small iPod with a big idea: Video.",
    "metafields_global_title_tag": "IPod Nano - White, 8GB",
    "options": [
      {
        "id": 1002,
        "name": "color",
        "position": 1,
        "product_id": 632910392,
        "values": [
          "red",
          " blue",
          " green"
        ]
      }
    ],
    "product_availability": 7,
    "product_type": "Cult Products",
    "published": true,
    "tags": "Emotive, Flash Memory, MP3, Music",
    "title": "IPod Nano - 8GB",
    "variants": [
      {
        "barcode": "9 788073 400972",
        "compare_at_price": 200,
        "fulfillment_service": "Shop base fulfillment",
        "id": 632910392,
        "image_id": 434522,
        "inventory_management": "shopbase",
        "inventory_quantity": 100,
        "is_default": true,
        "option1": "IPOD2008PINK",
        "position": 1,
        "price": 100,
        "product_id": 632910392,
        "requires_shipping": true,
        "sku": "null",
        "taxable": true,
        "title": "IPod Nano - 8GB",
        "weight": 12,
        "weight_unit": "12"
      }
    ],
    "vendor": "Apple"
  }
}

Changes