创建仓库出库订单
本指南将引导您创建使用JUSDA配送服务的仓库订单。 成功创建仓库订单后,该订单将由JUSDA的仓库管理系统处理并发货。 要跟踪仓库订单的状态,请使用GET WarehouseOrder端点。 要检索已确认的仓库装运详细信息,请使用GET WarehouseShipment端点。
请注意,此API支持更新。 如果您以相同的订单编号发布第二个请求,该订单将在JUSDA的系统中更新。 您可以使用这种方法通过orderStatusIdentifier属性取消订单。
认证方式
JUSDA使用API密钥进行身份验证。目前,API密钥是由JUSDA的技术团队分配的。要获取密钥,请联系您的JUSDA销售代表。
获得API密钥后,要进行身份验证,有必要在每次调用的HTTP header中传递密钥。Header的key为 x-api-key, 将密钥作为值传递。例如:
x-api-key=34A81032-979E-4EFC-9A6F-87E2973F3E20
如果在对您的密钥进行身份验证时有任何问题,则API将在响应中回复HTTP代码401。
API 端点
JUSDA API的URL为:
https://services.jusdausa.com/api/v1/WarehouseOrder
该API使用HTTP POST。下面将描述如何提供正确的payload。
Post WarehouseOrder Payload
创建一个如下所示的JSON格式的payload。 请注意,此端点希望提供一个数组,该数组中包括一个或多个预订。 payload的关键属性包括:
- customerName: (必需) 您在JUSDA系统中的customerName。 向您的JUSDA联系人请求此值。
- orderNo: (必需) 您的订单号
- externalOrderIdentifier: (可选) 一个附加的参考号码。该参考号码在获取订单状态时也会返回。可用于跟踪具有您的系统生成的标识号的订单。
- orderDate: (必需) 处理订单的日期。 使用YYYY-MM-DD格式。
- warehouseCode: (必需) 应满足订单的JUSDA仓库代码。 向您的JUSDA联系人请求此值
- shipToName: (必需)
- shipToAddress1: (必需)
- shipToAddress2: (可选)
- shipToCity: (必需)
- shipToPostalCode: (必需) 邮政编码
- shipToCountry: (必需) 2位ISO国家/地区代码,例如US或CN
- ShipToTelNo: (可选)
- ShipToEmail: (可选)
- notesFromBuyer: (可选) 与订单有关的应传达给JUSDA的仓库工作人员的任意文字注释
- notesToBuyer: (可选) 与订单有关的应传达给买方的任意文字注释
- carrier: (可选) 用来发送订单应使用的承运商,如果还没有建立预定的路线指导的话。
- serviceLevel: (可选) 如果尚未建立预定的路由指南,则应该用于运送订单的服务级别。
- orderStatusIdentifier: (可选) 您的系统中对订单状态的描述。 可用于提供仍在处理中但尚未准备好发货的订单。 使用CANCEL取消先前已发送的订单。
- shipperReference2: (可选) 附加参考号。 只有某些运营商支持
- items: (必需) 一个数组,其中每个被发货的商品都是一个item
- lineNo: (必需) 此订单商品的顺序行号,例如10、20、30等。
- sKU: (必需) 您的SKU或部件号。
- quantity: (必需) 该物品的取件和运送数量
- lineReference: (必需) 您可以在item层级使用的附加参考编号。 将在WarehouseOrder和WarehouseShipment GET中返回
请求示例
{
"customerName" : "ABC Technology Corporation",
"orderNo": "ABC001",
"orderDate" : "2021-01-25",
"warehouseCode" : "USA-Whittier",
"shipToName" : "Mary White",
"shipToAddress1" : "1625 Electric Ave",
"shipToAddress2" : "",
"shipToCity" : "Los Angeles",
"shipToStateProvince" : "CA",
"shipToPostalCode" : "90045",
"shipToCountryCode" : "US",
"shipToTelNo" : "",
"shipToEmail" : "mary.white@gmail.com",
"notesFromBuyer" : "Hot order",
"shippingMethod" : "Fedex Ground",
"orderStatusIdentifier" : "READY",
"items" : [
{
"lineNo" : "10",
"sKU" : "Part1",
"quantity" : 10.00
},
{
"lineNo" : "20",
"sKU" : "Part2",
"quantity" : 400.00
}
]
}
WarehouseOrder Response Payload
响应payload将以确认成功或错误的消息进行响应。
成功的响应示例
{
"message": "Warehouse order added successfully"
}
失败的响应示例
{
"error": "OrderNo is 必需"
}
API 文档
有关创建预定订单API端点的更多详细信息,请参见JUSDA的 API 文档.