Omnivore Support

Example 1

A minimal data set to create a product

{
  "sku": "TEST1",
  "name": "Test 1 Example Product",
  "description": "Html text describing the product.",
  "active": true,
  "variants": [
    {
      "sku": "TEST1",
      "sell_price": {
        "with_tax": "11.00",
        "without_tax": "10.00",
        "tax": "1.00",
        "currency": "AUD"
      },
      "quantity": 1,
      "images": [
        "https://example.com/image1.jpg"
      ]
    }
  ]
}

Example 2

A minimal data set to create a product with colour-based variants

{
  "sku": "TEST2",
  "name": "Test 2 Example Product",
  "description": "Product with colour-based variants.",
  "active": true,
  "variants": [
    {
      "sku": "TEST2-RED",
      "sell_price": {
        "with_tax": "11.00",
        "without_tax": "10.00",
        "tax": "1.00",
        "currency": "AUD"
      },
      "quantity": 2,
      "options": [
        {
          "name": "Colour",
          "value": "Red"
        }
      ],
      "images": [
        "https://example.com/image21.jpg"
      ]
    },
    {
      "sku": "TEST2-BLUE",
      "sell_price": {
        "with_tax": "11.00",
        "without_tax": "10.00",
        "tax": "1.00",
        "currency": "AUD"
      },
      "quantity": 3,
      "options": [
        {
          "name": "Colour",
          "value": "Blue"
        }
      ],
      "images": [
        "https://example.com/image22.jpg"
      ]
    }
  ]
}

Example 3

A minimal data set to create a product with colour and size variants where variants have different prices based on size

{
  "sku": "TEST3",
  "name": "Test 3 Example Product",
  "description": "Product with colour and size variants.",
  "active": true,
  "variants": [
    {
      "sku": "TEST3-RED-S",
      "sell_price": {
        "with_tax": "11.00",
        "without_tax": "10.00",
        "tax": "1.00",
        "currency": "AUD"
      },
      "quantity": 2,
      "options": [
        {
          "name": "Colour",
          "value": "Red"
        },
        {
          "name": "Size",
          "value": "Small"
        }
      ],
      "images": [
        "https://example.com/image3rs.jpg"
      ]
    },
    {
      "sku": "TEST3-BLU-S",
      "sell_price": {
        "with_tax": "11.00",
        "without_tax": "10.00",
        "tax": "1.00",
        "currency": "AUD"
      },
      "quantity": 3,
      "options": [
        {
          "name": "Colour",
          "value": "Blue"
        },
        {
          "name": "Size",
          "value": "Small"
        }
      ],
      "images": [
        "https://example.com/image3bs.jpg"
      ]
    },
    {
      "sku": "TEST3-RED-L",
      "sell_price": {
        "with_tax": "22.00",
        "without_tax": "20.00",
        "tax": "2.00",
        "currency": "AUD"
      },
      "quantity": 4,
      "options": [
        {
          "name": "Colour",
          "value": "Red"
        },
        {
          "name": "Size",
          "value": "Large"
        }
      ],
      "images": [
        "https://example.com/image3rl.jpg"
      ]
    },
    {
      "sku": "TEST3-BLU-L",
      "sell_price": {
        "with_tax": "22.00",
        "without_tax": "20.00",
        "tax": "2.00",
        "currency": "AUD"
      },
      "quantity": 5,
      "options": [
        {
          "name": "Colour",
          "value": "Blue"
        },
        {
          "name": "Size",
          "value": "Large"
        }
      ],
      "images": [
        "https://example.com/image3bl.jpg"
      ]
    }
  ]
}