Products for Partners

Uploading products via Zoomailer

A list of products can be uploaded to the storefront using a CSV file. Then, you can attach that file to an e-mail and send to the address you were provided.

 "cms": {
    "recipients": [
        "[email protected]",
        "[email protected]"
    ],
    "subjectKeywords": [
        "products",
        "clients",
        "prices"
    ],
    "type": "EXTERNAL",
    "_id": "6124382ced3376000813da68",
    "sourceBucket": "source-s3-bucket"
}

CSV format

The following list contains the available fields. The required fields must be present in the CSV file.

category: String (required)
description: String (required)
imageURL: String[] (required)
isActive: Boolean (required)
name: String (required)
sku: String (required)

attributes: String[]
categories: String[]
_{custom_field_name}: String
deactivationDate: Date
divisionsByUnit: Integer
packageType: String
priority: Integer
size: String
tags: String[]
unitDivision: String
unitsPerPackage: Integer

Brackets ([]) indicate that the fields expects a list of values. The values should be separated with a pipe (|). For example, categoryA | categoryB is a valid value for categories.

Custom fields are accepted and you can pass any number of them. Their names should start with an underscore (_). For example, _customFieldA is valid custom field name whereas customFieldA is not and will be ignored.

Here's an example of a full CSV file content:

Here's the raw CSV of that table

name;sku;category;categories;description;tags;size;imageURL;priority;packageType;unitsPerPackage;unitDivision;divisionsByUnit;isActive;deactivationDate;_customFieldA;_customFieldB
Coca-Cola 350 ml;859102877;Soft Drinks;Beverages;Coke 350 ml, aluminum can;Soda | Beverages;2XL;http://images.com/coke.png;1;Pack;12;unit;1;TRUE;9/18/2021;1;12

E-mail format

Now that you have your CSV file, you can attach it to an e-mail and send it to the service that will load them into your storefront. There are some rules that this service requires, let's check them out.

The first rule is that your CSV file name should include products or productos in it. For example, products_18012022.csv **and productos_012022.csv are both accepted. However, prod_012022.csv **will be ignored.

The second rule is that the e-mail subject must also include either products or productos. For example, products jan/2022 is acceptable but jan/2022 is not, regardless of the CSV file name.

If both rules are okay, then the service will start processing your file.

After the file is processed, you get an e-mail saying the file processing has finished and the service will start to add your products to the storefront. After the service finishes inserting them, you'll be able to see the products in your storefront.

To get an e-mail once the file has been processed, we need to enable it via BLUE_STEEL_EMAIL_RESP_SEND (ref.:https://bitbucket.org/yalochat/zoomailer/)

{
  "success": true,
  "message": "20 product(s) have been processed successfully!",
  "traceId": "fc13ba42-43c3-4045-9d4d-1a2cf10976d1"
}

When such error happens, the customer will not get any e-mail but you can configure BLUE_STEEL_EMAIL_SUPPORT with a list of e-mails to send errors to. Then it's up to the recipients to forward those errors to the customer/partner.

It does seem that we have a limit for the number of files sent by e-mail. I haven't had the chance to test this but I checked Zoomailer's code and there's a specific check for that (see https://bitbucket.org/yalochat/zoomailer/src/55a1d255ffabf6433afbba7996bb69f40db2f809/pkg/tireless/polling.go?at=master#polling.go-204,206,237)

Adán Muguiro, from the Delivery Success team, was not sure about the limit but said that customers usually send just one file per e-mail.

According to Adán Muguiro, from the Delivery Success team, in production customers are able to process files longer than that. This is because Zoomailer uses another lambda function to upload the data, the Ecommerce Upload Files Service, so it goes through a different process.