Logo
Section 1 / 6

地址

学习如何创建、验证和获取 Shippo 地址。

导入

地址

学习如何创建、验证和获取 Shippo 地址。

我们需要提供发货地址和收货地址来寄送物品。在发货前，必须对这些地址进行验证，以避免发货失败。Shippo API 免费验证美国地址，并对实时令牌（live token）的全球（非美国）地址收取费用。如果使用测试令牌（test token），API 会对全球地址跳过验证。

代码示例

1https://api.goshippo.com/addresses/
字段类型必填/可选描述
name字符串必填收件人姓名。
company字符串可选公司名称。
street1字符串必填街道地址第一行。
street_no字符串可选街道门牌号。
city字符串必填城市名称。
zip字符串必填邮政编码。
state字符串必填地址所在州名。部分国家需要此字段。
country字符串必填国家名称，需使用 ISO 2 国家代码。
phone字符串可选联系电话。
email字符串可选电子邮箱。
is_residential字符串可选标识地址是住宅还是商业用途。
validate布尔值可选是否启用地址验证。
1url = 'https://api.goshippo.com/addresses/'
2
3headers = {
4    'Authorization': 'ShippoToken {{TOKEN}}',
5    'Content-Type': 'application/json'
6}
7
8payload = json.dumps({
9    "name": "Shawn Ippotle",
10    "company": "Shippo",
11    "street1": "215 Clayton St.",
12    "city": "San Francisco",
13    "state": "CA",
14    "zip": "94117",
15    "country": "US",
16    "email": "example@goshippo.com"
17})
18
19response = requests.request("POST", url, headers=headers, data=payload)
20pprint(response.json())
1payload = json.dumps({
2    'name': 'Mrs. Hippo',
3    "street1": "965 Mission St.",
4    "city": "San Francisco",
5    "state": "CA",
6    "zip": "94105",
7    "country": "US"
8})
字段类型描述
object_id字符串新创建地址对象的唯一标识 ID。
is_complete布尔值表示地址信息是否完整。
is_residential布尔值若设置 validate 为 true，API 可自动判断地址类型为住宅或商业。也可手动传入该标志；否则为 null。
test布尔值表示当前使用的是测试令牌还是实时令牌。
validation_results对象若开启验证，API 将返回验证结果对象，包含 is_valid 标志和 message 信息。若地址有效，is_valid 为 true，message 为空；若无效，is_valid 为 false，message 包含失败原因。
zip字符串启用验证时，API 会校验邮编并返回修正后的正确值（如原输入有误）。
latitude数字地址的纬度坐标，由 API 根据地址自动计算。
longitude数字地址的经度坐标，由 API 根据地址自动计算。

代码示例

1https://api.goshippo.com/addresses/{ADDRESS_OBJECT_ID}/validate/
1url = 'https://api.goshippo.com/addresses/{{ADDRESS_OBJECT_ID}}/validate/'
2
3headers = {
4    'Authorization': 'ShippoToken {{TOKEN}}',
5    'Content-Type': 'application/json'
6}
7
8res = requests.request("GET", url, headers=headers)
9pprint(res.json())

代码示例

1https://api.goshippo.com/addresses/
1url = 'https://api.goshippo.com/addresses/'
2
3headers = {
4    'Authorization': 'ShippoToken {{TOKEN}}',
5    'Content-Type': 'application/json'
6}
7
8res = requests.request("GET", url, headers=headers)
9pprint(res.json())

代码示例

1https://api.goshippo.com/addresses/{ADDRESS_OBJECT_ID}
1url = 'https://api.goshippo.com/addresses/{{ADDRESS_OBJECT_ID}}'
2
3headers = {
4    'Authorization': 'ShippoToken {{TOKEN}}',
5    'Content-Type': 'application/json'
6}
7
8res = requests.request("GET", url, headers=headers)
9pprint(res.json())

简介

包裹