coupang
GET/v2/providers/rg_open_api/apis/api/v1/vendors/{vendorId}/rg/orders2609170000

로켓그로스 주문 API(목록 쿼리)

KRTW
# 01

요약

로켓그로스 주문 API(목록 쿼리)

# 02

상세

API 적용 가능한 구매자 사용자 지역: 한국

로켓그로스 주문 API를 사용하면 프로그래밍 방식으로 주문 정보를 검색할 수 있습니다. 이 API를 사용하면 주문 동기화, 주문 조사, 수요 기반 의사 결정 지원 도구 등의 분야에서 빠르고 유연하며 맞춤형 애플리케이션을 개발할 수 있습니다. Order API는 [출고일] 이후의 주문을 지원합니다.

이 인터페이스는 분당 50회 호출로 제한됩니다.

경로

GET/v2/providers/rg_open_api/apis/api/v1/vendors/{vendorId}/rg/orders

예시 엔드포인트

https://api-gateway.coupang.com/v2/providers/rg_open_api/apis/api/v1/vendors/{vendorId}/rg/orders
# 03

Path 파라미터

NameTypeDescription
vendorId*string
vendorId
# 04

Query 파라미터

NameTypeDescription
paidDateFrom*string
검색 시작일시 yyyymmdd 형태로 조회하기 원하는 시작 날짜 기입 ex) 20240709
paidDateTo*string
검색 종료일시 yyyymmdd 형태로 조회하기 원하는 종료 날짜 기입 ex) 20240709 최대 30일까지 조회 가능합니다.
nextTokenstring
결과 문자열 목록은 다음 결과 페이지를 가져오는 데 사용됩니다. nextToken이 반환되면 nextToken 값이 다음 요청으로 전달됩니다. nextToken이 반환되지 않으면 더 이상 반환할 내용이 없습니다.
# 05

응답 본문

응답 메시지

NameTypeDescription
codeinteger
서버 응답 코드
messagestring
서버 응답 메세지
dataobject[]
결과리스트
결과가 없을 때는 빈 리스트가 리턴
orderId
data[].orderId
integer
주문번호
vendorId
data[].vendorId
string
판매자 ID
paidAt
data[].paidAt
integer
결제일시 (Time stamp)
orderItems
data[].orderItems
object[]
주문 정보 목록
vendorItemId
data[].orderItems[].vendorItemId
integer
옵션ID
productName
data[].orderItems[].productName
string
상품명
salesQuantity
data[].orderItems[].salesQuantity
integer
제품의 판매 수량
unitSalesPrice
data[].orderItems[].unitSalesPrice
string
제품의 단가 판매 가격
currency
data[].orderItems[].currency
string
판매 가격의 통화
nextTokenstring
다음 결과 페이지를 조회하는 데 사용하는 토큰

Response message sample

{
  "code": 200,
  "message": "SUCCESS",
  "data": [
    {
      "vendorId": "A00123456",
      "orderId": 70000000000,
      "paidAt": 1746093162000,
      "orderItems": [
        {
          "vendorItemId": 0,
          "productName": "Nike running shoe size 7",
          "salesQuantity": 1,
          "unitSalesPrice": "27800",
          "currency": "KRW"
        }
      ]
    },
    {
      "vendorId": "A00123456",
      "orderId": 70000000001,
      "paidAt": 1746093162000,
      "orderItems": [
        {
          "vendorItemId": 0,
          "productName": "Nike running shoe size 8",
          "salesQuantity": 2,
          "unitSalesPrice": "24900",
          "currency": "KRW"
        }
      ]
    }
  ],
  "nextToken": "17189443970001139254740404666368"
}
# 06

에러 코드

HTTP코드메시지
400HTTP_400Bad Request

오류 사양

HTTP유형오류 메시지해결 방법
400400 (요청변수확인)

요청에 매개변수가 누락되었거나 매개변수가 유효하지 않아 구문 분석할 수 없습니다.

해당 매개변수를 추가하세요.

400400 (요청변수확인)

다른 판매자의 주문을 조회할 수 없습니다.

입력하신 판매자 ID(vendorId)가 올바른지 확인하세요.