自定义产品目录来源
带上您自己的产品目录
在Bird中,您可以使用API端点创建自定义产品目录来源。API响应必须遵循特定格式,包括产品详情、变体、图片等。以下是如何构建您的产品目录数据及使用API创建它的指南。
创建Custom Product Catalog
产品目录 Source API Format
API 端点的响应应是一个产品对象数组,每个对象包含多个字段。以下是每个字段的结构和示例值:
必填字段:
id (字符串):产品的唯一标识符。示例:
"8890650190078"
name (字符串):产品的名称。示例:
"My Test Product"
description (字符串):产品的描述。示例:
"A cool product with lights available in different colors"
status (字符串):产品的当前状态。有效值为:
active
:产品上线并可用。archived
:产品已归档。draft
:产品为草稿。示例:"active"
created_at (字符串):产品创建的日期和时间,采用ISO-8601格式。示例:
"2022-05-25T10:55:16+02:00"
updated_at (字符串):产品最后更新的日期和时间,采用ISO-8601格式。示例:
"2022-05-25T10:55:16+02:00"
published_at (字符串):产品发布的日期和时间,采用ISO-8601格式。示例:
"2022-05-25T10:55:16+02:00"
vendor (字符串):产品供应商的名称。示例:
"My Vendor"
deleted_at (字符串):产品被删除的日期和时间(如适用),采用ISO-8601格式。示例:
"2022-05-25T10:55:16+02:00"
或一个空字符串""
,如果产品未被删除。
可选字段:
url (字符串):产品 URL。示例:
"https://www.myproduct.com"
type (字符串):产品类型,可用于过滤和搜索产品。示例:
"color"
variants (数组):产品变体的数组。如果指定了,每个变体必须包含
id
、name
、sku
和价格。
示例:
images (数组):产品图片的数组。如果指定了,每个图片必须包含
id
、position
、url
、alt
、width
和height
。variant_ids
数组还可以将图像链接到特定的产品变体。
variant_ids (数组):与产品图片关联的变体 id 数组。
逐步说明创建自定义产品目录 Source
准备您的数据:根据上面列出的结构格式化您的产品目录响应。确保包含所有必需字段,并根据需要添加可选字段,如
variants
、images
和url
。创建API端点:使用BirdCRM API发送产品数据。端点需要符合上述结构的响应。确保数据是有效的JSON格式。
测试端点:在将产品目录源集成到您的工作流中之前,重要的是测试API端点以验证数据是否被正确处理。这确保所有产品及其相关信息(如variants和images)都被正确提取。
监控和维护:一旦创建了产品目录源,您可以通过BirdCRM的报告功能监控其性能。如果需要更新任何产品详细信息或添加新产品,只需使用API更新数据。
示例API响应:
通过遵循这些步骤,您可以在Bird中创建和管理自定义产品目录源。确保API响应符合所需格式,您就可以将您的产品无缝整合到平台中。