get https://api.getblueshift.com/api/v1/catalogs
Use this endpoint to get a list of all catalogs.
The following information is returned for all catalogs:
- UUID
- Catalog name
- Item Count
- Update Method (API/file)
- Update Frequency
- Last Processed
- Feed Status (active/inactive)
- Archived Status (yes/no)
Try the endpoint
- Add the User API key as the Username and leave the Password field blank.
- Click the Base URL dropdown and select the API endpoint URL for your Blueshift region.
- Click Try It.
You can also try the API using Blueshift's API collection in Postman.
API at a glance
Here's a quick summary of the API request and response payloads. You can use your API key to try it out on your instance.
Request Parameters
None
Response
{
"catalogs":
{
"items":
{
"properties":
{
"access_key":
{
"description": "The access key used to create the catalog.",
"type": "string"
},
"archived":
{
"description": "Indicates if the catalog is archived.",
"example": "false",
"type": "boolean"
},
"author":
{
"description": "The user who created the catalog.",
"example": "John Doe",
"type": "string"
},
"bucket":
{
"description": "The name of the S3 bucket from which the catalog is uploaded.",
"type": "string"
},
"catalog_file_name":
{
"description": "The filename of the uploaded catalog file.",
"example": "products.csv",
"type": "string"
},
"catalog_headers":
{
"example": "\"title\", \"price\", \"image_url\", \"author\", \"isbn\", \"on_sale_date\", \"url\", \"sku\", \"itemformat\", \"language\", \"saleStatus\", \"consumerImprint\", \"formatFamily\", \"pages\", \"subject\"",
"items":
{
"type": "string"
},
"type": "array"
},
"catalog_type":
{
"description": "The type of the catalog.",
"example": "ecommerce",
"type": "string"
},
"category_options":
{
"items":
{
"type": "string"
},
"type": "array"
},
"default_root_category":
{
"description": "The default root category for the catalog.",
"type": "string"
},
"end_at":
{
"description": "The date and time at which the catalog in no longer available.",
"format": "date-time",
"type": "string"
},
"error_access_key":
{
"description": "The access key for errors.",
"type": "string"
},
"file_options":
{
"properties":
{
"col_sep":
{
"description": "The separator used in the csv file.",
"example": "|",
"type": "string"
},
"encoding":
{
"description": "The encoding for the csv file.",
"example": "utf-8",
"type": "string"
},
"format":
{
"description": "The format of the catalog file.",
"example": "csv",
"type": "string"
}
},
"type": "object"
},
"file_settings":
{
"items":
{
"type": "string"
},
"type": "array"
},
"host":
{
"type": "string"
},
"is_active":
{
"description": "Indicates the availability of the product.",
"example": "true",
"type": "boolean"
},
"is_passive":
{
"description": "Indicates the availability of the product.",
"example": "true",
"type": "boolean"
},
"last_catalog_file":
{
"description": "Last catalog upload details for recurring catalog uploads.",
"properties":
{
"catalog_id":
{
"description": "The catalog ID.",
"example": "2151",
"type": "string"
},
"created_at":
{
"description": "The date and time for the upload.",
"example": "2018-10-03T04:57:24.000Z",
"format": "date-time",
"type": "string"
},
"error_file_s3_key":
{
"type": "string"
},
"errored_records":
{
"description": "Number of records that resulted in an error.",
"example": "0",
"type": "string"
},
"file_name":
{
"description": "The file name of the file last uploaded for the catalog.",
"example": "products.csv",
"type": "string"
},
"id":
{
"description": "The ID for the file last uploaded for the catalog.",
"example": "332983",
"type": "string"
},
"processed_records":
{
"description": "Total number of records processed.",
"example": "9882",
"type": "string"
},
"s3_key":
{
"description": "The key to access the S3 folder.",
"example": "training.blueshift.com/catalogs/import/2018/10/03/products_1538542636693.csv",
"type": "string"
},
"status":
{
"description": "The status of the file upload.",
"example": "success",
"type": "string"
},
"total_records":
{
"description": "Total number of records in uploaded file.",
"example": "9882",
"type": "string"
},
"updated_at":
{
"description": "The date and time for the upload.",
"example": "2018-10-03T04:58:34.000Z",
"format": "date-time",
"type": "string"
},
"uuid":
{
"description": "The catalog's UUID.",
"example": "7fbea614-c257-4745-a1cb-22f6d7b87f74",
"type": "string"
}
},
"type": "object"
},
"last_processed":
{
"description": "The timestamp when the catalog was last updated in iso8601 format.",
"example": "2018-10-03T04:58:34.000Z",
"format": "date-time",
"type": "string"
},
"login":
{
"description": "The user login for the catalog.",
"type": "string"
},
"name":
{
"description": "The name of the catalog.",
"example": "Books",
"type": "string"
},
"parent_sku_column_name":
{
"description": "The name of the column in the database that lists the parent sku that ties all variants or child products together.",
"type": "string"
},
"password":
{
"description": "The password for the catalog.",
"type": "string"
},
"path":
{
"type": "string"
},
"port":
{
"type": "string"
},
"product_brand_column_name":
{
"description": "The name of the column in the database that lists the product brand.",
"example": "author",
"type": "string"
},
"product_category_column_name":
{
"example": "\"subject\"",
"items":
{
"type": "string"
},
"type": "array"
},
"product_count":
{
"description": "The number of items in the catalog.",
"example": "9882",
"type": "integer"
},
"product_end_date_column_name":
{
"description": "The name of the column in the database that indicates the last date on which a product will be available.",
"type": "string"
},
"product_id_column_name":
{
"description": "The name of the column in the database that lists the products' IDs.",
"example": "sku",
"type": "string"
},
"product_image_column_name":
{
"description": "The name of the column in the database that lists the URLs of the products' images.",
"example": "image_url",
"type": "string"
},
"product_inventory_column_name":
{
"description": "The name of the column in the database that lists the product inventory.",
"type": "string"
},
"product_msrp_column_name":
{
"description": "The name of the column in the database that lists the products' maximum selling price.",
"type": "string"
},
"product_name_column_name":
{
"description": "The name of the column in the database that lists the products' names.",
"example": "title",
"type": "string"
},
"product_price_column_name":
{
"description": "The name of the column in the database that lists the products' prices.",
"example": "price",
"type": "string"
},
"product_start_date_column_name":
{
"description": "The name of the column in the database that indicates the start date on which a product will be available.",
"example": "on_sale_date",
"type": "string"
},
"product_tag_column_name":
{
"items":
{
"type": "string"
},
"type": "array"
},
"product_url_column_name":
{
"description": "The name of the column in the database that lists the products' URLs.",
"example": "url",
"type": "string"
},
"s3_access_key":
{
"description": "The access key for the S3 bucket from which the catalog is uploaded.",
"type": "string"
},
"s3_aws_region":
{
"description": "The region for the S3 bucket from which the catalog is uploaded.",
"type": "string"
},
"s3_path":
{
"description": "The path for the S3 bucket from which the catalog is uploaded.",
"type": "string"
},
"secret_access_key":
{
"description": "The secret access key for the S3 bucket from which the catalog is uploaded.",
"type": "string"
},
"sftp_host":
{
"description": "The sftp host for the location from which the catalog is uploaded.",
"type": "string"
},
"sftp_login":
{
"description": "The region for the S3 bucket from which the catalog is uploaded.",
"type": "string"
},
"sftp_password":
{
"description": "The sftp password for the location from which the catalog is uploaded.",
"type": "string"
},
"sftp_path":
{
"description": "The sftp folder path for the location from which the catalog is uploaded.",
"type": "string"
},
"sftp_port":
{
"description": "The sftp port for the location from which the catalog is uploaded.",
"type": "string"
},
"start_at":
{
"description": "The date and time at which the catalog becomes available.",
"format": "date-time",
"type": "string"
},
"status":
{
"example": "success",
"type": "string"
},
"tag_options":
{
"type": "string"
},
"update_frequency":
{
"description": "The frequency at which our platform receives data from your service to update the catalog.",
"example": "none",
"type": "integer"
},
"upload_method":
{
"description": "The method that you use to upload the catalog to our platform.",
"example": "file",
"type": "string"
},
"url":
{
"description": "The URL of the catalog on your site.",
"type": "string"
},
"uuid":
{
"description": "The catalog's UUID.",
"example": "dd0d2987-9e57-47d4-9380-8a3e959cbe8e",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}