OPENAPI 변경사항 안내

[ 2020/04/03 OPENAPI 관련 변경사항 안내 ]

2020년 4월 6일부터 반품 프로세스가 변경됩니다.

4월6일 일정은 잠정 연기되었습니다.
정확한 일정은 추후 재안내할 예정입니다.
불편을 드려 죄송합니다.

이에 따라 반품관련 일부 API들이 변경되었습니다. 자세한 내용은 다음 링크에서 확인해주세요.

 오늘 하루 이 창을 열지 않음 [닫기]

판매자님의 상품에 [다운로드 쿠폰]과 [즉시할인 쿠폰]을 생성하여 적용할 수 있습니다. 쿠폰 사용 전에 WING에서 예산 설정을 해주시기바랍니다. WING > 프로모션관리 > 할인쿠폰 관리 메뉴를 선택한 후 [월별 예산 설정]

  • (공통)예산현황 조회 plus icon minus icon
  • 현재 설정된 모든 계약의 쿠폰 예산을 조회하기 위한 API입니다. 쿠폰의 사용을 위한 예산은 각각의 계약 조건에 따라 각 월별로 설정이 되기에 계약 및 조회를 원하는 월별로 조회가 가능합니다. Path GET /v2/providers/fms/apis/api/v1/vendors/{vendorId}/budgets Example Endpoint https:... 더보기
  • (공통)계약서 단건 조회 plus icon minus icon
  • 현재 설정된 계약 단건을 조회하기 위한 API입니다. Path GET /v2/providers/fms/apis/api/v2/vendors/{vendorId}/contract Example Endpoint https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00012345/co... 더보기
  • (공통)계약서 목록 조회 plus icon minus icon
  • 현재 설정된 모든 계약의 목록을 조회하기 위한 API로 자유계약기반(NON_CONTRACT_BASED)과 계약기반(CONTRACT_BASED) 타입 계약서 모두 조회 가능합니다. Path GET /v2/providers/fms/apis/api/v2/vendors/{vendorId}/contract/list Example Endpoint https:... 더보기
  • [즉시할인쿠폰] 생성 plus icon minus icon
  • 계약서ID(contractId)에 기반한 신규 쿠폰 생성을 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어 실제 API 수행 결과는 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다. Path POST /v2/providers/fms/apis/api/v2/ven... 더보기
  • [즉시할인쿠폰] 파기 plus icon minus icon
  • 생성되어 있던 쿠폰의 파기를 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어 실제 API 수행 결과값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다. 쿠폰 파기 시 쿠폰에 아직 끝나지 않은 다른 요청이 있을 경우 실패가 발생할 수 있습니다. 예를 들어 쿠폰... 더보기
  • [즉시할인쿠폰] 요청상태 확인 plus icon minus icon
  • requestedId를 통해 즉시할인 쿠폰 API의 요청 결과를 확인합니다. 쿠폰생성, 쿠폰파기, 쿠폰아이템 생성, 쿠폰아이템 파기 API 요청 시에 반환되는 requestedId 값을 가지고 성공/실패(DONE/FAIL) 결과를 확인할 때 사용합니다. Path GET /v2/providers/fms/apis/api/v1/vendors/{vendorI... 더보기
  • [즉시할인쿠폰] 아이템 생성 plus icon minus icon
  • 생성된 쿠폰을 개별 아이템에 적용하기 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어 실제 API 수행 결과 값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인합니다. Path POST /v2/providers/fms/apis/api/v1/vendors/{vendorI... 더보기
  • [즉시할인쿠폰] 아이템 파기 plus icon minus icon
  • 쿠폰에 적용되어 있던 옵션(아이템)의 적용 해제를 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어 실제 API 수행 결과 값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다. Path PUT /v2/providers/fms/apis/api/v1/vendors... 더보기
  • [즉시할인쿠폰] 단건 조회(couponId) plus icon minus icon
  • 단일 쿠폰 정보를 조회하기 위한 API입니다. 타 업체 쿠폰은 조회할 수 없습니다. Path GET /v2/providers/fms/apis/api/v2/vendors/{vendorId}/coupon Example Endpoint https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendo... 더보기
  • [즉시할인쿠폰] 단건 조회(couponItemId) plus icon minus icon
  • 현재 적용된 쿠폰아이템을 쿠폰아이템ID로 조회하기 위한 API입니다. Path GET /v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items/{couponItemId} Example Endpoint https://api-gateway.coupang.com/v2/provid... 더보기
  • [즉시할인쿠폰] 단건 조회(vendorItemId) plus icon minus icon
  • 현재 적용된 쿠폰아이템을 벤더아이템아이디로 조회하기 위한 API입니다. Path GET /v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items/{vendorItemId} Example Endpoint https://api-gateway.coupang.com/v2/provi... 더보기
  • [즉시할인쿠폰] 목록 조회(status) plus icon minus icon
  • 생성된 쿠폰을 쿠폰상태별로 조회하기 위한 API입니다. Path GET /v2/providers/fms/apis/api/v2/vendors/{vendorId}/coupons Example Endpoint https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00012345/co... 더보기
  • [즉시할인쿠폰] 목록 조회(orderId) plus icon minus icon
  • 주문번호로 쿠폰 정보를 조회하기 위한 API입니다. Path GET /v2/providers/fms/apis/api/v2/vendors/{vendorId}/{orderId}/coupons Example Endpoint https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A000... 더보기
  • [즉시할인쿠폰] 아이템 목록 조회(status) plus icon minus icon
  • 쿠폰이 적용된 옵션ID 리스트를 쿠폰상태로 조회하기 위한 API입니다. Path GET /v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items Example Endpoint https://api-gateway.coupang.com//v2/providers/fms/apis/... 더보기
  • [다운로드쿠폰] 생성 plus icon minus icon
  • 고객이 다운받아 사용할 수 있는 쿠폰을 생성합니다. 쿠폰이 붙은 상품의 총 주문액이 판매자가 설정한 일정금액을 충족해야 사용가능합니다. 쿠폰은 정률/정액할인으로 발급할 수 있으며, 동일 쿠폰에 최대 3개의 정책을 생성할 수 있습니다. (예: 10,000원 구매시 1천원 할인, 20,000원 구매시 3천원 할인, 30,000원 구매시 3천원 할인 ... 더보기
  • [다운로드쿠폰] 파기 plus icon minus icon
  • 생성된 다운로드 쿠폰을 파기(만료)합니다. 실제 API 수행 결과값은 응답으로 받은 "requestTransactionId"를 이용하여 '다운로드 쿠폰 요청상태 확인 API'를 조회하면 확인 가능합니다 Path POST /v2/providers/marketplace_openapi/apis/api/v1/coupons/expire Example End... 더보기
  • [다운로드쿠폰] 아이템 생성 plus icon minus icon
  • 옵션상품(vendorItemId)에 생성된 다운로드 쿠폰을 적용하기 위한 API입니다. 상품 추가에 실패하면 해당 쿠폰은 파기됩니다. Path PUT /v2/providers/marketplace_openapi/apis/api/v1/coupon-items Example Endpoint https://api-gateway.coupang.com/v2/... 더보기
  • [다운로드쿠폰] 요청상태 확인 plus icon minus icon
  • requestTransactionId 이용하여 쿠폰아이템 생성 API 요청 결과를 확인합니다. Path GET /v2/providers/marketplace_openapi/apis/api/v1/coupons/transactionStatus Example Endpoint https://api-gateway.coupang.com/v2/providers... 더보기
  • [다운로드쿠폰] 단건 조회(couponId) plus icon minus icon
  • couponId(쿠폰 생성 시 Response로 확인)를 이용하여 다운로드 쿠폰을 조회합니다. Path GET /v2/providers/marketplace_openapi/apis/api/v1/coupons/{couponId} Example Endpoint https://api-gateway.coupang.com/v2/providers/market... 더보기
  • [도서] 상품 캐시백 적용 plus icon minus icon
  • 옵션ID 별로 캐시백 룰을 적용합니다. 동일한 캐시백 룰을 사용하는 옵션에 적용할수 있으며 승인완료 이후의 옵션들에만 적용 가능합니다. * 캐쉬백 기능은 도서 상품 전용으로 쿠팡 영업 담당자와 계약서 작성 및 이용 관련 협의 후 사용 가능합니다. 각 캐시백 유형에 맞는 비즈니스 로직은 아래 테이블을 참조해 주십시오.: Value type Expl... 더보기
  • [도서] 상품 캐시백 검색 plus icon minus icon
  • 해당 옵션 ID 에 적용된 캐시백 룰 정보를 조회합니다. 캐시백이 적용되지 않은 옵션 ID(vendorItemId)를 조회 시 404 또는 400 에러가 발생합니다. Path GET /v2/providers/openapi/apis/api/v4/vendors/{vendorId}/products/items/cashback Example Endpoint h... 더보기
  • [도서] 상품 캐시백 삭제 plus icon minus icon
  • 옵션ID 에 적용된 캐시백 룰을 중지한다. Path DELETE /v2/providers/openapi/apis/api/v4/vendors/{vendorId}/products/items/cashback Example Endpoint https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/ve... 더보기