宠物商店
latest
  • latest
  • v2.0.0
首页常见问题
开发者中心
  • 更新日志
  • 开放 API
首页常见问题
开发者中心
  • 更新日志
  • 开放 API
latest
  • latest
  • v2.0.0
  1. Schemas
  • 商品服务
    • 介绍
    • Changelog
    • Markdown
      • 概述
      • 项目资源的插入
      • 链接与锚点跳转
      • 容器+列表
      • 步骤组件
      • 图片
      • 表格
      • 折叠块
      • 告示与高亮块
      • 文字 Hover 提示与复制
    • 示例项目
      • 查询宠物详情
      • 新建宠物信息
      • 删除宠物信息
      • 根据状态查找宠物列表
      • 修改宠物信息
    • 商城 API
      • 开始使用
        • 介绍
        • 身份验证
        • HTTP压缩
        • 发布API密钥
        • 扩展字段
        • 选择字段
        • 查询参数类型
        • 分页
      • 地区
        • 获取地区列表
        • 获取地区
      • 产品
        • 搜索产品
        • 获取产品列表
        • 获取产品
      • 客户信息
        • 请求密码重置
        • 获取保存的支付方式
        • 添加送货地址
        • 更新客户
        • 获取客户
        • 更新送货地址
        • 删除地址
        • 创建客户
        • 重置密码
        • 获取订单列表
      • 产品变体
        • 获取产品变体
        • 获取产品变体
      • 产品标签
        • 获取产品标签列表
      • 产品类别
        • 获取产品类别列表
        • 获取产品类别
      • 收款
        • 授权付款会话
        • 授权支付会话
        • 刷新支付会话
        • 获取支付集合
        • 管理支付会话
        • 创建支付会话
      • 产品体系
        • 获取产品集合
        • 获取产品集合列表
      • 产品类型
        • 获取产品类型列表
      • 订单编辑
        • 完成订单编辑
        • 检索订单编辑
        • 拒绝订单编辑
      • 退货
        • 创建退货
      • 退货原因
        • 获取退货原因列表
        • 获取退货原因
      • 购物车
        • 创建支付会话
        • 刷新支付会话
        • 创建购物车
        • 完成购物车
        • 选择支付会话
        • 删除支付会话
        • 更新支付会话
        • 获取购物车
        • 更新购物车
        • 添加送货方式
        • 更新订单项
        • 删除订单项
        • 添加订单项
        • 计算购物车税费
        • 删除折扣
      • 身份验证
        • 客户登录 (JWT)
        • 客户登录 (JWT)
        • 检查电子邮件是否存在
        • 获取当前客户
        • 客户登出
        • 客户登录
      • 物流选项
        • 获取购物车可用物流选项列表
        • 获取物流选项
      • 订单
        • 声明订单
        • 验证订单声明
        • 获取订单
        • 查找订单
        • 按购物车 ID 获取
      • 交换
        • 按购物车ID获取
        • 创建交换
      • 礼品卡
        • 按代码获取礼品卡
      • WebSocket
        • WebSocket
      • 宠物
        • 上传宠物图片
        • 根据 tag 查找宠物列表
      • 用户
        • 查询用户信息
        • 获取用户列表
        • 修改用户信息
        • 登录
        • 注册
        • 退出登录
        • 删除用户
        • 用户详情
      • 店铺
        • 加入购物车
        • 下单购买宠物
        • 支付订单
        • 新建宠物信息
        • 查询订单详情
        • 根据状态查询宠物库存数
        • 删除订单
    • 加密解密
      • 加密解密
    • 线上文档示例
      • 运行测试场景
    • 用户问题测试
      • A&B
      • oneOf
      • 宠物
      • 11
    • 调用外部程序
      • 调用外部程序
    • WebSocket
      • WebSocket
    • Socket.IO
      • Socket.IO 聊天室
    • OpenAPI Security Schemes 导入示例
      • 公开接口,无需认证
      • 获取用户列表
      • 创建新用户paymentsuccessnotification
      • 管理员接口
      • 管理员获取全部用户详细信息
      • 获取系统指标
    • Webhook
      • Webhook 测试
      • 飞书
      • 订单支付成功通知
    • 获取一个宠物
      GET
    • 未命名接口
      GET
    • 未命名接口
      GET
    • 数据模型
      • 示例数据模型
        • 未命名数据模型
      • Schemas
        • StoreReturnsRes
        • Pet
        • Return
        • Dog
        • Return Item
        • Cat
        • StoreOrderEditsRes
        • Snake
        • Order Edit
        • Order Item Change
        • StorePaymentCollectionsRes
        • Payment Collection
        • StorePaymentCollectionsSessionRes
        • Payment Session
        • StoreCompleteCartRes
        • StoreOrdersRes
        • StoreCustomersListOrdersRes
        • StoreCartsRes
        • Cart
        • StoreSwapsRes
        • Swap
        • Line Item
        • Line Item Adjustment
        • Discount
        • StoreGiftCardsRes
        • Gift Card
        • StoreRegionsListRes
        • StoreRegionsRes
        • Region
        • Tax Rate
        • StoreProductsRes
        • StoreProductsListRes
        • Priced Product
        • Product
        • Sales Channel
        • Sales Channel Stock Location
        • Discount Rule
        • Shipping Method
        • StoreShippingOptionsListRes
        • StoreCartShippingOptionsListRes
        • Priced Shipping Option
        • Shipping Option
        • Shipping Option Requirement
        • StoreVariantsListRes
        • Product Option
        • StoreVariantsRes
        • Priced Product Variant
        • Product Variant
        • Money Amount
        • Payment
        • Shipping Method Tax Line
        • Line Item Tax Line
        • Product Option Value
        • Product Variant Inventory Item
        • Shipping Profile
        • Image
        • StoreAuthRes
        • StoreCustomersRes
        • StoreCustomersResetPasswordRes
        • Customer
        • Address
        • Gift Card Transaction
        • Customer Group
        • Tax Provider
        • Payment Provider
        • Currency
        • Country
        • Fulfillment Provider
        • StoreCollectionsRes
        • Multiple Errors
        • StorePostReturnsReq
        • StoreProductTagsListRes
        • Product Tag
        • StorePostCustomersCustomerReq
        • StorePostCustomersCustomerAddressesAddressReq
        • StorePostCartsCartReq
        • StorePostCustomersCustomerAddressesReq
        • AddressCreatePayload
        • AddressPayload
        • StoreReturnReasonsRes
        • StoreReturnReasonsListRes
        • Return Reason
        • StoreProductTypesListRes
        • Product Type
        • StoreCollectionsListRes
        • Product Collection
        • StoreGetProductCategoriesRes
        • StorePostCartsCartPaymentSessionUpdateReq
        • StoreGetProductCategoriesCategoryRes
        • Product Category
        • Response Error
        • StorePostSearchRes
        • StoreCustomersListPaymentMethodsRes
        • StorePostSearchReq
        • StorePostCartsCartLineItemsReq
        • StorePostCartsCartPaymentSessionReq
        • StorePaymentCollectionSessionsReq
        • StorePostAuthReq
        • StorePostPaymentCollectionsBatchSessionsReq
        • StorePostCustomersReq
        • StorePostPaymentCollectionsBatchSessionsAuthorizeReq
        • StoreBearerAuthRes
        • StorePostCustomersResetPasswordReq
        • StorePostOrderEditsOrderEditDecline
        • StorePostCustomersCustomerPasswordTokenReq
        • StorePostCustomersCustomerAcceptClaimReq
        • StorePostCustomersCustomerOrderClaimReq
        • StorePostCartsCartShippingMethodReq
        • StoreGetAuthEmailRes
        • StorePostCartsCartLineItemsItemReq
        • StorePostCartReq
        • StorePostSwapsReq
      • 宠物相关
        • Category
        • Tag
      • 其他
        • ApiResponseSuccess
        • ApiResponseFailure
        • User
        • VipUser
        • Localtion
        • Order
      • A and B
        • A
        • B
        • oneOf
      • Markdown
        • 旧版本
        • 新版本
      • category
  • 用户服务
    • 获取用户信息
  • 订单服务
    • 用户管理
      • 获取用户列表
      • 创建新用户
      • 获取特定用户信息
      • 更新用户信息
      • 删除用户
    • 订单管理
      • 获取订单列表
      • 创建新订单
      • 获取特定订单信息
    • 系统管理
      • 获取系统健康状态
      • 获取系统日志
    • 数据分析
      • 获取用户分析数据
      • 获取订单分析数据
    • 通知管理
      • 发送通知
    • 管理员操作
      • 获取用户的订单历史
    • 新建订单
    • 数据模型
      • Schemas
        • User
        • CreateUserRequest
        • UpdateUserRequest
        • UserList
        • Order
        • OrderItem
        • CreateOrderRequest
        • OrderList
        • SystemHealth
        • SystemLogs
        • LogEntry
        • UserAnalytics
        • OrderAnalytics
        • AnalyticsDataPoint
        • SendNotificationRequest
        • Notification
        • UserOrderHistory
        • Pagination
  1. Schemas

Product(Product)

A product is a saleable item that holds general information such as name or description. It must include at least one Product Variant, where each product variant defines different options to purchase the product with (for example, different sizes or colors). The prices and inventory of the product are defined on the variant level.

{
    "id": "prod_01G1G5V2MBA328390B5AXJ610F",
    "title": "Medusa Coffee Mug",
    "subtitle": "string",
    "description": "Every programmer's best friend.",
    "handle": "coffee-mug",
    "is_giftcard": false,
    "thumbnail": "http://example.com",
    "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
    "weight": null,
    "length": null,
    "height": null,
    "width": null,
    "hs_code": null,
    "origin_country": null,
    "mid_code": null,
    "material": null,
    "collection_id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
    "type_id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
    "discountable": true,
    "external_id": null,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "status": "draft",
    "metadata": {
        "car": "white"
    },
    "categories": [
        {
            "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2",
            "name": "Regular Fit",
            "description": "",
            "handle": "regular-fit",
            "mpath": "pcat_id1.pcat_id2.pcat_id3",
            "is_internal": false,
            "is_active": false,
            "rank": 0,
            "parent_category_id": null,
            "parent_category": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "category_children": [
                {}
            ],
            "products": [
                {}
            ],
            "metadata": {
                "car": "white"
            }
        }
    ],
    "profile": {
        "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
        "name": "默认送货方案",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "type": "default",
        "products": [
            {}
        ],
        "shipping_options": [
            {}
        ],
        "metadata": {
            "car": "white"
        }
    },
    "profiles": [
        {
            "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
            "name": "默认送货方案",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "type": "default",
            "products": [
                {}
            ],
            "shipping_options": [
                {}
            ],
            "metadata": {
                "car": "white"
            }
        }
    ],
    "collection": {
        "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
        "title": "Summer Collection",
        "handle": "summer-collection",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "products": [
            {}
        ],
        "metadata": {
            "car": "white"
        }
    },
    "type": {
        "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
        "value": "Clothing",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
            "car": "white"
        }
    },
    "tags": [
        {
            "id": "ptag_01G8K2MTMG9168F2B70S1TAVK3",
            "value": "Pants",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
                "car": "white"
            }
        }
    ],
    "images": [
        {
            "id": "img_01G749BFYR6T8JTVW6SGW3K3E6",
            "url": "http://example.com",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
                "car": "white"
            }
        }
    ],
    "options": [
        {
            "id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
            "title": "Size",
            "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
            "product": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
                "car": "white"
            },
            "values": [
                {
                    "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                    "value": "large",
                    "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                    "option": {},
                    "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                    "variant": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {
                        "car": "white"
                    }
                }
            ]
        }
    ],
    "sales_channels": [
        {
            "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
            "name": "Market",
            "description": "Multi-vendor market",
            "is_disabled": false,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
                "car": "white"
            },
            "locations": [
                {
                    "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                    "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                    "location_id": "string",
                    "sales_channel": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z"
                }
            ]
        }
    ],
    "variants": [
        {
            "id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
            "title": "Small",
            "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
            "product": {},
            "sku": "shirt-123",
            "barcode": null,
            "ean": null,
            "upc": null,
            "variant_rank": 0,
            "inventory_quantity": 100,
            "allow_backorder": false,
            "manage_inventory": true,
            "hs_code": null,
            "origin_country": null,
            "mid_code": null,
            "material": null,
            "weight": null,
            "length": null,
            "height": null,
            "width": null,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "purchasable": true,
            "metadata": {
                "car": "white"
            },
            "options": [
                {
                    "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                    "value": "large",
                    "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                    "option": {},
                    "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                    "variant": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {
                        "car": "white"
                    }
                }
            ],
            "inventory_items": [
                {
                    "id": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A",
                    "inventory_item_id": "string",
                    "variant_id": "string",
                    "variant": {},
                    "required_quantity": 1,
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z"
                }
            ],
            "prices": [
                {
                    "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
                    "amount": 100,
                    "min_quantity": 1,
                    "max_quantity": 1,
                    "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
                    "price_list": {},
                    "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                    "variant": {},
                    "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                    "region": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "currency_code": "usd",
                    "currency": {
                        "symbol": "$",
                        "symbol_native": "$",
                        "name": "US Dollar",
                        "includes_tax": false,
                        "code": "usd"
                    }
                }
            ]
        }
    ]
}
Built with