获取仓库发货

本指南将引导您完成从JUSDA API获取仓库发货。

认证方式

JUSDA使用API密钥进行身份验证。 目前,API密钥是由JUSDA的技术团队分配的。 要获取密钥,请联系您的JUSDA销售代表。

获得API密钥后,要进行身份验证,需要在每次调用的HTTP请求的header中传递密钥。 给header key传x-api-key. 将密钥作为值传递。 例如: x-api-key=34A81032-979E-4EFC-9A6F-87E2973F3E20

如果对您的密钥进行身份验证有任何问题,则API将以HTTP 401代码进行响应。

测试

JUSDA可能会为您提供设置为我们测试环境的API密钥。 不过,如果您具有生产环境的API密钥,则可以通过在端点的查询字符串中包含environment属性来在任何API调用上使用测试环境。 例如:

https://services.jusdausa.com/api/v1/Rates?environment=Test

API 端点

JUSDA API的URL为:

https://services.jusdausa.com/api/v1

向此端点添加您要访问的资源。 例如,获取仓库发货的端点是:

https://services.jusdausa.com/api/v1/WarehouseShipments

仓库出货URL参数

/WarehouseShipments API在其查询字符串中接受各种过滤器值。 还支持分页。 以下是一些API调用示例,其中说明了查询的执行方式。

https://services.jusdausa.com/api/v1/WarehouseShipments?orderNo=RJUSDA00003

上面的示例将检索具有OrderNo RJUSDA00003的单笔仓库出货。


https://services.jusdausa.com/api/v1/WarehouseShipments?limit=10

上面的示例将检索最近的10个仓库发货。


https://services.jusdausa.com/api/v1/WarehouseShipments?limit=10&page=3

Limit指定要返回的最大行数。 Page指定页码。 在这种情况下,将检索位置20-29的货物。

获取仓库发货的查询字符串参数

在HTTP GET查询字符串中使用以下任何参数来筛选搜索现有的仓库出货。

  • modifiedDateFrom: (可选) 支持搜索在日期范围内创建或更新的出货
  • modifiedDateTo: (可选) 支持搜索在日期范围内创建或更新的出货
  • shipmentNo: (可选) 我们仓库系统中JUSDA的发货编号
  • orderNo: (可选) 检索特定的出货编号
  • limit: (可选) 默认值为100
  • page: (可选) 默认为1
  • environment: (可选) 测试或生产。 默认值为生产。

响应Payload示例


            [
                {
                    "ShipmentNo": "WSOTEST1737",
                    "OrderNo": "RJUSDA00002",
                    "ReceiptDate": "2021-01-28T10:37:36.25",
                    "ShipmentDate": "0001-01-01T00:00:00",
                    "ShipperName": "JUSDA USA",
                    "ShipperAddress1": null,
                    "ShipperAddress2": null,
                    "ShipperCity": null,
                    "ShipperStateProvince": null,
                    "ShipperPostalCode": null,
                    "ShipperCountryCode": null,
                    "ShipperTelNo": null,
                    "ConsigneeName": "",
                    "ConsigneeAddress1": "1 Fenton Street",
                    "ConsigneeAddress2": null,
                    "ConsigneeCity": "New York",
                    "ConsigneeStateProvince": "NY",
                    "ConsigneePostalCode": "10036",
                    "ConsigneeCountryCode": "US",
                    "ConsigneeTelNo": null,
                    "Carrier": "UPS",
                    "CarrierTrackingNo": "1Z780V7A0460285423",
                    "CarrierServiceLevel": "UPS GROUND",
                    "PackType": null,
                    "PackQuantity": 0,
                    "Weight": null,
                    "WeightUnit": null,
                    "ModeOfTransport": null,
                    "ExternalOrderIdentifier": "RJUSDA00002",
                    "Items": [
                    {
                        "LineNo": "10",
                        "SKU": "5795",
                        "Description": null,
                        "Quantity": 1,
                        "LineReference": ""
                    }
                    ]
                }
            ]