ZipCode Add
센터별 우편번호를 쿠팡에 추가하는 API 입니다.
- API 호출 방향 : Vendor -> Coupang
- URL : /v1/3pfl/zipcode/add
- Interface Style : Restful API
- HTTP Protocol : HTTPS
- Method : POST
Request Body
| Property Name | Parent Object | Data Type | Size | Mandatory | Description |
| Root | Array | Y | |||
| zipCode | Root Array | String | Y | 우편번호 | |
| centerCode | Root Array | String | N | 해당 우편번호를 등록할 센터 코드 | |
| leadTime | Root Array | Integer | N | 배송소요시간 (필요할 경우만 사용) | |
| eventTime | Root Array | String | N | 이벤트 발생 시간 |
Request Example
[
{
"zipCode": "10000",
"centerCode": "CENTER001",
"leadTime": 0,
"eventTime": "2020-10-21 23:59:59"
},
{
"zipCode": "10010",
"centerCode": "CENTER002",
"leadTime": 0,
"eventTime": "2020-10-21 23:59:59"
}
]
Response
| Property Name | Data Type | Size | Mandatory | Description |
| code | String | 20 | N | 결과값
|
| message | String | 100 | N | 에러 사유 |
| data | String/Object | - | N | Response Data |
Response Example
{
"code": "0",
"message": null,
“data”: null
}
유의사항
- 한 번의 API request에 최대 1,000 건의 우편번호를 추가할 수 있습니다.
- 1,000 건을 초과할 경우 실패 응답을 받게 됩니다.
ZipCode
쿠팡에 추가된 센터별 우편번호를 개별 조회하는 API 입니다.
- API 호출 방향 : Vendor -> Coupang
- URL : /v1/3pfl/zipcode/{zipcode}
- Interface Style : Restful API
- HTTP Protocol : HTTPS
- Method : GET
Request
- URL path variable로 조회하려는 zipCode를 전달합니다.
Response
| Property Name | Parent Object | Data Type | Size | Mandatory | Description |
| code | Root | String | 20 | N | 결과값
|
| message | Root | String | 100 | N | 에러 사유 |
| data | Root | Array(ZipCodeDto) | - | N | Response Data |
| zipCode | data | String | 20 | Y | 등록했던 우편번호 |
| centerCode | data | String | 20 | Y | 등록했던 centerCode |
| leadTime | data | Int | N | ||
| eventTime | data | String | N |
Response Example
{
"code": "0",
"message": null,
“data”: [
{
"zipCode": "01010",
"centerCode": "CENTER001",
"leadTime": 0,
"eventTime": "2020-10-21 23:59:59"
}
]
}
ZipCode All
쿠팡에 해당 Vendor에 대해서 추가된 센터별 우편번호 전체를 조회하는 API 입니다.
- API 호출 방향 : Vendor -> Coupang
- URL : /v1/3pfl/zipcode/all
- Interface Style : Restful API
- HTTP Protocol : HTTPS
- Method : GET
Response
| Property Name | Parent Object | Data Type | Size | Mandatory | Description |
| code | Root | String | 20 | N | 결과값
|
| message | Root | String | 100 | N | 에러 사유 |
| data | Root | Array(ZipCodeDto) | - | N | Response Data |
| zipCode | data | String | 20 | Y | 등록했던 우편번호 |
| centerCode | data | String | 20 | Y | 등록했던 centerCode |
| leadTime | data | Int | N | ||
| eventTime | data | String | N |
Response Example
{
"code": "0",
"message": null,
“data”: [
{
"zipCode": "01010",
"centerCode": "CENTER001",
"leadTime": 0,
"eventTime": "2020-10-21 23:59:59"
}
]
}
ZipCode Delete
센터별 우편번호를 쿠팡에서 삭제하는 API 입니다.
- API 호출 방향 : Vendor -> Coupang
- URL : /v1/3pfl/zipcode/delete
- Interface Style : Restful API
- HTTP Protocol : HTTPS
- Method : POST
Request Body
| Property Name | Parent Object | Data Type | Size | Mandatory | Description |
| Root | Array | Y | |||
| zipCode | Root Array | String | Y | 우편번호 | |
| centerCode | Root Array | String | N | 센터값이 없을 경우 해당 우편번호를 전체 센터에서 삭제합니다. |
Request Example
[
{
"zipCode": "10000",
"centerCode": "CENTER001"
},
{
"zipCode": "10010",
"centerCode": "CENTER002"
}
]
Response
| Property Name | Data Type | Size | Mandatory | Description |
| code | String | 20 | N | 결과값
|
| message | String | 100 | N | 에러 사유 |
| data | String/Object | - | N | Response Data |
Response Example
{
"code": "0",
"message": null,
“data”: null
}