입점 신청하기내 파트너센터 바로가기
개발가이드

오픈 API 소개

주문 수집부터 발송·클레임 처리까지, 쓰던 시스템에서 그대로 자동화할 수 있어요.

뷰리티 오픈 API는 셀러의 주문·클레임·문의 데이터를 외부 시스템(OMS·ERP)에서 직접 다루기 위한 API예요. 파트너센터에 매번 로그인하지 않아도 주문을 자동으로 받아오고, 송장을 올리고, 취소·반품·교환을 처리할 수 있어요.

셀러가 파트너센터에서 API Key를 발급해 전달하면, 그 키 하나로 키를 발급한 셀러의 데이터만 조회하고 상태를 바꿔요.

연동하는 두 가지 방법

방법이런 경우에 좋아요
통합 솔루션에 키 등록셀메이트·이지어드민처럼 이미 쓰고 있는 통합 관리 솔루션이 있다면, 발급받은 키를 그 솔루션에 등록하기만 하면 돼요. 개발이 필요 없어요.
직접 연동 개발자체 OMS·ERP가 있다면 이 문서와 API 레퍼런스를 보고 직접 붙일 수 있어요. 개발 리소스가 필요해요.
키는 셀러가 발급해요
어느 방법이든 시작은 같아요. 셀러 대표 계정이 파트너센터에서 키를 발급해 연동 담당자에게 전달하면 돼요. 절차는 시작하기에서 안내해요.

1차 제공 범위

구분기능
조회주문 목록·상세, 취소/반품/교환 신청 목록·상세, 상품 문의 목록
주문 처리발주확인, 송장 등록(단건·일괄), 배송완료
클레임 처리승인, 거부, 수거 등록, 수거 완료, 검수 결과, 교환 재출고
문의 처리답변 등록

자동으로 처리되는 것

  • 환불 — 별도의 환불 실행 호출은 필요 없어요. 다만 환불이 시작되는 시점은 클레임 종류마다 달라요. 진행 상황은 클레임 상세의 status로 확인하면 돼요.
  • 구매확정 — 고객이 직접 하거나 배송완료 14일 후 자동으로 확정돼요. 조회로 관측만 해요.
타입환불이 시작되는 시점비고
취소
(cancel)
approve 승인 즉시수거·검수 단계가 없어요. 승인하면 곧바로 환불이 걸려요
반품
(return)
inspect 검수 통과 시(result=pass)approverequestedapproved까지만 옮겨요 — 환불도, 수거도 시작되지 않아요. 수거는 pickup(수거 송장 등록)을 따로 호출해야 시작되니 승인 뒤에는 반드시 pickup을 이어서 호출해 주세요. 수거완료 후 일정 기간 검수가 없으면 뷰리티가 검수 통과로 간주해 환불하기도 해요
교환
(exchange)
원칙적으로 환불이 없어요. 검수 통과 시 재출고(reshipping)로 가고, 돌려줄 차액이 있을 때만 그 시점에 차액 환불이 걸려요차액은 price_difference로 확인해요

자세한 내용은 클레임·문의 처리하기의 환불 진행 절에 있어요.

아직 제공하지 않는 것

  • 상품 등록·수정 — 2차에 제공할 예정이에요. 지금은 파트너센터에서 등록해 주세요.

문서 순서

  1. 시작하기키를 발급하고 개발 환경에서 상용까지 전환하는 절차를 확인해요.
  2. 공통 규약인증·응답 형식·오류 처리·호출 한도·재시도 규칙 — 모든 API에 공통으로 적용돼요.
  3. 주문 연동하기상태 흐름과 수집 방법, 발주확인부터 배송완료까지의 호출 순서를 다뤄요.
  4. 클레임·문의 처리하기취소·반품·교환의 상태 흐름과 처리 호출, 상품 문의 답변을 다뤄요.
  5. API 레퍼런스엔드포인트별 파라미터·응답 필드·오류 코드의 정본이에요.