Store

The following documentation is for Store v6+. DataGrab no longer supports previous versions of Store. If you are upgrading from an older version of ExpressionEngine, DataGrab, or Store it is recommended to delete and re-configure the DataGrab import from scratch.

Example Import File

When configuring an import for Store, the JSON or XML properties for the top level elements of Price, Weight, Width, Length, Height, Handling surcharge, and Free shipping can be of any name or any location in the file. For simplicity sake the example below uses the same property names as the field names.

The Modifiers and Stock properties must follow the same data structure found in the example below. This is critical to properly import new and update existing modifiers and product stock. When selecting the modifier and stock properties from your import file you can select any immediate sub-property. In the example below "type" is selected for modifiers, but "name", "instructions", or "options" could just as easily be chosen. For clarity we recommend selecting the first sub-property "type".

[
  {
    "title": "Product #1",
    "price": "100.00",
    "length": "20",
    "width": "10",
    "height": "5",
    "weight": "2",
    "handling": "3.00",
    "free_shipping": "1",
    "modifiers": [
      {
        "type": "var",
        "name": "Small",
        "instructions": "Turn Left X",
        "options": [
          {
            "name": "cyan",
            "price": "-11.00"
          },
          {
            "name": "magenta",
            "price": "-21.00"
          }
        ]
      },
      {
        "type": "var",
        "name": "Medium",
        "instructions": "Turn Right Y",
        "options": [
          {
            "name": "yellow",
            "price": "+5.00"
          },
          {
            "name": "black",
            "price": "+10.00"
          }
        ]
      }
    ],
    "stock": [
      {
        "sku": "cyan-yellow",
        "track_stock": "0",
        "stock_level": "30",
        "min_order_qty": "1"
      },
      {
        "sku": "cyan-black",
        "track_stock": "0",
        "stock_level": "20",
        "min_order_qty": "2"
      },
      {
        "sku": "magenta-yellow",
        "track_stock": "0",
        "stock_level": "10",
        "min_order_qty": "3"
      },
      {
        "sku": "magenta-black",
        "track_stock": "0",
        "stock_level": "5",
        "min_order_qty": "4"
      }
    ]
  },
  {
    "title": "Product #2",
    "price": "200.00",
    "length": "200",
    "width": "100",
    "height": "5",
    "weight": "2",
    "handling": "3.00",
    "free_shipping": "0",
    "modifiers": [
      {
        "type": "var_single_sku",
        "name": "Small",
        "instructions": "ABC",
        "options": [
          {
            "name": "apple",
            "price": "-11.00"
          },
          {
            "name": "orange",
            "price": "-21.00"
          }
        ]
      },
      {
        "type": "var",
        "name": "Medium",
        "instructions": "XYZ",
        "options": [
          {
            "name": "grape",
            "price": "+5.00"
          },
          {
            "name": "banana",
            "price": "+10.00"
          }
        ]
      }
    ]
  }
]

Another example of an import file that will work. Note the modifiers and options sub-property names remain unchanged.

[
  {
    "productInfo": {
      "name": "Product #3",
      "cost": "100.00",
      "l": "20",
      "w": "10",
      "h": "5",
      "w": "2",
      "shippingHandling": "3.00",
      "freeShipping": "1",
    },
    "productOptions": {
       "options": [
          {
            "type": "var",
            "name": "Small",
            "instructions": "Turn Left X",
            "options": [
              {
                "name": "cyan",
                "price": "-11.00"
              },
              {
                "name": "magenta",
                "price": "-21.00"
              }
            ]
          },
          {
            "type": "var",
            "name": "Medium",
            "instructions": "Turn Right Y",
            "options": [
              {
                "name": "yellow",
                "price": "+5.00"
              },
              {
                "name": "black",
                "price": "+10.00"
              }
            ]
          }
        ],
        "stockWithSkus": [
          {
            "sku": "cyan-yellow",
            "track_stock": "0",
            "stock_level": "30",
            "min_order_qty": "1"
          },
          {
            "sku": "cyan-black",
            "track_stock": "0",
            "stock_level": "20",
            "min_order_qty": "2"
          },
          {
            "sku": "magenta-yellow",
            "track_stock": "0",
            "stock_level": "10",
            "min_order_qty": "3"
          },
          {
            "sku": "magenta-black",
            "track_stock": "0",
            "stock_level": "5",
            "min_order_qty": "4"
          }
        ]
      }
    }
  }
]