Skip to main content

Custom Built Client - Catalog Requirements

Smriti Batra avatar
Written by Smriti Batra
Updated over 6 months ago

Data Delivery Methods

You can provide your product catalog data through any of the following methods:

  • REST API: Secure endpoint that our system can query to retrieve the latest catalog data

  • SFTP: Secure file transfer protocol for scheduled file delivery

  • Dynamic URL: A public or authenticated URL that is updated daily with the latest catalog data

Required Format

The catalog must be provided in CSV or XML format with the following specifications.

Mandatory Fields

The following fields must be included in your product catalog:

Field

Description

id

Unique identifier for each product

title

Product name

description

Detailed product description

availability

Stock status (in stock, out of stock, preorder, etc.)

condition

Product condition (new, used, refurbished)

price

Product price with currency code (e.g., 19.99 USD)

link

URL to the product page on your website

image_link

URL to the main product image

brand

Product brand name

Optional Fields

The following fields are recommended but not required:

Field

Description

additional_image_link

URLs to additional product images (comma-separated)

age_group

Target age group (adult, kids, etc.)

color

Product color

gender

Target gender (male, female, unisex)

item_group_id

ID for grouping product variants (size, color, etc.)

google_product_category

Google product taxonomy category ID

material

Product material(s)

pattern

Product pattern (striped, polka dot, etc.)

product_type

Your product category (can be different from google_product_category)

sale_price

Discounted price with currency code (if applicable)

sale_price_effective

Date range when sale price is effective (YYYY-MM-DD/YYYY-MM-DD)

shipping

Shipping cost and country information

shipping_weight

Product weight with unit (e.g., 3.5 kg)

size

Product size

custom_label_0

Custom grouping attribute 1

custom_label_1

Custom grouping attribute 2

custom_label_2

Custom grouping attribute 3

custom_label_3

Custom grouping attribute 4

custom_label_4

Custom grouping attribute 5

Feed Maintenance

  • Ensure your feed is updated hourly/daily to reflect current inventory, pricing, and product information

  • The feed URL should remain consistent to allow for automated data retrieval

  • Set up proper authentication if required, and provide credentials through secure channels

Sample CSV Header

id,title,description,availability,condition,price,link,image_link,brand,additional_image_link,age_group,color,gender,item_group_id,google_product_category,material,pattern,product_type,sale_price,sale_price_effective,shipping,shipping_weight,size,custom_label_0,custom_label_1,custom_label_2,custom_label_3,custom_label_4

Please contact our technical team if you have any questions about the feed requirements or need assistance with implementation.

Did this answer your question?