开放 API
使用说明
获取授权
全部 API
- Shop
- Metafields
- Customer
- CustomerAddress
- Account
- Product
- ProductVariant
- ProductImage
- Theme
- Asset
- Country
- Province
- City
- District
- ScriptTag
- Order
- Shipment
- ShipmentSupplier
- Payment
- PaymentMethod
- Redirect
- Page
- Webhook
- Blog
- BlogAuthor
- CustomerLevel
- StoreFile
- Promotion
- Coupon
- Post
- AfterSale
Province
Province
地址中,国家下的省份对象,通过API只可读,不可修改。
Province 相关API
Province 属性
- code
String 类型,唯一编码标识。{ "code" : "230000" }
- name
String 类型,省份名称。{ "name" : "黑龙江" }
- full_name
String 类型,省份名称全称。{ "full_name" : "黑龙江省" }
- region
String 类型,省份所属名称。{ "region" : "东北" }
GET /countries/#{country_id}/provinces
获取指定国家中所有省份列表
- limit
- 可选,返回结果条数
默认10,最大50
- page
- 可选,显示的页码
默认1
- code
- 可选,指定省份编码
- name
- 可选,指定省份名称
- 获取 ID 为 1 的国家下所有省份
- GET /countries/1/provinces
{ "provinces": [ { "cities": [ ], "code": "230000", "full_name": "黑龙江省", "name": "黑龙江", "region": "东北" } ] }
GET /countries/#{country_id}/provinces/count
获取指定国家下,所有省份数量
- 获取 Country 总数
- GET /countries/1/provinces/count
{ "count": 34 }
GET /countries/#{country_id}/provinces/#{province_code}
获取指定国家下,指定 Code 的省份内容
- 获取 ID 为 1 的 Country 下,省份 Code 为 440000 的内容
- GET /countries/1/provinces/440000
{ "province": [ { "cities": [ ], "code": "440000", "full_name": "广东省", "name": "广东", "region": "华南" } ] }