Product export-import CSV Specification

Get a sample .csv file

You can download and view a sample product CSV file to use as a template for creating your own.

Note

Remember to remove the example products.


Product CSV File Format

Header Fields Data Type Rules Side Notes
Product Id TEXT Generated by the platform. It is the unique product id for each and every product in primo. Make it empty when import a CSV file.
Product Name TEXT Required Field. Maximum 255 character. The name of the product.
Product Number TEXT Optional. Can be NULL or maximum 128 character. Product number as extra information of the product.
Currency ENUM Required Field.
One of the following:
USD, JPY, GBP, EUR, AUD, CAD
The currency of product price. Must be set as same as in your merchant profile.
Price NUMBER FORMAT Required Field. Must be a positive integer. For JPY, do not set decimal point.
Minimum value are:
  • AUD: 0.5
  • CAD: 0.5
  • EUR: 0.5
  • GBP: 0.3
  • HKD: 4
  • JPY: 50
  • USD: 0.5
The price of the product.
Category ENUM Required Field.
One of the following:
  • Beauty
  • Cable/Broadband/Satellite etc
  • Credit Cards
  • DIY
  • Electronics
  • Everyday Goods
  • Fashion
  • Financial
  • Food
  • Garden
  • Health and Diet
  • Instruments/Hobbies
  • Interior/Furniture
  • Jobs
  • Kids
  • Others
  • Outdoor
  • Pets
  • Print Media
  • Real Estate
  • Service/Event/Seminar etc
  • Sports
  • Toys/Games
  • Used
  • Utilities
  • Vehicles
  • Video/Music/Software/Tickets
The category of the product. It will affect the grouping of product.
Description TEXT Optional. Can be NULL or maximum 65,535 characters The description of the product.
Primo Tag URL Generated by the platform. It is the unique tag for each and every product in primo. Please make this field, empty when import a CSV file.
Tax Type ENUM Required Field.
One of the following:
  • Amount
  • Percent (%)
The tax type of the product. It could be percentage of product price or a fixed amount of price.
Tax Amount NUMBER FORMAT Required Field. Must be a positive integer or 0. For JPY, do not set decimal point. The amount of the product tax. The calculation will depend on tax type.
Product Status ENUM Required Field.
One of the following:
  • Active
  • Disable
  • Hidden
The status of the product.
Shipping Domestic Option ENUM Required Field.
One of the following:
  • % of Product Price
  • Fixed Cost
  • Free
The shipping domestic cost type that will be charged on product purchased.
Shipping Domestic Amount NUMBER FORMAT Required Field if shipping domestic option value is % of product price or fixed cost. The amount of shipping domestic cost. The calculation will depend on shipping domestic option.
Shipping International Option ENUM Required Field.
One of the following:
  • % of Product Price
  • Fixed Cost
  • Free
  • Not Available
The shipping international cost type that will be charged on product purchased.
Shipping International Amount NUMBER FORMAT Required Field if shipping international option value is % of product price or fixed cost. The amount of shipping international cost. The calculation will depende on shipping international option.
Out Of Stock Action ENUM Required Field.
One of the following:
  • Buy in advance
  • Out of stock
  • Unlimited
The out of stock action of the product.
Product Variant Type ENUM Required Field.
One of the following:
  • None
  • Size & Color
  • Custom
The variant type of product inventory. It affect stock for product with different variant.
Inventory JSON Required Field. The content of inventory json structure will depend on product variant type.
Variant Type JSON Key Data Type Rules Side Notes
None stock_id TEXT Generated by the platform. It is the unique inventory id for each and every inventory in primo. Make it empty when import a CSV file.
quantity NUMBER FORMAT Required Field. Must be a positive integer or 0 Quantity of the product.

Sample JSON:

[
    {
        "stock_id": "31VlM5lNdr",
        "quantity": "10"
    }
]
Size & Color stock_id TEXT Generated by the platform. It is the unique inventory id for each and every inventory in primo. Make it empty when import a CSV file.
size_name TEXT Required Field. Maximum 128 character. The size name of the product inventory.
size_description TEXT Optional. Can be NULL or maximum 255 character. The size description of the product inventory.
color_name TEXT Required Field. Maximum 128 character. The color of the product inventory.
color_code TEXT Optional. Hex color code. Start with '#' symbol.
Example: #FF00FF
The color code of the product inventory.
quantity NUMBER FORMAT Required Field. Quantity of the product.
color_palette_search_index ENUM Required Field.
One of the following:
  • Beige
  • Black
  • Blue
  • Brown
  • Cyan
  • Dark Blue
  • Gray
  • Green
  • Light Blue
  • Magenta
  • Maroon
  • Olive
  • Orange
  • Pink
  • Purple
  • Red
  • Silver
  • Sky Blue
  • Violet
  • White
  • Yellow
The color search index of the product inventory. This will be used as future feature. Color code info:
Beige
#F5F5DC
Black
#000000
Blue
#0000FF
Brown
#A52A2A
Cyan
#00FF00
Dark Blue
#0000A0
Gray
#808080
Green
#008000
Light Blue
#ADD8E6
Magenta
#FF00FF
Maroon
#800000
Olive
#808000
Orange
#FFA500
Pink
#FFC0CB
Purple
#800080
Red
#FF0000
Silver
#C0C0C0
Sky Blue
#00BFFF
Violet
#EE82EE
White
#FFFFFF
Yellow
#FFFF00
display_order NUMBER FORMAT Required Field. Must be a positive integer The display order of the product inventory. It will affect on displaying list of inventory to user.
quantity NUMBER FORMAT Required Field. Must be a positive integer or 0 Quantity of the product.

Sample JSON:

[
    {
        "stock_id":"0MJo4G0lbA",
        "size_name":"M",
        "size_description":"medium",
        "color_name":"Red Rose",
        "color_code":"#470a0a",
        "color_palette_search_index":"Red",
        "display_order":1,
        "quantity":"40"
    },
    {
        "stock_id":"xY1ezL1l75",
        "size_name":"S",
        "size_description":"small",
        "color_name":"Navy Blue",
        "color_code":"#000080",
        "color_palette_search_index":"Blue",
        "display_order":2,
        "quantity":"30"
    }
]
Custom stock_id TEXT Generated by the platform. It is the unique inventory id for each and every inventory in primo. Make it empty when import a CSV file.
name TEXT Required Field. Maximum 128 character. The name of the custom inventory type.
description TEXT Optional. Can be NULL or maximum 255 character. The description of the custom inventory type.
quantity NUMBER FORMAT Required Field. Must be a positive integer or 0 Quantity of the product.

Sample JSON:

[
    {
        "stock_id":"0MJo4G0lbA",
        "name":"M",
        "description":"medium",
        "quantity":"40"
    }
]
Quantity Discount JSON Optional. Contains array of JSON. Can be NULL. The discount condition of the product.
It have 2 discount type: Absolute or Percent (%).
JSON Key Data Type Rules Side Notes
quantity NUMBER FORMAT Required Field. Must be a positive integer. The minimum quantity for implementing discount to transaction
amount NUMBER FORMAT Required Field. Must be a positive integer. The discount amount that will be calculated by discount type
discount_type ENUM Required Field.
One of the following:
  • Absolute
  • Percent (%)
The discount type of a product.
[
    {
        "quantiy":"5",
        "amount":"100",
        "discount_type":"Absolute"
    },
    {
        "quantiy":"19",
        "amount":"10",
        "discount_type":"Percent (%)"
    }
]
Images JSON Optional. Contains array of JSON. Maximum 10 images that could be process for each product. Can be NULL. The product images.
JSON Key Data Type Rules Side Notes
is_default 1 or 0 Required Field. Only 1 image should be default image from collection of images. The default image will be displayed as basic product image on any place.
caption TEXT Optional. Maximum 128 character. The image caption as image title.
display_order NUMBER FORMAT Optional. Must be a positive integer. The display order of the image collection.
image_url URL Required Field. Only approve image file url source The url of target image that will be uploaded. Make sure you have the right of the image.

Sample JSON:

[
    {
        "is_default":1,
        "caption":"400x400image",
        "display_order":1,
        "image_url":"http://primo.im/cdn/original/products/45/ed/4e/5c08d4f1735b47dea9d00644f84eed45.jpeg"
    }
]
Weight Type Unit ENUM Can be NULL or one of the following:
  • g
  • kg
  • ounce
  • pound
Required Field if weight amount filled.
The weight type unit of product.
Weight Amount NUMBER FORMAT Optional. Must be a positive integer or 0. The amount of product weight.
Minimum Order Quantity NUMBER FORMAT Optional. Must be a positive integer or 0.
If filled, should be lesser than maximum order quantity.
Minimum quantity of product that should be purchase in a single transaction.
Fill 0 for no minimum order quantity.
Maximum Order Quantity NUMBER FORMAT Optional. Must be a positive integer or 0.
If filled, should be greater than minimum order quantity.
Maximum quantity of product that could be purchase in a single transaction.
Fill 0 for infinite quantity of purchase.
Avail Since Date DATE Optional. Date format: Y-m-d
Example: 2016-11-28
The date when the product will be available to public.
Ingredients TEXT Optional. Can be NULL or maximum 65,535 characters. The ingredients or other information of the product.