CSV Exporter for Shopify, Magento & Custom Formats

How to import your CSV into Shopify

Once you download the CSV from PSRESTful you can start the process to import it into your Shopify store.

Here are the steps to import your CSV(exported from PSRESTful) into Shopify:

1. Go to your store admin page
2. Click on Products menu
   
3. Click on Import Button
   
4. Add your CSV file by clicking on Add file Button and selecting the file
   
   If you already imported those products then you should click on the Overwrite checkbox, so the new data takes place.
5. Click on Upload and preview Button and you should see a Preview similar to the following image
   
6. Once you click on Import Products Button, the process will start.
   You will receive a notification once the process is done.

How to enforce minimum quantity using the metafield

Forcing minimum quantity only using metafield and a minimum change on main-product.liquid.

No need to adding rules or anything else.

How does it work

• Create the minimum_quantity metafield in Product object.
• Modify the main-product.liquid to use the field.

The CSV will return a column called minimum_quantity, this field can be accessed in Shopify liquid by product.metafields.psrestful.minimum_quantity after you create this metafield in Shopify.

To modify the main-product-liquid file.

1. Look for an input with id="Quantity-{{ section.id }}"
2. Before the div with class = "price-per-item__container" place this code

   
               
           {%- assign min_qty = product.metafields.psrestful.minimum_quantity
           -%}
               
               

   This will allow you to use min_qty later in the liquid template.
3. Then, focus on the input. You need to modify/add data-min, min, and value.

   
               
           <input
               class="quantity__input"
               type="number"
               name="quantity"
               id="Quantity-{{ section.id }}"
               data-cart-quantity="{{ cart_qty }}"
               data-min="{{ min_qty }}"
               min="{{ min_qty }}"
               {% if product.selected_or_first_available_variant.quantity_rule.max != null %}
               data-max="{{ product.selected_or_first_available_variant.quantity_rule.max }}"
               max="{{ product.selected_or_first_available_variant.quantity_rule.max }}"
               {% endif %}
               step="{{ product.selected_or_first_available_variant.quantity_rule.increment }}"
               value="{{ min_qty }}"
               form="{{ product_form_id }}"
           >
           
   
   
               

How to create metafields using a Python script

Save time by using a Python script to add our metafields

When you need to add metafields to your Shopify store, you can use a Python script to automate the process. This is especially useful when you have a large number of products or need to update the metafields frequently.

How does it work

We've open-sourced a Python script that simplifies adding metafields to your Shopify store via the Shopify API.

Shopify-psrestful has its own readme file to help developers to use it.

Here is a piece of code to illustrate

    
@dataclass
class Spec:
    name: str
    key: str
    description: str
    field_type: str = 'single_line_text_field'
    owner_type: str = 'PRODUCT'


SPECS = (
    # product
    Spec(name='Supplier Code', key='supplier_code', description='Supplier Code', field_type='single_line_text_field'),
    Spec(name='PS Product ID', key='product_id', description='Product ID from PromoStandards',
         field_type='single_line_text_field'),
    Spec(name='Extra ID', key='extra_id', description='Extra ID from PSRESTful API', field_type='number_integer'),
    Spec(name='Effective Date', key='effective_date',
         description='The Date this Product initially becomes available from the Supplier in ISO 8601 format',
         field_type='date'),
    Spec(name='Export', key='export', description='Product status for export', field_type='boolean'),
    Spec(name='Primary Material', key='primary_material', description='Primary material of construction',
         field_type='single_line_text_field'),
    Spec(name='Brand', key='brand', description='Brand of the Product', field_type='single_line_text_field'),
    Spec(name='Country of Origin', key='country_of_origin', description='Country of Origin of the Product',
         field_type='single_line_text_field'),
    Spec(name='Is Caution', key='is_caution',
         description='Cautionary status to review for specific warnings about using product data.',
         field_type='boolean'),
    Spec(name='Caution Comment', key='caution_comment', description='Caution', field_type='boolean'),
    Spec(name='Line Name', key='line_name', description='Line Name / Division to which this product belongs',
         field_type='single_line_text_field'),
    Spec(name='Minimum Quantity', key='minimum_quantity', description='Minimum quantity to order',
         field_type='number_integer'),
    Spec(name='Lead Time', key='lead_time', description='Lead time in days', field_type='number_integer'),
    Spec(name='Is On Demand', key='is_on_demand', description='Product is available on demand', field_type='boolean'),
    Spec(name='Is Rush Service', key='is_rush_service', description='Product is available as a rush service',
         field_type='boolean'),
    Spec(name='Imprint Size', key='imprint_size', description='The imprint Size', field_type='single_line_text_field'),
    Spec(name='Price Expires Date', key='price_expires_date', description='The Date this Product price expires',
         field_type='datetime'),
    Spec(name='Is Hazmat', key='is_hazmat', description='Contains hazardous material. A nil value indicates this it'
                                                        'is unknown or the data is not available by the supplier',
         field_type='boolean'),
    Spec(name='Price Expires Date', key='price_expires_date',
         description='The date that the pricing in the ProductPriceGroupArray portion of the response expires',
         field_type='datetime'),
    Spec(name='Default SetUp Charge', key='default_set_up_charge',
         description='The default setup charge for this product. Can be a textual description',
         field_type='single_line_text_field'),
    Spec(name='Default Run Charge', key='default_run_charge',
         description='The default RUN charge for this product. Can be a textual description',
         field_type='single_line_text_field'),
    Spec(name='UNSPSC Commodity Code', key='unspsc_commodity_code',
         description='The United Nations Standard Products and Services Code® (UNSPSC®) that best describes this '
                     'product. Note that the enumerated values are the UNSPSC "Commodity" codes. For more information, '
                     'refer to https://www.unspsc.org',
         field_type='number_integer'),
    # Variant
    Spec(name='Variant GTIN', key='variant_gtin', description='Global Trade Item Number',
         field_type='single_line_text_field', owner_type='ProductVariant'),
)


def create_meta_fields_from_specs(shopify_domain, access_token, meta_field_specs=SPECS):
    with get_shopify_session(shopify_domain, access_token):

        for spec in meta_field_specs:
            create_metafield(spec.name, spec.key, spec.description,
                             field_type=spec.field_type, owner_type=spec.owner_type)


def create_metafield(name: str, key: str, description: str,
                     namespace: str = 'psrestful',
                     field_type: str = 'single_line_text_field', owner_type: str = 'PRODUCT'):
    query = '''
    mutation CreateMetafieldDefinition($definition: MetafieldDefinitionInput!) {
      metafieldDefinitionCreate(definition: $definition) {
        createdDefinition {
          id
          name
          namespace
          key
          description
        }
        userErrors {
          field
          message
          code
        }
      }
    }
    '''
    variables = {
        "definition": {
            "name": name,
            "namespace": namespace,
            "key": key,
            "description": description,
            "type": field_type,
            "ownerType": owner_type
        }
    }

    response = shopify.GraphQL().execute(query, variables)
    return response



    

How to update inventory using a Python script

Avoid checkout issues by updating your inventory using a Python script

Shopify-PRESTful

We have created another command in the open source code located at Github.
The update-inventory command will help you to keep your inventory update date. This is a CLI tool to help with the integration of Shopify and PSRESTful, and it is meant to be used as a standalone tool but in combination with the CSV Exporter in PSRESTful.

If you already have products in your store and want to update the inventory, you just need to add the metafields supplier_code and product_id to your products. Then, you will be ready to update inventory using this script.

Deployment

You should use a machine where you can run Python. If using Linux use a cronjob. For most cases, running the script once a day is enough. Remember, you will be hitting your Shopify store, PSRESTful, and the supplier. After midnight is a good time to run the script.

Depending on the number of products in your store this can be an slow process. This is why it is recommended to run it on background. We have also included a retry logic to avoid rate limit errors.

        nohup ./src/shopify_psrestful/cli.py -c update-inventory &
    

How to Obtain Shopify API Credentials for Your Python Script

1. Create a Shopify App

Shopify provides two ways to create an app: Custom Apps and Public Apps. If you're building an integration for your own store, use a Custom App.

Steps to Create a Custom App:

1. Log in to your Shopify Admin panel.
2. Navigate to Settings > Apps and sales channels.
3. Click on Develop apps (If this option is disabled, enable it by clicking "Allow custom app development").
4. Click Create an app and provide a name for your app.
5. Click Create app.

2. Get API Credentials

Once the app is created, retrieve the necessary API credentials:

• Go to the API credentials tab.
• Copy the Admin API Access Token (this is your SHOPIFY_APP_PRIVATE_APP_PASSWORD).
• Copy the API Key and API Secret Key (needed for authentication).
• Under Admin API scopes, grant the necessary permissions, then click Save and Install app.

  Metafields Permissions:

  • write_metafields: Required to create and update metafields.
  • read_metafields: Required if you also need to retrieve existing metafields.

  Inventory Permissions (Stock Updates):

  • write_inventory: Required to update inventory levels.
  • read_inventory: Required if you need to retrieve current stock levels.
  • write_products: Required if updating inventory involves modifying product variants.
  • read_products: Needed if you need to fetch product details before updating stock.

3. Find Your Shopify Store URL

Your store URL follows this format:

https://{your-store-name}.myshopify.com

Use this value for SHOPIFY_APP_SHOP_URL.

4. Set Up Your .env File

Create a .env file in your project directory and add the credentials:

SHOPIFY_APP_API_KEY='your_api_key'
...