您可查询已注册的发货地列表。
也可使用发货地名称和发货地代码查询已注册的发货地信息。
**查询发货地信息时使用的参数**
1.查询所有已注册发货地列表时：仅输入pageNum和pageSize即可
2.只查询所需的发货地信息时：仅输入 placeNames 或 placeCodes即可
Path
GET/v2/providers/marketplace_openapi/apis/api/v1/vendor/shipping-place/outbound
Example Endpoint
Request Parameters
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| placeCodes | Long |
发货地代码 创建送货地址时，作为Response信息显示的值 与 outboundShippingPlaceCode 相同 |
|||||
| placeNames | String |
发货地名称 与shippingPlaceName相同
|
|||||
| pageNum | Integer |
查询页数 Min = 1, Max: 返回的totalPages 值 ※ 查询列表时，请务必输入该数值 |
|||||
| pageSize | Integer |
每页最多查询数量 默认值=10, Max=50 ※未输入时，默认值将处理为10 |
|||||
Request Example
Response Message
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| content | Array |
发货地列表数据
|
||||||||||||
| outboundShippingPlaceCode | Long |
发货地代码
|
||||||||||||
| shippingPlaceName | String |
发货地名称 最多可输入50个字符 |
||||||||||||
| placeAddresses | Array |
发货地址 |
||||||||||||
| addressType | String |
地址类型 JIBUN, ROADNAME, OVERSEA |
||||||||||||
| countryCode | String |
国家代码，韩国国内为“KR”, 有效长度: 2 |
||||||||||||
| companyContactNumber | String |
电话号码
|
||||||||||||
| phoneNumber2 | String |
备用电话号码(格式：与电话号码相同) |
||||||||||||
| returnZipCode | String |
邮政编码: 数字 5～6位数 |
||||||||||||
| returnAddress | String |
地址，最长150个字符 |
||||||||||||
| returnAddressDetail | String |
详细住址，最长200个字符 |
||||||||||||
| remoteInfos | Array |
偏远地区配送信息
|
||||||||||||
| remoteInfoId | Number |
偏远地区配送信息ID |
||||||||||||
| deliveryCode | String |
物流公司代码 发货地创建API- 参考物流公司代码 |
||||||||||||
| jejuFee | Number |
济州地区配送费(韩元) |
||||||||||||
| notJeju | Number |
济州地区外的配送费(韩元) |
||||||||||||
| usable | Boolean |
偏远地区配送信息是否有效 true or false |
||||||||||||
| createDate | Object |
创建日期 YYYY/MM/DD |
||||||||||||
| usable | Boolean |
是否可用 true or false |
||||||||||||
| pagination | Object |
分页
|
||||||||||||
| currentPage | Number |
当前页 例) 1 |
||||||||||||
| totalPages | Number |
全部页Count 例) 1000 |
||||||||||||
| totalElements | Number |
全部数据Count 例) 1000 |
||||||||||||
| countPerPage | Number |
每页数据Count 例) 10, 20, 30 |
||||||||||||
Response Example
{
"content": [
{
"outboundShippingPlaceCode": 1111222,
"shippingPlaceName": "상품출고지1",
"createDate": "2019/06/24",
"placeAddresses": [
{
"addressType": "JIBUN",
"countryCode": "KR",
"companyContactNumber": "02-1234-5678",
"phoneNumber2": "031-1234-5678",
"returnZipCode": "05510",
"returnAddress": "서울특별시 송파구 신천동",
"returnAddressDetail": "7-30, Tower출고지"
}
],
"remoteInfos": [
{
"remoteInfoId": 581487,
"deliveryCode": "DIRECT",
"jeju": 5000,
"notJeju": 2500,
"usable": true
}
],
"usable": true
}
],
"pagination": {
"currentPage": 1,
"countPerPage": 1,
"totalPages": 1,
"totalElements": 1
}
}Error Spec
|
HTTP status code (Error type) |
Error message | Solution |
|---|---|---|
|
400 (确认请求参数) |
(pageNum & pageSize) or placeCodes or placeNames must be provided to call this API |
请确认是否输入了(pageNum & pageSize)或placeCodes, placeNames数值。 |
URL API Name
OUTBOUND_SHIPPING_PLACE