Holiday Add
우편번호별 휴일 정보를 쿠팡에 등록하는 API 입니다.
- API 호출 방향 : Vendor -> Coupang
- URL : /v1/3pfl/holidays/add/{format}
- 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 | 다섯자리(또는 여섯자리) 우편번호 | |
| holiday | Root Array | String | Y | YYYY-MM-DD | |
| dateName | Root Array | String | N | 휴일 이름 | |
| shippingCompanyId | Root Array | String | Y | 쿠팡에 등록된 업체배송명 (사전 공유 고정값) |
Request Example
[
{
"zipCode": "01010",
"holiday": "2020-08-09",
"dateName": "공휴일",
"shippingCompanyId": "SHIPPING_COMPANY"
},
{
"zipCode": "01011",
"holiday": "2020-08-09",
"dateName": "공휴일",
"shippingCompanyId": "SHIPPING_COMPANY"
}
]
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
}
유의사항
- {format} 에는 두 가지가 들어갈 수 있습니다.
- "format5": 다섯자리 우편번호
- "format6": 여섯자리 우편번호
- 리스트의 최대 사이즈가 존재합니다.
- 최대 사이즈는 협의 후 정의하고, 우편번호 갯수에 따라서 적절하게 그룹핑하여 전달해야 합니다.
- 최초 오픈 시 미래 22일의 휴일정보를 받습니다. 이후 하루에 한 번씩 하루 단위로 휴일 정보를 받습니다.
- 휴일 정보가 있는 우편번호만 전달합니다. (즉, 없는 날짜는 근무일로 취급합니다.)
- Capa 상의 이슈로 우편번호 휴일이 변경될 시 우편번호별 휴일정보를 업데이트해서 보내줘야합니다.
- 휴일정보 업데이트 필요시 바로 보내주셔야 합니다.
Holiday Delete
쿠팡에 등록된 우편번호별 휴일 정보를 삭제하는 API 입니다.
- API 호출 방향 : Vendor -> Coupang
- URL : /v1/3pfl/holidays/delete/{format}
- 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 | 다섯자리(또는 여섯자리) 우편번호 | |
| holiday | Root Array | String | Y | YYYY-MM-DD | |
| dateName | Root Array | String | N | 휴일 이름 | |
| shippingCompanyId | Root Array | String | Y | 쿠팡에 등록된 업체배송명 (사전 공유 고정값) |
Request Example
[
{
"zipCode": "01010",
"holiday": "2020-08-09",
"dateName": "공휴일",
"shippingCompanyId": "SHIPPING_COMPANY"
},
{
"zipCode": "01011",
"holiday": "2020-08-09",
"dateName": "공휴일",
"shippingCompanyId": "SHIPPING_COMPANY"
}
]
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에서 URL이 변경되었습니다. (/add/ -> /delete/)
- Soft delete 방식입니다. 즉, 요청받은 휴일 데이터는 쿠팡 DB에서 삭제되지 않고, isDeleted 컬럼이 true로 업데이트 됩니다.