唯品会API使用须知

唯品会联盟设置

蚂蚁星球推出开放API的目的在于,让具有开发能力的个人京东客,开发团队以及软件开发商更便捷的采集蚂蚁星球商品库的数据,实现优质好单的资源共享。使用蚂蚁星球开放API需要先申请apikey,您可以蚂蚁星球推广中心->开发管理->插件接入查看apikey,单个蚂蚁星球账号只能申请一个apikey。蚂蚁星球开放API是免费使用的,但蚂蚁星球保留对各接口进行调整的权利,我们会在调整时及时给予通知,也请您持续关注我们的公告。

联系技术支持:712218340 点击链接加入群聊【官方API交流群】(验证语:蚂蚁星球开放平台)

  • 推荐商品列表
  • 根据关键词查询
  • 商品详情
  • 转链API
  • 检测链接商品id
  • 订单查询
  • 售后订单查询
    • 详情
    • 错误参照代码
    • 接口地址: http://api-gw.haojingke.com/index.php/v1/api/vip/goodslist

      官方文档

      支持格式: json

      请求方式: get/post

      请求示例: http://api-gw.haojingke.com/index.php/v1/api/vip/goodslist?apikey=您的apikey&pageindex=1&pagesize=20

      请求参数说明:

      名称 类型 必填 说明
      apikey String 蚂蚁星球apikey,请将示例中的key替换成您的key
      pageindex Integer 第几页(默认第1页)
      pagesize Integer 10-100 默认20
      channelType Integer 频道类型:0-超高佣,1-出单爆款; 当请求类型为频道时必传
      sourceType Integer 请求源类型:0-频道,1-组货
      jxCode String 精选组货码:当请求源类型为组货时必传 女装精选 7hfpy0m4 或 fqs3ruqw 男装精选 wj7evz2j 或 kkhewi9q 美妆精选 x6kihigh 母婴精选 0lreb0o6 唯品快抢 w4yq5jn6 家用电器 2o396a6v 首饰精选 ck9efvy0 体用精选 etr780b6 或 y9q24eq5 女装高佣 otb2yhxb 男装高佣 bcv7cxil 鞋包精选 2jo673jj 居家精选 axu1ike2 美妆高佣 7vim6bem 鞋包高佣 vtf1vf0b 母婴高佣 h7r6ciwb 隐藏红包 n51jfbhf 实时爆款 4hm6c35w 精选比价 wbjf2n26 最后疯抢 qhasi1ll
      fieldName String 排序字段: COMMISSION-佣金,PRICE-价格,COMM_RATIO-佣金比例,DISCOUNT-折扣
      order Integer 排序顺序:0-正序,1-逆序,默认正序
      openId String 渠道用户在渠道侧的用户唯一标识(必传),传默认标识:default_open_id
      realCall Boolean 是否实时调用(必传),true
      chanTag String 渠道标识,推广位PID,最长不超过128字节,无需在联盟系统中创建即可使用

      JSON返回示例:

                                                      {
          "data": {
              "goodsInfoList": [
                  {
                  "goodsId": "2165850533",商品ID 
                  "goodsName": "【抢!红包减¥50】薰衣草洁净洗衣液耐用半年机洗手洗",商品名称 
                  "goodsDesc": null,商品描述,字段暂不输出 
                  "destUrl": "https://m.vip.com/product-3495916-2165850533.html",商品链接 
                  "goodsThumbUrl": "https://a.vpimg4.com/upload/merchandise/pdcpos/1100001647/2020/0921/153/cd0b3122-6c5e-49a5-b023-a4867d34686d_750x750_50.jpg",缩略图 
                  "goodsCarouselPictures": null,商品轮播图:根据商品id查询时返回,商品列表不返回 
                  "goodsMainPicture": "https://a.vpimg2.com/upload/merchandise/pdcpos/1100001647/2020/0921/153/cd0b3122-6c5e-49a5-b023-a4867d34686d.jpg",主图 
                  "categoryId": 390774,商品三级分类id 
                  "categoryName": "洗衣液",商品三级分类 
                  "sourceType": 1,商品类型:0-自营,1-MP 
                  "marketPrice": "456.00",市场价(元) 
                  "vipPrice": "113.00",唯品价(元) 
                  "commissionRate": "20.5",佣金比例(%) 
                  "commission": "23.17",佣金金额(元) 
                  "discount": "0.25",折扣:唯品价/市场价 保留两位小数字符串 
                  "goodsDetailPictures": null,商品详情图片:根据商品id查询商品信息时返回,商品列表不返回 
                  "cat1stId": 517,商品一级分类id 
                  "cat1stName": "日用家居",商品一级分类名称 
                  "cat2ndId": 73911,商品二级分类id 
                  "cat2ndName": "家清日化",商品二级分类名称 
                  "brandStoreSn": "10028135",商品品牌sn 
                  "brandName": "蓝月亮",商品品牌名称 
                  "brandLogoFull": "http://a.vpimg3.com/upload/brandcool/0/7e4e61ac2071401393ed39f04b41704e/10028135/primary.png",商品品牌logo全路径地址 
                  "schemeEndTime": 1600703999000,商品推广计划有效期预估截止时间:仅为预估时间,仅做参考;时间戳,单位:毫秒 
                  "sellTimeFrom": 1535964934000,商品售卖开始时间,时间戳,单位毫秒 
                  "sellTimeTo": 2145888000000,商品售卖结束时间,时间戳, 单位毫秒 
                  "weight": null,推广权重,用于确定推广该商品的优先级,权重值越大,优先级越高 
                  "storeInfo": {店铺信息
                      "storeId": "ST95405891",店铺ID
                      "storeName": "蓝月亮官方旗舰店"店铺名称
                  },
                  "commentsInfo": {商品评价信息 
                      "comments": 0,商品评论数 
                      "goodCommentsShare": null商品好评率:百分比,不带百分号 
                  },
                  "storeServiceCapability": {商品所属店铺服务能力评价 
                      "storeScore": "88.94",店铺评分:保留两位小数 
                      "storeRankRate": "7.0000"店铺同品类排名比例:例如10表示前10% 
                  },
                  "brandId": 3495916,商品所属档期(专场)id 
                  "schemeStartTime": 1600358400000,商品所属推广方案开始时间:时间戳,单位:毫秒 
                  "saleStockStatus": 2,商品库存状态:1-已抢光,2-有库存,3-有机会,当列表查询库存或者查询商品详情时返回 
                  "status": 1,商品状态:0-下架,1-上架 
                  "prepayInfo": {商品预付信息 
                      "isPrepay": 0,是否预付商品:0-否,1-是 
                      "prepayPrice": null,预付到手价:元 
                      "firstAmount": null,预付首款金额:元 
                      "lastAmount": null,预付尾款金额:元 
                      "prepayFavAmount": null,预付优惠金额: 元 
                      "deductionPrice": null,抵扣价格(首款+优惠金额):元 
                      "prepayDiscount": null,预付折扣:(唯品价-优惠金额)/唯品价 保留两位小数的数字字符串 
                      "prepayFirstStartTime": null,首款支付开始时间:时间戳,单位毫秒 
                      "prepayFirstEndTime": null,首款支付结束时间:时间戳,单位毫秒 
                      "prepayLastStartTime": null,尾款支付开始时间:时间戳,单位毫秒 
                      "prepayLastEndTime": null尾款支付结束时间:时间戳,单位毫秒 
                  },
                  "joinedActivities": null,商品参与活动信息:未参与活动集合为空 
                  "couponInfo": {优惠券批次号 
                      "couponNo": "743056",优惠劵名称
                      "couponName": "921-925-机洗手洗9斤-200-108元红包",使用门槛 
                      "buy": "200.00",优惠金额 
                      "fav": "108.00",券激活开始时间,毫秒级时间戳 
                      "activateBeginTime": 1600653600000,券激活开始时间,毫秒级时间戳 
                      "activateEndTime": 1600999200000,券激活结束时间,毫秒级时间戳 
                      "useBeginTime": 1600653601000,使用开始时间,毫秒级时间戳 
                      "useEndTime": 1600999200000,使用结束时间,毫秒级时间戳
                      "totalAmount": 10000,生成劵的总量
                      "activedAmount": 475劵已激活的数量 
                  },
                  "haiTao": 0是否海淘商品标识:1是 0不是 
                  }
              ],
              "total": 44总数 
          },
          "message": "success",提示信息 
          "status_code": 200状态码 200表示请求成功 
      }
      										
    • status_code=200 成功,其他失败,具体信息见message返回值
    • 详情
    • 错误参照代码
    • 接口地址: http://api-gw.haojingke.com/index.php/v1/api/vip/goodsquery

      官方文档

      支持格式: json

      请求方式: get/post

      请求示例: http://api-gw.haojingke.com/index.php/v1/api/vip/goodsquery?apikey=您的apikey&pageindex=1&pagesize=20&keyword=手机

      请求参数说明:

      名称 类型 必填 说明
      apikey String 蚂蚁星球apikey,请将示例中的key替换成您的key
      pageindex Integer 第几页(默认第1页)
      pagesize Integer 10-100 默认20
      keyword String 关键词
      priceStart String 价格区间---start
      priceEnd String 价格区间---end
      fieldName String 排序字段: COMMISSION-佣金,PRICE-价格,COMM_RATIO-佣金比例,DISCOUNT-折扣
      order Integer 排序顺序:0-正序,1-逆序,默认正序
      openId String 渠道用户在渠道侧的用户唯一标识(必传),传默认标识:default_open_id
      realCall Boolean 是否实时调用(必传),true
      chanTag String 渠道标识,推广位PID,最长不超过128字节,无需在联盟系统中创建即可使用

      JSON返回示例:

                                                      {
          "data": {
              "goodsInfoList": [
                  {
                  "goodsId": "2165850533",商品ID 
                  "goodsName": "【抢!红包减¥50】薰衣草洁净洗衣液耐用半年机洗手洗",商品名称 
                  "goodsDesc": null,商品描述,字段暂不输出 
                  "destUrl": "https://m.vip.com/product-3495916-2165850533.html",商品链接 
                  "goodsThumbUrl": "https://a.vpimg4.com/upload/merchandise/pdcpos/1100001647/2020/0921/153/cd0b3122-6c5e-49a5-b023-a4867d34686d_750x750_50.jpg",缩略图 
                  "goodsCarouselPictures": null,商品轮播图:根据商品id查询时返回,商品列表不返回 
                  "goodsMainPicture": "https://a.vpimg2.com/upload/merchandise/pdcpos/1100001647/2020/0921/153/cd0b3122-6c5e-49a5-b023-a4867d34686d.jpg",主图 
                  "categoryId": 390774,商品三级分类id 
                  "categoryName": "洗衣液",商品三级分类 
                  "sourceType": 1,商品类型:0-自营,1-MP 
                  "marketPrice": "456.00",市场价(元) 
                  "vipPrice": "113.00",唯品价(元) 
                  "commissionRate": "20.5",佣金比例(%) 
                  "commission": "23.17",佣金金额(元) 
                  "discount": "0.25",折扣:唯品价/市场价 保留两位小数字符串 
                  "goodsDetailPictures": null,商品详情图片:根据商品id查询商品信息时返回,商品列表不返回 
                  "cat1stId": 517,商品一级分类id 
                  "cat1stName": "日用家居",商品一级分类名称 
                  "cat2ndId": 73911,商品二级分类id 
                  "cat2ndName": "家清日化",商品二级分类名称 
                  "brandStoreSn": "10028135",商品品牌sn 
                  "brandName": "蓝月亮",商品品牌名称 
                  "brandLogoFull": "http://a.vpimg3.com/upload/brandcool/0/7e4e61ac2071401393ed39f04b41704e/10028135/primary.png",商品品牌logo全路径地址 
                  "schemeEndTime": 1600703999000,商品推广计划有效期预估截止时间:仅为预估时间,仅做参考;时间戳,单位:毫秒 
                  "sellTimeFrom": 1535964934000,商品售卖开始时间,时间戳,单位毫秒 
                  "sellTimeTo": 2145888000000,商品售卖结束时间,时间戳, 单位毫秒 
                  "weight": null,推广权重,用于确定推广该商品的优先级,权重值越大,优先级越高 
                  "storeInfo": {店铺信息
                      "storeId": "ST95405891",店铺ID
                      "storeName": "蓝月亮官方旗舰店"店铺名称
                  },
                  "commentsInfo": {商品评价信息 
                      "comments": 0,商品评论数 
                      "goodCommentsShare": null商品好评率:百分比,不带百分号 
                  },
                  "storeServiceCapability": {商品所属店铺服务能力评价 
                      "storeScore": "88.94",店铺评分:保留两位小数 
                      "storeRankRate": "7.0000"店铺同品类排名比例:例如10表示前10% 
                  },
                  "brandId": 3495916,商品所属档期(专场)id 
                  "schemeStartTime": 1600358400000,商品所属推广方案开始时间:时间戳,单位:毫秒 
                  "saleStockStatus": 2,商品库存状态:1-已抢光,2-有库存,3-有机会,当列表查询库存或者查询商品详情时返回 
                  "status": 1,商品状态:0-下架,1-上架 
                  "prepayInfo": {商品预付信息 
                      "isPrepay": 0,是否预付商品:0-否,1-是 
                      "prepayPrice": null,预付到手价:元 
                      "firstAmount": null,预付首款金额:元 
                      "lastAmount": null,预付尾款金额:元 
                      "prepayFavAmount": null,预付优惠金额: 元 
                      "deductionPrice": null,抵扣价格(首款+优惠金额):元 
                      "prepayDiscount": null,预付折扣:(唯品价-优惠金额)/唯品价 保留两位小数的数字字符串 
                      "prepayFirstStartTime": null,首款支付开始时间:时间戳,单位毫秒 
                      "prepayFirstEndTime": null,首款支付结束时间:时间戳,单位毫秒 
                      "prepayLastStartTime": null,尾款支付开始时间:时间戳,单位毫秒 
                      "prepayLastEndTime": null尾款支付结束时间:时间戳,单位毫秒 
                  },
                  "joinedActivities": null,商品参与活动信息:未参与活动集合为空 
                  "couponInfo": {优惠券批次号 
                      "couponNo": "743056",优惠劵名称
                      "couponName": "921-925-机洗手洗9斤-200-108元红包",使用门槛 
                      "buy": "200.00",优惠金额 
                      "fav": "108.00",券激活开始时间,毫秒级时间戳 
                      "activateBeginTime": 1600653600000,券激活开始时间,毫秒级时间戳 
                      "activateEndTime": 1600999200000,券激活结束时间,毫秒级时间戳 
                      "useBeginTime": 1600653601000,使用开始时间,毫秒级时间戳 
                      "useEndTime": 1600999200000,使用结束时间,毫秒级时间戳
                      "totalAmount": 10000,生成劵的总量
                      "activedAmount": 475劵已激活的数量 
                  },
                  "haiTao": 0是否海淘商品标识:1是 0不是 
                  }
              ],
              "total": 44总数 
          },
          "message": "success",提示信息 
          "status_code": 200状态码 200表示请求成功 
      }
      										
    • status_code=200 成功,其他失败,具体信息见message返回值