Open this in Magpie

A products file brings a whole catalog into the Store in one go: each product's title, description, brand, type, tags, options, prices, stock, specifications and photos. It is a JSON file in the format below, or a ZIP holding that file as products.json beside its photos.

Importing

On Products, open the More menu and choose Import products, then choose the file. A ZIP can be up to 500 MB, and its products.json up to 20 MB, with up to 2,000 products. Before anything changes, the import page lists:

  • the products it will add, with how many variants and photos each has;
  • products it will skip because the Store imported them before;
  • products that cannot be imported, and why;
  • photos that will be left out, such as a photo the ZIP does not hold.

Select Import to go ahead, or Cancel. Each product is added as a draft. Check it, then make it live from its page, or tick the drafts in the Products list and choose Make live.

A file with more than 10 products or 20 photos will be imported in the background, usually starting within a minute. The import's page shows how many products are done as it goes, then the result, and you will get an email when it is finished. If the import is interrupted, it starts again by itself and skips the products it already added.

Photos are added to Your images and use Personal's storage. When that storage is full, the remaining photos are left out and listed; the products are still added.

Importing the same file again

A product with a sourceId is imported once. Importing a file again, or a newer file from the same place, adds only the products the Store has not imported before. Products already imported are not changed.

Details the Store does not show

Every field of a product in the file is kept with the product it made, including fields the Store has no place for, such as a listing's like count on the site it came from.

The format

{
  "format": "magpie-products",
  "version": 1,
  "currency": "CAD",
  "source": { "platform": "poshmark", "url": "https://poshmark.ca/closet/example" },
  "products": [
    {
      "sourceId": "6aee38571b53fe835caa5fcc",
      "sourceUrl": "https://poshmark.ca/listing/6aee38571b53fe835caa5fcc",
      "title": "Vintage knit cardigan",
      "description": "Length 26 inches.",
      "vendor": "Vintage",
      "category": "Sweaters",
      "tags": ["Women", "Cardigans"],
      "options": [{ "name": "Size", "values": ["S", "M"] }],
      "variants": [
        { "options": { "Size": "S" }, "price": "150.00", "stock": 1 },
        { "options": { "Size": "M" }, "price": "150.00", "stock": 2 }
      ],
      "specifications": [{ "name": "Condition", "value": "Like new" }],
      "images": [
        { "file": "images/6aee38571b53fe835caa5fcc/1.jpg", "alt": "Front" },
        { "url": "https://example.com/photos/back.jpg" }
      ]
    }
  ]
}
  • format and version are required. currency is the prices' currency; it must be the Store's. Without it, prices are read in the Store's currency.
  • source.platform names where the products came from. Together with each product's sourceId, it is how a product imported before is recognised.
  • A product needs a title. Every other field is optional.
  • vendor is the brand, and category is the category.
  • options are up to three, such as Size and Colour. Each variant names a value for every option. A product without options or variants can give price and stock itself.
  • price and compareAtPrice are written as amounts, such as "24.00". stock is a whole number. A variant can also have sku, barcode and weightGrams.
  • images are up to 20, in the order they will show. file is a path inside the ZIP; url is a public web address, and the Store downloads the photo from it.
  • kind is physical (the default) or digital.

If a background import has not finished after an hour, Contact support.

Ask Magpie support

Send Magpie staff a question about anything this article does not answer.