정기주문

정기주문 해지하기(FO)

put

기능 설명

  • FO 화면에서 선택한 정기주문을 해지합니다.


상세 설명

선택한 정기주문상태(OM009)를 해지로 변경합니다.

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringRequired

정기주문번호

Example: 1
rglrDeliSeqListinteger · int32[]Optional

정기주문순번 리스트

Responses
chevron-right
200

성공

No content

put
/v1/regularOrder/terminateRegularOrderFO

No content

정기주문 해지하기(BO)

put

기능 설명

  • BO 화면에서 선택한 정기주문을 해지합니다.


상세 설명

선택한 정기주문상태(OM009)를 해지로 변경합니다.

Header parameters
AuthorizationanyOptional

Access Token

Bodystring[]
string[]Optional
Responses
chevron-right
200

성공

No content

put
/v1/regularOrder/terminateRegularOrderBO

No content

정기주문 건너뛰기

put

기능 설명

  • 선택한 정기주문 상품의 주문을 건너뛰기 설정을합니다.


상세 설명

선택한 정기주문 상품의 건너뛰기여부를 Y로 변경합니다.

  • Y로 변경된 건너뛰기여부는 주문생성 시점에서 N으로 초기화됩니다.

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringRequired

정기주문번호

Example: 1
rglrDeliSeqListinteger · int32[]Optional

정기주문순번 리스트

Responses
chevron-right
200

성공

No content

put
/v1/regularOrder/skipRegularOrder

No content

정기주문신청서 조회

post

기능 설명

  • 정기주문신청서 정보를 조회합니다.


상세 설명

정기주문신청서 진입 시 회원의 정기주문신청서 정보를 조회합니다. 정기주문신청서 정보에는 결제수단, 주문상품, 주문배송, 적립 정보들이 포함됩니다.

  • 회원만 진입 가능하며 쿠폰, 할인은 조회 대상이 아닙니다.

  • 정기주문은 기본 배송지 자동설정 및 변경불가 이므로 배송지 정보는 회원 기본 배송지만 조회합니다.

  • 결제수단은 마이페이지>자동결제 카드 등록/변경 메뉴에 등록된 자동결제 카드 정보입니다.

수정번호

  • Release v2.00_240401 : 정기배송신청서 진입 시의 자동결제카드 체크 제거

  • Release v2.00_240401 : 정기주문자동결제카드정보 객체 변경

Header parameters
AuthorizationanyOptional

Access Token

Body

정기주문신청서 조회 Request DTO

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:
bsketNoListinteger · int64[]Required

장바구니번호

Example: [100009929]
Responses
chevron-right
200

성공

*/*

정기주문신청서 조회 Response DTO

post
/v1/regularOrderSheet/regularOrderSheet

정기주문 주기변경 전 유효성 검증(FO)

post

기능설명

  • 정기주문 주기 변경 전 유효성 검증을합니다.


상세내용

  • 정기주문의 신청기간과 신청일자를 파라미터로 받아 유효성 검증을합니다.

  • 변경 기간이 남은 기간보다 짧을 경우 exception을 발생시킵니다.

수정번호

  • Release v2.00_240401 : 정기주문 주기 변경 전 유효성 검증(FO) 분리

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringRequired

정기주문번호

rglrDeliTermCdstringRequired

정기주문기간코드

rglrDeliCycleCdstringRequired

정기주문주기코드(OM034)

rglrDeliCycleValstringRequired

정기주문일

Responses
chevron-right
200

성공

*/*
stringOptional
post
/v1/regularOrder/validateChangeRegularOrder

정기주문 처리상태, 단품, 주문수량 변경 및 상품추가 (BO)

post

기능설명

  • 정기주문 처리상태, 단품, 주문수량 변경 및 상품추가 후 저장합니다.


상세내용

  • 정기주문의 건너뛰기 여부를 변경합니다.

  • 정기주문의 단품을 변경합니다.

  • 정기주문의 상품을 새로 추가합니다.

  • 정기주문의 수량을 변경합니다.

Header parameters
AuthorizationanyOptional

Access Token

Body
Responses
chevron-right
200

성공

No content

post
/v1/regularOrder/saveRegularOrder

No content

정기주문 단품, 주문수량 변경 (FO)

post

기능설명

  • 정기주문 단품, 주문수량 변경합니다.


상세내용

  • 정기주문의 단품을 변경합니다.

  • 정기주문의 수량을 변경합니다.

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringRequired

정기주문번호

Example: 1
rglrDeliSeqinteger · int32Required

정기주문순번

Example: 1
skipYnstringOptional

건너뛰기여부

Example: Y
goodsNostringOptional

상품번호

Example: 1
goodsNmstringOptional

상품명

Example: 상품1
itmNostringRequired

단품번호

Example: 1
itmNmstringRequired

단품명

Example: 단품1
afterItmNostringRequired

변경할단품번호

Example: 1
rglrDeliQtyinteger · int32 · min: 1Optional

정기주문수량

Example: 1
rglrDeliTermCdstringOptional

정기주문기간코드(OM008)

Example: 1
rglrDeliCycleValstringOptional

정기주문주기값

Example: 1
rglrDeliStatCdstring · enumOptional

OM009(정기주문상태코드) 10: 진행중 , 20: 중단 , 30: 해지

Example: 10Possible values:
brandNostringOptional

브랜드번호

brandNmstringOptional

브랜드명

goodsNoAndItmNostringOptional
Responses
chevron-right
200

성공

No content

post
/v1/regularOrder/regularOrderOptionChange

No content

정기주문 생성 배치

post

기능설명

다음주문생성일자가 오늘인 정기주문 신청 데이터를 기반으로 주문을 생성합니다.

상세내용

  • 주문생성이 되면 해당 정기주문 상품들의 건너뛰기 여부를 초기화합니다.

  • 다음주문생성일을 계산하여 업데이트 하는데, 정기주문 종료일보다 이후면 해당 정기주문을 해지처리합니다.

  • 최근주문생성일을 업데이트합니다.

수정번호

  • Release v2.00_240401 : 정기주문 주문생성 시 다음주문예정일 계산 수정

  • Release v2.00_240401 : 건너뛰기 수정

  • Release v2.00_240627 : 토스 정기주문 결제 추가


특이사항

  • 해당 API는 BATCH 전용 API입니다.

Header parameters
AuthorizationanyOptional

Access Token

Bodystring[]
string[]Optional
Responses
chevron-right
200

성공

No content

post
/v1/regularOrder/registerRegularOrderBatch

No content

정기주문 주기변경 전 유효성 검증(BO)

post

기능설명

  • 정기주문 주기 변경 전 유효성 검증을합니다.


상세내용

  • 정기주문의 신청기간과 신청일자를 파라미터로 받아 유효성 검증을합니다.

  • 변경 기간이 남은 기간보다 짧을 경우 exception을 발생시킵니다.

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringRequired

정기주문번호

rglrDeliTermCdstringRequired

정기주문기간코드

rglrDeliCycleCdstringRequired

정기주문주기코드(OM034)

rglrDeliCycleValstringRequired

정기주문일

Responses
chevron-right
200

성공

*/*
stringOptional
post
/v1/regularOrder/isPossibleChangeRegularOrderDeliTerm

정기주문 건너뛰기 다음주문예정일 변경 여부 (FO)

post

기능설명

  • 건너뛰기를 요청할 때, 해당 정기주문의 다음주문예정일이 변경 될 예정인지 그 여부 값(true/false)을 내립니다.


상세내용

  • 건너뛰기 요청 파라미터를 보고 요청이 처리되었을 때, 해당 정기주문 상품의 건너뛰기 여부가 모두 Y가 된다고 확인되면 true로 응답합니다.

  • 그렇지 않은 경우, false로 응답합니다.

  • FO 전용으로 무조건 파라미터의 순번은 건너뛰기 Y 요청이라고 가정합니다. (건너뛰기 -> 주문예정 불가)

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringRequired

정기주문번호

Example: 1
rglrDeliSeqListinteger · int32[]Optional

정기주문순번 리스트

Responses
chevron-right
200

성공

*/*
willBeChangedbooleanOptional
nxtOrdGenDtstringOptional
post
/v1/regularOrder/isNextOrderDateWillBeChanged

정기주문 건너뛰기 다음주문예정일 변경 여부 (BO)

post

기능설명

  • 건너뛰기를 요청할 때, 해당 정기주문의 다음주문예정일이 변경 될 예정인지 그 여부 값(true/false)을 내립니다.


상세내용

  • 건너뛰기 요청 파라미터를 보고 요청이 처리되었을 때, 해당 정기주문 상품의 건너뛰기 여부가 모두 Y가 된다고 확인되면 true로 응답합니다.

  • 그렇지 않은 경우, false로 응답합니다.

  • BO 전용으로 파라미터의 건너뛰기 요청 값이 Y,N 둘 다 들어올 수 있다고 가정하여 변경 후의 결과를 예상해서 응답합니다.

Header parameters
AuthorizationanyOptional

Access Token

Bodyobject[]
rglrDeliNostringRequired

정기주문번호

Example: 1
rglrDeliSeqinteger · int32Required

정기주문순번

Example: 1
skipYnstringOptional

건너뛰기여부

Example: Y
goodsNostringOptional

상품번호

Example: 1
goodsNmstringOptional

상품명

Example: 상품1
itmNostringRequired

단품번호

Example: 1
itmNmstringRequired

단품명

Example: 단품1
afterItmNostringRequired

변경할단품번호

Example: 1
rglrDeliQtyinteger · int32 · min: 1Optional

정기주문수량

Example: 1
rglrDeliTermCdstringOptional

정기주문기간코드(OM008)

Example: 1
rglrDeliCycleValstringOptional

정기주문주기값

Example: 1
rglrDeliStatCdstring · enumOptional

OM009(정기주문상태코드) 10: 진행중 , 20: 중단 , 30: 해지

Example: 10Possible values:
brandNostringOptional

브랜드번호

brandNmstringOptional

브랜드명

goodsNoAndItmNostringOptional
Responses
chevron-right
200

성공

*/*
willBeChangedbooleanOptional
nxtOrdGenDtstringOptional
post
/v1/regularOrder/isNextOrderDateWillBeChangedBO

주기변경 후의 정기주문예정일 조회(FO)

post

기능설명

  • 주기변경 후의 정기주문예정일을 조회합니다.


상세내용

  • 2023.03.11(월) 형식으로 반환합니다.

  • 변경일로부터 해당 주문의 주기가 지난 이후부터 날짜를 계산합니다.

수정번호

  • Release v2.00_240401 : 정기주문 주기변경 시 다음주문예정일 계산 수정

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringOptional
rglrDeliTermCdstringOptional
rglrDeliStrDtstringOptional
rglrDeliEndDtstringOptional
rglrDeliCycleCdstringOptional
rglrDeliCycleValstringOptional
nxtOrdGenDtstringOptional
accpDtmstring · date-timeOptional
rglrDeliStatCdstringOptional
rglrDeliStatCdNmstringOptional
lastRglrDeliSeqinteger · int32Optional
Responses
chevron-right
200

성공

*/*
stringOptional
post
/v1/regularOrder/getNextRegularOrderDate

정기주문 상품 삭제 (BO)

post

기능설명

  • 정기주문에 등록된 상품을 삭제합니다.


상세내용

  • 정기주문번호와 정기주문순번에 해당하는 상품을 삭제합니다.

  • 모든 상품을 삭제하는 것은 불가능합니다.

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringRequired
rglrDeliSeqListinteger · int32[]Required
Responses
chevron-right
200

성공

No content

post
/v1/regularOrder/deleteRegularOrderGoods

No content

정기주문 주기변경 (BO)

post

기능설명

  • 정기주문 주기를 변경합니다.


상세내용

  • 정기주문의 신청기간과 신청일자를 변경합니다.

  • 변경 기간이 남은 기간보다 짧을 경우 exception을 발생시킵니다.

  • 정기주문의 변경한 신청기간과 신청일자에 해당하는 다음주문예정일을 업데이트합니다.

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringRequired

정기주문번호

rglrDeliTermCdstringRequired

정기주문기간코드

rglrDeliCycleCdstringRequired

정기주문주기코드(OM034)

rglrDeliCycleValstringRequired

정기주문일

Responses
chevron-right
200

성공

No content

post
/v1/regularOrder/changeDeliTermRegularOrder

No content

정기주문 주기변경 (FO)

post

기능설명

  • 정기주문 주기를 변경합니다.


상세내용

  • 정기주문의 신청기간과 신청일자를 변경합니다.

  • 변경 기간이 남은 기간보다 짧을 경우 exception을 발생시킵니다.

  • 정기주문의 변경한 신청기간과 신청일자에 해당하는 다음주문예정일을 업데이트합니다.


수정번호

  • Release v2.00_240509: 월단위 정기주문 주기 변경 적용

  • Release v2.00_240523: 다음 주문일자 계산 공통화 작업

Header parameters
AuthorizationanyOptional

Access Token

Body
rglrDeliNostringRequired

정기주문번호

rglrDeliTermCdstringRequired

정기주문기간코드

rglrDeliCycleCdstringRequired

정기주문주기코드(OM034)

rglrDeliCycleValstringRequired

정기주문일

Responses
chevron-right
200

성공

No content

post
/v1/regularOrder/changeDeliTermRegularOrderFO

No content

정기주문 신청

post

기능설명

정기주문을 신청합니다.

상세내용

  • 정기주문신청서에서 작성한 내용으로 정기주문 신청 데이터를 생성합니다. (기본, 배송지, 상품)

수정번호

  • Release v2.00_240401 : 정기주문신청서 이력 에러 수정

Header parameters
AuthorizationanyOptional

Access Token

Body

정기주문생성 정보

Responses
chevron-right
200

성공

No content

post
/v1/regularOrder/applyForRegularOrder

No content

정기주문번호 채번

get

기능 설명

  • 정기주문번호를 채번합니다.


상세 설명

정기주문신청서에서 신청완료 직전에 호출되어 정기주문번호를 채번합니다.

Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

성공

*/*
stringOptional
get
/v1/regularOrderSheet/getRglrDeliNo

정기주문신청완료정보 조회

get

기능 설명

  • 정기주문신청 성공 후 정기주문신청 정보를 조회하는 API 입니다.


상세 설명

  • 정기주문번호와 주문매체코드값이 필수값입니다.

  • 정기주문번호에 해당하는 정기주문 완료 정보를 조회합니다.

수정번호

  • Release v2.00_240401 : 조회정보 추가(정기주문상태, 정기주문기간, 정기주문주기)

Query parameters
rglrDeliNoStringOptional

정기주문번호

ordMediaCdStringOptional

주문매체코드

Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

주문완료 조회 성공

application/json

정기주문신청완료

get
/v1/regularOrder/getRegularOrderCompleteInfo

건너뛰기 이후 다음 주문 신청일 조회

get

기능설명

  • 건너뛰기 이후 다음 주문 신청일 조회합니다.

상세내용

  • 건너뛰기 이후 다음 주문 신청일 조회합니다.

Query parameters
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

성공

*/*
stringOptional
get
/v1/regularOrder/getAfterSkipNxtOrdGenDt

Last updated