📌  相关文章
📜  API 访问 https：www.sendle.com (1)

📅  最后修改于: 2023-12-03 14:39:18.300000             🧑  作者: Mango

API 访问 https://www.sendle.com

Sendle是一家无车承运人派送公司，提供基于互联网的物流服务，其API为开发者提供了快速、简便的渠道来接入Sendle的物流服务。通过使用Sendle API，您可以实现以下功能：

  • 创建货物订单
  • 获取所支持的国内和国际运输模式的价格计算方法
  • 预估特定包裹的运费和交货时间
  • 从您的Sendle仪表板中检索常规的报告和状态更新
访问API

要访问Sendle API，您需要在其网站上创建一个帐户，并获取一个API密钥。然后，您可以使用此密钥通过以下网址访问API：

https://api.sendle.com/v1

所有请求将使用HTTPS协议进行加密，并使用基本身份验证来验证您的帐户。

货物订单

要创建货物订单，您需要向Sendle API发送HTTP POST请求，并在请求主体中包括以下JSON参数：

  • pickupDate：字符串，形如yyyy-mm-dd的日期格式，指定货物的提货日期
  • earliestPickupTime：字符串，形如HH:mm:ss的时间格式，指定货物的最早提货时间
  • latestPickupTime：字符串，形如HH:mm:ss的时间格式，指定货物的最晚提货时间
  • description：字符串，描述此订单的内容
  • kilogramWeight：数字，指定订购的物品重量，单位为千克
  • cubicMetreVolume：数字，指定订购物品的体积，单位为立方米
  • sender：对象，指定寄件人详细信息，包括姓名、公司、街道地址、城市、省份、国家、邮政编码和电子邮件地址
  • receiver：对象，指定收件人详细信息，包括姓名、公司、街道地址、城市、省份、国家、邮政编码和电子邮件地址

以下是一个创建货物订单的示例请求：

POST /v1/orders HTTP/1.1  
Host: api.sendle.com  
Authorization: Basic {API_KEY}  
Content-Type: application/json

{  
    "pickupDate": "2019-12-25",  
    "earliestPickupTime": "9:00:00",  
    "latestPickupTime": "11:00:00",  
    "description": "A box of widgets",  
    "kilogramWeight": 2.5,  
    "cubicMetreVolume": 0.02,  
    "sender": {  
        "name": "John Smith",  
        "company": "ABC Inc",  
        "street1": "123 Main St",  
        "suburb": "",  
        "stateName": "NSW",  
        "postcode": "2000",  
        "country": "AU",  
        "phone": "0400123456",  
        "email": "john.smith@abc.com"  
    },  
    "receiver": {  
        "name": "Jane Smith",  
        "company": "XYZ Inc",  
        "street1": "456 High St",  
        "suburb": "",  
        "stateName": "NSW",  
        "postcode": "2000",  
        "country": "AU",  
        "phone": "0400123456",  
        "email": "jane.smith@xyz.com"  
    }
}
价格计算

要获取支持的国内和国际运输模式的价格计算方法，您需要向Sendle API发送HTTP GET请求，并在请求URL中包括所支持的国家：

https://api.sendle.com/api/quote/[{from_country}/]{to_country}/[{kilogram_weight}/[{cubic_metre_volume}/]]

如果“from_country”未指定，则默认通过从Australia发货。以下是一个获取价格计算方法的示例请求：

GET /api/quote/US/AU/5/0.1 HTTP/1.1  
Host: api.sendle.com  
Authorization: Basic {API_KEY}

响应将包括有关所请求运输模式的各种价格选项、摘要和长期合同的信息。

运费预估

要预估特定包裹的运费和交货时间，您需要向Sendle API发送HTTP POST请求，并在请求URL中包括以下JSON参数和查询参数：

  • kilogramWeight：数字，指定订购的物品重量，单位为千克
  • cubicMetreVolume：数字，指定订购物品的体积，单位为立方米
  • toSuburb：字符串，指定收件人地址的城市或城镇名称
  • toPostcode：字符串，指定收件人地址的邮政编码
  • toCountry：字符串，指定收件人地址的国家

以下是一个运费预估的示例请求：

POST /api/quote/request.json?pickup_suburb=Surry%20Hills&pickup_postcode=2010 HTTP/1.1  
Host: api.sendle.com  
Authorization: Basic {API_KEY}  
Content-Type: application/json

{  
    "kilogramWeight": 2.5,  
    "cubicMetreVolume": 0.02,  
    "toSuburb": "Richmond",  
    "toPostcode": "3121",  
    "toCountry": "AU"  
}

响应将包括有关预估运费和交货时间的详细信息。

报告和状态更新

要从您的Sendle仪表板中检索常规的报告和状态更新，您需要向Sendle API发送HTTP GET请求，并在请求URL中包括特定于所需报告和状态更新的查询参数。以下是一个报告和状态更新的示例请求：

GET /api/v2/reports/transactional.json?start={start_date}&end={end_date}&s={page_size}&p={page_number} HTTP/1.1  
Host: api.sendle.com  
Authorization: Basic {API_KEY}

响应将包括有关所请求报告和状态更新的各种详细信息。

参考资料