1 接口调度流程

image.png

2 接口清单

(1)查询支持的国家接口

  1. /**
  2. * 查询有权限的国家列表
  3. * @param request 请求参数
  4. * @return com.taobao.gpf.common.ResultDTO<com.taobao.gpf.common.response.CountriesRecordDTO>
  5. */
  6.     ResultDTO<List<CountriesDTO>> getCountries(CountriesRequest request);

入参：

  1.    //语言
  2.    protected String lang;

出参：

  1.     /**
  2.      * 国家代码
  3.      */
  4.     protected String countryCode;
  5.     /**
  6.      * 国家名称
  7.      */
  8.     protected String countryName;
  9.     /**
  10.      * 是否使用
  11.      */
  12.     protected Integer usage;

(2)查询品牌接口

  1.     /**
  2.       * 查询品牌列表
  3.       * @param request 请求参数
  4.       * @return com.taobao.gpf.common.ResultDTO<com.taobao.gpf.common.response.BrandsDTO>
  5.       */
  6.     ResultDTO<List<BrandsDTO>> getAmBrands(BrandsQueryRequest request);

入参：

  1.     //国家
  2.     protected String articleCountry;
  4.     //语言
  5.     protected String lang;

出参：

  1.      /**
  2.      * 品牌id
  3.      */
  4.     protected Long brandId;
  5.     /**
  6.      * 品牌logoid
  7.      */
  8.     protected String brandLogoID;
  9.     /**
  10.      * 品牌名称
  11.      */
  12.     protected String brandName;

(3)根据OE号查询配件信息接口

  1.    /**
  2.      * 查询零件列表
  3.      * @param request 请求参数
  4.      * @return com.taobao.gpf.common.ResultDTO<com.taobao.gpf.common.response.ArticlesDTO>
  5.      */
  6.     ResultDTO<List<ArticleDTO>> getArticles(ArticlesQueryRequest request);

入参：

  2.     //配件国家
  3.     protected String articleCountry;
  5.     //查询条件
  6.     protected String searchQuery;
  8.     /**
  9.      *  0: Article Number (DEFAULT),
  10.      *  1: OE Number, 原厂零件件号（OE号）查找
  11.      *  2: Trade Number,
  12.      *  3: Comparable Number,
  13.      *  4: Replacement Number,
  14.      *  5: Replaced Number,
  15.      *  6: EAN Number,
  16.      *  7: Criteria Number,
  17.      *  10: 任意编号,
  18.      *  99: 自定义文本
  19.      */
  20.     //查询编号类型
  21.     protected Integer searchType;
  23.     /**
  24.      *  exact: Exact Match (DEFAULT),
  25.      *  prefix: Prefix Match, 
  26.      *  suffix: Suffix Match, 
  27.      *  prefix_or_suffix: Prefix or Suffix Matching
  28.      */
  29.     //查询匹配类型
  30.     protected String searchMatchType;
  32.     //传统配件id
  33.     protected List<Long> legacyArticleIds;
  35.     //数据供应商/品牌id
  36.     protected List<Integer> dataSupplierIds;
  38.     /**
  39.      * 663：制动助力器阀门
  40.      * 339：压缩空气干燥器
  41.      * 1914：外后视镜玻璃
  42.      * 1319：多道阀
  43.      * 107：大灯灯泡
  44.      * 3255：弯道观察后视镜玻璃
  45.      * 348：拖车控制阀
  46.      * 1665：电子线圈接头
  47.      * 1457：白炽灯泡
  48.      * 369：空压机消声器
  49.      * 1329：继动阀
  50.      * 4017：继动阀修理组件
  51.      * 106：聚光灯灯泡
  52.      * 2：起动机
  53.      * 2110：轴承
  54.      * 370：铰链
  55.      * 3698：驻车制动杆
  56.      * 355：驻车制动阀
  57.      */
  58.     //产品组id
  59.     protected List<Integer> genericArticleIds;
  61.     //装配组id
  62.     protected List<Long> assemblyGroupNodeIds;
  64.     /**
  65.      * Filter to parts that are linked to this target id (also requires the linkingTargetType)
  66.      */
  67.     //关联目标id
  68.     protected Long linkageTargetId;
  69.     /**
  70.      * 'P': Vehicle Type (Passenger + Motorcycle + LCV),
  71.      * 'V': Passenger Car,
  72.      * 'L': LCV,
  73.      * 'B': Motorcycle,
  74.      * 'O': CV Type (Commercial Vehicle + Tractor),
  75.      * 'C': Commercial Vehicle,
  76.      * 'T': Tractor,
  77.      * 'M': Engine,
  78.      * 'A': Axle,
  79.      * 'K': CV Body Type,
  80.      * 'H': HMD Vehicle,
  81.      * 'S': Vehicle Model Series
  82.      */
  83.     //关联目标类型
  84.     protected String linkageTargetType;
  86.     /**
  87.      * Only include articles added since this date (YYYY-MM-DD).
  88.      */
  89.     protected String newArticlesDateFrom;
  90.     /**
  91.      * Only include articles added up until this date (YYYY-MM-DD).
  92.      */
  93.     protected String newArticlesDateTo;
  95.     /**
  96.      * Only include articles with linkages added since this date (YYYY-MM-DD). Note: This is only accurate with a limited number of other filters.
  97.      */
  98.     protected String newLinkagesDateFrom;
  99.     /**
  100.      * Only include articles with linkages added up until this date (YYYY-MM-DD). Note: This is only accurate with a limited number of other filters.
  101.      */
  102.     protected String newLinkagesDateTo;
  103.     /**
  104.      * Only include new linkages with this mfr id. Only valid if using the newLinkagesDateFrom or newLinkagesDateTo field.
  105.      */
  106.     protected Integer newLinkagesMfrId;
  108.     //语言
  109.     protected String lang;
  111.     //每页个数
  112.     protected Integer perPage;
  114.     //当前页
  115.     protected Integer page;
  117.     /**
  118.      * Include ALL Data in the response. Defaults to false.
  119.      */
  120.     protected Boolean includeAll;
  122.     /**
  123.      * Include Misc Article Data. Defaults to false.
  124.      */
  125.     protected Boolean includeMisc;
  127.     /**
  128.      * Include the Article Text in the response. Defaults to false.
  129.      */
  130.     protected Boolean includeArticleText;
  132.     /**
  133.      * Include Global Trade Identification Numbers (GTINs) associated with the part in the response. Note: This includes EANs. Defaults to false.
  134.      */
  135.     protected Boolean includeGTINs;
  137.     /**
  138.      * Include Trade Numbers in the response. Defaults to false.
  139.      */
  140.     protected Boolean includeTradeNumbers;
  142.     /**
  143.      * Include OEM Numbers in the response. Defaults to false.
  144.      */
  145.     protected Boolean includeOEMNumbers;
  147.     /**
  148.      * Include information about articles replaced by this part in the response. Defaults to false.
  149.      */
  150.     protected Boolean includeReplacesArticles;
  152.     /**
  153.      * Include information about articles that replace this part in the response. Defaults to false.
  154.      */
  155.     protected Boolean includeReplacedByArticles;
  157.     /**
  158.      * Include Article Criteria (TAF Table #210) in the response. Defaults to false.
  159.      */
  160.     protected Boolean includeArticleCriteria;
  162.     /**
  163.      * Include Linkage and Linkage Criteria information in the response (only valid if filtering by linkage id). Defaults to false.
  164.      */
  165.     protected Boolean includeLinkages;
  167.     /**
  168.      * Include PDFs in the response. Defaults to false.
  169.      */
  170.     protected Boolean includePDFs;
  172.     /**
  173.      * Include Images in the response. Defaults to false.
  174.      */
  175.     protected Boolean includeImages;
  177.     /**
  178.      * 是否返回所有品牌
  179.      */
  180.     protected Boolean includeDataSupplierFacets;
  181.     /**
  182.      * 是否返回所有产品组
  183.      */
  184.     protected Boolean includeGenericArticleFacets;
  186.     /**
  187.      * Include Generic Article Information in the response. Defaults to false.
  188.      */
  189.     protected Boolean includeGenericArticles;
  191.     /**
  192.      * Include the facet counts for article and linkage (only included if filtering by linkage id) criteria. Defaults to false
  193.      */
  194.     protected Boolean includeCriteriaFacets;
  197.     protected Boolean includeArticleStatusFacets;
  199.     /**
  200.      * Include Comparable Numbers in the response (Note: Right now only comparable numbers that match the search query are included). Defaults to false.
  201.      */
  202.     protected Boolean includeComparableNumbers;
  204.     /**
  205.      * Include the Links in the response. Defaults to false.
  206.      */
  207.     protected Boolean includeLinks;
  209.     /**
  210.      * Include the Prices in the response. Defaults to false.
  211.      */
  212.     protected Boolean includePrices;
  214.     /**
  215.      * Only include prices active on this date (YYYY-MM-DD).
  216.      */
  217.     protected String priceDate;
  219.     /**
  220.      * Include Article Logistics Criteria (TAF 2.5 Table #213) in the response. Defaults to false.
  221.      */
  222.     protected Boolean includeArticleLogisticsCriteria;
  224.     /**
  225.      * Filter on Article Status (Key Table 73)
  226.      */
  227.     protected List<Integer> articleStatusIds;
  229.     /**
  230.      * Only include articles since this date (YYYY-MM-DD). Requires articleStatusIds field.
  231.      */
  232.     protected String articleStatusDateFrom;
  234.     /**
  235.      * Only include articles up until this date (YYYY-MM-DD). Requires articleStatusId field.
  236.      */
  237.     protected String articleStatusDateTo;

出参：

  1. /**
  2.      * 数据供应商/品牌id
  3.      */
  4.     protected long dataSupplierId;
  5.     /**
  6.      * 零件编号
  7.      */
  8.     protected String articleNumber;
  9.     /**
  10.      * 制造商id
  11.      */
  12.     protected long mfrId;
  13.     /**
  14.      * 制造商名称
  15.      */
  16.     protected String mfrName;
  17.     /**
  18.      * 基本信息
  19.      */
  20.     protected MiscArticleDataRecordDTO misc;
  22.     /**
  23.      * 产品组信息
  24.      */
  25.     protected List<GenericArticleRecordDTO> genericArticles;
  27.     /**
  28.      * 描述信息
  29.      */
  30.     protected List<ArticleTextRecordDTO> articleText;
  32.     /**
  33.      * GTIN/EAN 编号
  34.      */
  35.     protected List<String> gtins;
  37.     /**
  38.      * 贸易号码
  39.      */
  40.     protected List<String> tradeNumbers;
  42.     /**
  43.      * 原厂零件号（OE 号）信息
  44.      */
  45.     protected List<ArticleRefRecordDTO> oemNumbers;
  47.     /**
  48.      * 可代替零件信息，一般无
  49.      */
  50.     protected List<ArticleRefRecordDTO> replacesArticles;
  51.     /**
  52.      * 可被代替零件信息，一般无
  53.      */
  54.     protected List<ArticleRefRecordDTO> replacedByArticles;
  55.     /**
  56.      * 零件标准信息
  57.      */
  58.     protected List<CriteriaRecordDTO> articleCriteria;
  60.     /**
  61.      * pdf信息
  62.      */
  63.     protected List<PDFRecordDTO> pdfs;
  64.     /**
  65.      * 图片信息
  66.      */
  67.     protected List<ImageRecordDTO> images;
  69.     /**
  70.      * 搜索匹配的信息（是通过什么搜索出来的）
  71.      */
  72.     protected List<SearchQueryMatchDTO> searchQueryMatches;
  74.     /**
  75.      * 链接信息
  76.      */
  77.     protected List<LinkRecordDTO> links;
  79.     protected Integer totalLinkages;
  1.  /**
  2.      * 附加说明
  3.      */
  4.     protected String additionalDescription;
  5.     /**
  6.      * 状态id
  7.      */
  8.     protected Integer articleStatusId;
  9.     /**
  10.      * 状态描述
  11.      */
  12.     protected String articleStatusDescription;
  13.     /**
  14.      * 状态有效起始时间
  15.      */
  16.     protected Integer articleStatusValidFromDate;
  17.     /**
  18.      * 每个包装单位的数量
  19.      */
  20.     protected Integer quantityPerPackage;
  21.     /**
  22.      * 包装单位
  23.      */
  24.     protected Integer quantityPerPartPerPackage;
  25.     /**
  26.      * 是否自助包装
  27.      */
  28.     protected Boolean isSelfServicePacking;
  29.     /**
  30.      * 是否有强制性材料认证
  31.      */
  32.     protected Boolean hasMandatoryMaterialCertification;
  33.     /**
  34.      * 是否是二次零件
  35.      */
  36.     protected Boolean isRemanufacturedPart;
  37.     /**
  38.      * 是否是附件
  39.      */
  40.     protected Boolean isAccessory;
  41.     /**
  42.      * 批大小1
  43.      */
  44.     protected Integer batchSize1;
  45.     /**
  46.      * 批大小2
  47.      */
  48.     protected Integer batchSize2;
  1.     /**
  2.      * 产品组id
  3.      */
  4.     protected int genericArticleId;
  5.     /**
  6.      * 产品组名称
  7.      */
  8.     protected String genericArticleDescription;
  9.     /**
  10.      * 旧产品id
  11.      */
  12.     protected int legacyArticleId;
  1. /**
  2.      * 原厂零件号（OE 号）
  3.      */
  4.     protected String articleNumber;
  5.     /**
  6.      * 供应商/品牌id
  7.      */
  8.     protected Integer dataSupplierId;
  9.     /**
  10.      * 制造商id
  11.      */
  12.     protected int mfrId;
  13.     /**
  14.      * 制造商名称
  15.      */
  16.     protected String mfrName;
  17.     /**
  18.      * 是否匹配搜索查询
  19.      */
  20.     protected Boolean matchesSearchQuery;
  21.     /**
  22.      * 参考信息类型
  23.      */
  24.     protected String referenceTypeKey;
  25.     /**
  26.      * 参考信息
  27.      */
  28.     protected String referenceTypeDescription;

(4)根据泰安联零件id查询车型id接口

  1. /**
  2.      * 查询配件关联车型列表
  3.      * @param request 请求参数
  4.      * @return com.taobao.gpf.common.ResultDTO<com.taobao.gpf.common.response.LinkingTargetDTO>
  5.      */
  6.     ResultDTO<List<LinkingTargetDetailDTO>> getLinkingTargets(LinkingTargetQueryRequest request);

入参：

  1.     //国家
  2.     protected String articleCountry;
  4.     //零配件id
  5.     protected long articleId;
  7.     //国家
  8.     protected String country;
  10.     //语言
  11.     protected String lang;
  13.     //关联目标id
  14.     protected Long linkingTargetId;
  16.     /**
  17.      * V:乘用车
  18.      * O:商用车
  19.      * L:运输车
  20.      * B:摩托车
  21.      * VOLB:全部
  22.      */
  23.     //关联目标类型
  24.     protected String linkingTargetType;

出参：

  1.  /**
  2.      * 零件关联id
  3.      */
  4.     protected Long articleLinkId;
  5.     /**
  6.      * 关联目标id
  7.      */
  8.     protected Long linkingTargetId;
  9.     /**
  10.      * 是佛关联
  11.      */
  12.     protected boolean linked;
  13.     /**
  14.      * 关联目标类型
  15.      */
  16.     protected String linkingTargetType;

(5)根据泰安联id查询车型库信息

  1. /**
  2. * 根据泰安联id查询车型库信息
  3. * @param tecId
  4. * @return
  5. */
  6.     ResultDTO<List<CarInfoDTO>> findByTecId(String tecId);

入参：

名称 类型 备注
tecId String 泰安联车型id

出参：

  1.     private String afid; //车型库afid，唯一值
  2.     //车型库pv对信息
  3.     private Long countryPid;
  4.     private Long countryVid;
  5.     private Long makePid;
  6.     private Long makeVid;
  7.     private Long modelPid;
  8.     private Long modelVid;
  9.     private Long yearPid;
  10.     private Long yearVid;
  11.     private Long trimPid;
  12.     private Long trimVid;
  13.     private Long enginePid;
  14.     private Long engineVid;
  15.     //车型库pv对信息
  16.     private boolean hotSale; //是否是热销
  17.     private Byte carType;  //车型
  18.     private String tecId;  //泰安联车型id

(6)根据泰安联id批量查询车型库信息

  1. /**
  2.      * 根据泰安联id批量查询车型库信息
  3.      * @param tecIds
  4.      * @return
  5.      */
  6.     ResultDTO<List<CarInfoDTO>> findListByTecIds(List<String> tecIds);

入参：

名称 类型 备注
tecIds List 泰安联车型id集合

出参同上

(7)查询商品绑定的车型库信息

  1. /**
  2.      * 查询商品绑定的车型库信息
  3.      * @param productId
  4.      * @param sellerId
  5.      * @return
  6.      */
  7.     ResultDTO<List<CarInfoDTO>> findListByProductId(Long productId, Long sellerId);

入参：

名称 类型 备注
productId Long 商品id
sellerId Long 卖家id

出参同上

(8)批量增量更新商品的车型库信息

  1. /**
  2.      * 批量增量更新商品的车型库信息(先增量删除，再增量添加)
  3.      * @param addAfids 添加的车型库afid
  4.      * @param removeAfids 移除的车型库afid
  5.      * @return
  6.      */
  7.     ResultDTO<Boolean> updateProductCarInfo(Long productId, Long sellerId, List<String> addAfids, List<String> removeAfids);

入参：

名称 类型 备注
productId Long 商品id
sellerId Long 卖家id
addAfids List 添加的车型库afid集合
removeAfids List 删除的车型库afid集合

出参：true成功，false失败