Product/Content Catalog

Integrating your product or content feed(s) allows us to include relevant recommendations in your messages. Multiple options are available:

1. Feeds: JSON or CSV via FTP/HTTP/S3 Bucket
2. Catalog API
3. Catalog Attributes

1. Feeds

To setup a catalog using Feeds, navigate to Catalog tab and click the +Catalog button to add a feed.

Pick the appropriate feed type, complete all required fields and click Validate.

• Enter a unique feed/catalog name
• Choose E-Commerce as Feed Type
• Pick the appropriate feed upload method. You can upload files via HTTP/FTP/Direct file upload/S3 bucket/SFTP. Provide additional information based on the option that you choose. For example, if you choose S3, we need S3 access key, secret access key, bucket name, and the region. Similarly, if you want to us to pick files from an FTP location, in addition to the URL of the server where you host the files and the port on which FTP service is running, we need credentials to access files on that location. 
• Select upload frequency. Your options are:
  • Only once
  • Weekly
  • Daily
  • Hourly

  In addition, you can specify Update Time. You can use this option to let our platform know whether:

  • It should import files from the S3 location instantly
  • Or it should start the import at a date and time that you specify (for weekly, daily, and hourly imports). In addition, you can also specify when our platform should stop importing the files based on the setting that you specify in the End option. 

In the next screen, you will need to map your catalog attributes to Blueshift defined attributes. Attributes that cannot be mapped to our standard ones will be loaded as custom attributes.

You will receive an email confirmation once the catalog has been uploaded including processed and failed records.

2. Catalog API

The catalog API allows the following actions:

1. Create Catalog

2. Add Item To Catalog

Create Catalog

You can create a new catalog from the API by using the create catalog API end-point.

Inputs:

• “name”: Catalog name (string)

Output:

• On successful create, returns the catalog’s unique identifier

Sample call:

• cURL

curl -v -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"catalog" : {"name" : "ACME Item Catalog"}}' -u <USER API KEY>: https://api.getblueshift.com/api/v1/catalogs

Sample Response

• JSON

{"catalog_uuid":"<CATALOG UUID>"}

Add Item To Catalog

You may add multiple items to a catalog in batches of 100 items at a time, by using the add item to catalog API end-point.

Inputs:

• "catalog uuid": Use the catalog uuid as returned from the create a catalog api end-point
• Array of products

Output:

• On success, returns “ok”

• cURL

curl -v -H "Accept: application/json" -H "Content-type: application/json" -X PUT -u <USER API KEY>: https://api.getblueshift.com/api/v1/catalogs/<CATALOG UUID>.json -d '
{
    "catalog": {
        "products": [
            {
                "brand": "Nike",
                "category": [
                    "Home",
                    "Home > Shoes",
                    "Home > Shoes > Running"
                ],
                "image": "http://server/path/image.jpg",
                "msrp": "47",
                "price": "37.99",
                "product_id": "189909",
                "availability": "in stock",
                "tags": [
                    "running",
                    "athlete"
                ],
                "title": "Nike Jordan Running Shoes in Blue",
                "web_link": "http://server/path/product.html".
                "latitude": "37.792805",  
                "longitude": "-122.401444",  
                "location_tag": "Points of Interest > USA > California > San Francisco > San Francisco Downtown"
            },
           {
                "brand": "Reebok",
                "category": [
                    "Home",
                    "Home > Shoes",
                    "Home > Shoes > Sports"
                ],
                "image": "http://server/path/image2.jpg",
                "msrp": "47",
                "price": "37.99",
                "product_id": "189910",
                "availability": "in stock",
                "tags": [
                    "basketball"
                ],
                "title": "Reebok Basketball Shoes",
                "web_link": "http://server/path/product2.html"
            }
        ]
    }
}'

3. Catalog Attributes 

Required fields

Category

We recommend that you provide multiple levels (at least 2) for better recommendations. The format is bit different for API and for csv upload

File Upload:
For csv upload, you can denote multiple levels using a delimiter and can specify the delimiter when uploading the file. The delimiter is ">" in the below example.
Ex: "Travel > Europe > Italy"

Api Upload:
For API upload, you will denote multiple levels using an array of strings.
Ex: ["Travel","Travel > Europe","Travel > Europe > Italy"]

If it's uploaded correctly, the category should show up like this on our dashboard when you see individual product details.

Ex: