Wayfair CG库存

四、Wayfair官方新版开发者门户和API上线流程

请严格按照以下官方流程操作。沙盒测试简而言之分为3步：①在后台创建App获取client_id和client_secret → ②在Postman使用client_id和client_secret获取Token → ③在Postman使用Token和suid完成沙盒测试

• 新的PH后台关于API集成界面会改变成下图所示，其他功能全部移到wayfairAPI开发者门户。（https://developer.wayfair.io）

• 创建APP获取client_id和secret需要通过登录开发者中心
• 供应商（注：供应商指平台卖家）可以通过网站链接登录或者通过PH后台的Developer portal。（上图红框）
• 现在所有API功能和对接都是自动授权，做完沙盒测试后直接自动授权至生产环境，无需再开ticket去要求人工手动授权。
• 相关资料，测试视频都能在wayfair API开发者门户中找到，此文本为辅助资料。一切以门户为主

1. 如何使用新的开发者门户

1.1 创建APP（Application management）

①供应商进入开发者门户点击“Sign In” 按钮, 使用 Partner Home 的用户名密码登录。（如果需要切换中文，可点击sign in 旁边的language切换到中文）

 ②成功登录后，下面的功能选项会出现在开发者门户的页面最上端

注意：如果供应商在开发者门户上登陆PH账号后没有对应的功能，请确认是否有自己授予API权限，按照文档最后的指引授权（此步骤和老版本没差别）

③点击最上方的“ApplicationManagement”功能

④再点击右上方的 ”Create New Application”

⑤在application creation 页面:

• 填写App名字和App描述
• 选择Sandbox Application（沙盒APP）、
• 点击“Save and Create“完成创建

⑥当沙盒APP创建完后请务必记录Client ID 和 Client Secret（如下图所示） — 会被用来获取token来完成API对接认证

⑦成功创建完后这个沙盒APP会在”Sandbox Applications”下面显示

⑧创建生产环境APP，按照创建沙盒APP相同步骤，在选择类别的时候选择“Production Application”

在创建完沙盒APP之后，请立刻创建生产APP。如果没有完成生产APP的创建，完成沙盒测试后，系统无法自动给到生产APP权限。

注意：确保供应商完成沙盒测试才能开始使用生产环境APP去对接真实数据

1.2 API验证和Token（Authentication and Token）

通过client_id和secret获取token。 此过程并没有任何改变。详细信息参考开发者门户中 authentication guide 页面信息。

1.3 API 沙盒测试

现在可以通过沙盒APP的token开始沙盒测试

步骤1: 开始测试

①点击门户上方“Overview“功能卡

②点击 “Test in Sandbox“

③下拉框中选择想要对接的API功能并且复制”Sandbox URL”中的URL

注：CG仓库接口请选择“CastleGate Inventory On-Hand API”

步骤2: 测试沙盒API

①使用相关API调试工具，例如Postman（注：可以网上搜索Postman自行下载并使用）, 供应商创建新的Post请求并粘贴刚刚复制的Sandbox URL

②点击Postman中Auth页

选择Bearer Token作为 Auth Type，并输入 access_token (上述步骤获取的)到Token中

③选择 Body 页面 (此文举例自发货库存同步API；CG仓库存API的请求数据格式及参数 见https://developer.wayfair.io/posts/docs/inventory-visibility-onhand-api/reference/GraphQL/v1.0.0)

• 选择GraphQL 选项
• 在Query中,输入自发货库存同步请求数据格式
• 在 GraphQL Variables 中, 填入自发货库存同步测试参数
• 点击Send按钮发送测试数据

下图为CG仓库存API的请求示意图：

• supplierPartNumbers和warehouseId可以不填——也就是说，"filter": {   } 即可 
• suid即为supplierId；获取方式见https://www.lingxing.com/help/article/WayfairAuthorization

注:入参数据例如 Supplier ID, dates, and product details 应该精确参照真实数据。这个并不通用到所有API对接. 某些 API (例如CG库存查询 - CG inventory APIs) 并不会在沙盒中真实反馈供应商真实的现有CG库存数据, 无论入参什么沙盒都会反馈相同数据。

④当沙盒测试的API请求发送之后请导回新开发者门户的“Sandbox Testing“ 页面查看请求是否成功的状态.

如下图所示一个成功的库存同步沙盒测试请求会触发绿色成功通知，表明提交的数据结构没问题。

⑤当收到第一次成功的沙盒库存同步请求之后，会跳出如下图所示弹窗显示测试已经成功，权限已经被授权到生产环境。

⑥如果提供的沙盒测试有误，会在Sandbox Testing“ 页面显示红色提示。需要重新修改数据结构并提供正确参数（通过Postman等api调试工具）。

步骤 3: 上线!

现做完沙盒测试后可自动化的获取生产环境权限，无需做任何其他操作。

注：实测发现，沙盒测试通过后，需要一段时间才能获取到正式环境权限。因此沙盒测试通过后，可能起码过1天以上才能最终在页面上看到数据。

2. 沙盒测试解锁对应功能模块

所有API门户中星号标记的为必须测试，通过测试才能获取对应功能的生产环境权限。

点击“Overview“模块查看对应功能状态

自发货功能模块：

1. DropShip Purchase Order and ASN API（自发货订单，发货通知）
   1. Query all dropship purchase orders*（解锁获取订单功能）
   2. Accept a dropship purchase order*（解锁接受订单功能）
   3. Submit shipment notice with valid data*（解锁发货通知功能）
2. Dropship Inventory Feed API（自发货库存同步）
   1. Submit dropship inventory feed data*（解锁库存同步）
3. Dropship Order Cancellation API（取消订单）
   1. Query cancellation requests by warehouse numbers*（解锁通过仓库id获取取消订单）
   2. Query cancellation requests by purchase order numbers*（解锁通过订单号获取取消订单）
   3. Confirm valid cancellation request*（解锁同意取消）
   4. Reject cancellation request with valid reason*（解锁拒绝取消）
4. Registration API: Bill of Lading（注册面单-提货单）
   1. Get the Bill of Lading for a registered purchase order*（解锁提货单）
5. Registration API: Consolidated BOL（注册面单-合并提货单）
   1. Query consolidated BOL document for a valid date*（解锁合并提货单）
6. Registration API: Packing Slip（注册面单-装箱单）
   1. Get the Packing Slip for a registered purchase order*（解锁装箱单）
7. Registration API: Registration（注册面单-注册）
   1. Register a purchase order*（解锁注册面单）
   2. Query a registered purchase order*（解锁获取已注册过面单的订单历史记录）
8. Registration API: Shipping Label（注册面单-打印面单）
   1. Get the Shipping Label for a registered purchase order*（解锁获取面单）

CG功能模块：

1. CastleGate Forwarding Container Milestones API（CG入库单状态）
   1. Query inbound orders with basic pagination*（解锁CG入库单状态查询）
2. CastleGate Inventory On-Hand API（CG在库库存状态）
   1. Query WFN overview with comprehensive inventory positions*（解锁所有CG在库库存状态）
3. Castlegate Inventory Adjustment API（CG清货库存）
   1. Query inventory adjustments*（解锁CG清货库存状态）
4. Castlegate Orders and WSA API（CG单渠道订单和发货通知）
   1. Query all castlegate purchase orders*（解锁获取CG单渠道订单）
   2. Query all warehouse shipment advices*（解锁获取CG单渠道订单发货通知）
   3. Acknowledge an open castlegate purchase order using PO number*（解锁接受CG单渠道订单）
   4. Acknowledge an open warehouse shipping advice using WSA ID*（解锁接受CG单渠道订单发货通知）

CG多渠道功能模块：

1. Multichannel Order API（多渠道订单）
   1. Create valid fulfillment order*（解锁订单创建）
   2. Cancel valid fulfillment order（取消订单）
   3. Query order details by fulfillment order request ID*（获取订单状态）
   4. Query warehouse shipping advices with filters（获取发货通知）

___________________________________________________________________________________

附录

用户API权限

如果您登录wayfair新开发门户发现没有上述对应功能和选项页面，请检查您的PH账号的API权限已经勾选。导航至PH后台的Partner Home下User Management完成操作。