콘텐츠로 건너뛰기
ShopentlyLearn
한국어

데이터 스키마: 반품, 불만 접수, 교환

데이터 스키마: 반품, 불만 접수, 교환. API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

데이터 스키마

목록 조회 — 반품, 불만 접수, 교환 — 응답

ApiResponse_list_RequestSummaryData__ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
data배열 <RequestSummaryData > 필수

응답 예제 · ApiResponse_list_RequestSummaryData__.

예제: [{"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

예제: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

추가 필드: 아니요

조회 — 반품, 불만 접수, 교환 — 응답

ApiResponse_RequestDetailData_ · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
dataRequestDetailData 필수

응답 예제 · RequestDetailData.

예제: {"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","items":[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}],"number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

예제: {"request_id":"example"}

추가 필드: 아니요

수정 · 환불 금액 — 반품, 불만 접수, 교환 — 요청 본문

RefundAmountUpdate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
amount문자열필수

JSON 문자열로 인코딩한 십진수 금액입니다. null 은 허용된 경우에만 사용합니다.

minLength: 1maxLength: 64
제약 조건
pattern
"^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$"
예제: "0.00"
expected_version정수필수

쓰기 전에 읽은 버전이며 일치하지 않으면 업데이트가 거부됩니다.

minimum: 0maximum: 9223372036854775807
예제: 1
reason문자열선택 사항

변경에 기록된 사유입니다.

maxLength: 500
기본값: ""

추가 필드: 아니요

기록된 환불 정보입니다

RefundData · 스키마 · 데이터 스키마: 반품, 불만 접수, 교환
amountMoneyData null필수

JSON 문자열로 인코딩한 십진수 금액입니다. null 은 허용된 경우에만 사용합니다.

예제: {"amount":"0.00","currency":"PLN","minor_units":2}
completed_at문자열 null필수

완료 시각입니다.

문자열:format: "date-time"
예제: null
status문자열필수

이 작업에서 허용하는 상태입니다.

제약 조건
enum
["pending", "completed"]
예제: "pending"
updated_at문자열 null필수

가장 최근 업데이트 시각입니다.

문자열:format: "date-time"
예제: "2026-01-01T12:00:00Z"
version정수필수

동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

조회 — 반품, 불만 접수, 교환 — 응답

RequestDetailData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
created_at문자열필수

생성 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
customerRequestCustomerData 필수

이 리소스에 기록된 고객 정보입니다.

예제: {"email":"customer@example.invalid","name":"Example"}
id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (RequestDetailData).

예제: "example"
items배열 <RequestItemData > 필수

리소스에 포함된 항목입니다.

예제: [{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}]
number문자열필수

사용자에게 표시하는 주문 또는 요청 번호입니다.

예제: "example"
order_id문자열필수

관련 주문 식별자입니다.

예제: "example"
order_number문자열필수

관련 주문 번호입니다.

예제: "example"
products_valueMoneyData 필수

주문에 포함된 상품 금액입니다.

예제: {"amount":"0.00","currency":"PLN","minor_units":2}
refundRefundData 필수

기록된 환불 정보입니다.

예제: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}
resolution_state문자열필수

고객 요청의 해결 상태입니다.

제약 조건
enum
["unknown", "open", "completed", "rejected", "cancelled"]
예제: "unknown"
statusRequestStatusData 필수

이 작업에서 허용하는 상태입니다.

예제: {"id":"example","locale":"en","name":"Example"}
typeRequestType 필수

리소스 유형입니다.

예제: "return"
updated_at문자열필수

가장 최근 업데이트 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
version정수필수

동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

조회 — 반품, 불만 접수, 교환 — 응답

RequestItemData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (RequestItemData).

예제: "example"
name문자열필수

해당 컨텍스트의 리소스 이름입니다.

예제: "Example"
order_line_id문자열 null필수

관련 주문 항목 식별자입니다.

예제: "example"
product_id문자열필수

상품 식별자입니다.

예제: "example"
quantity정수필수

단위 수량입니다.

예제: 1
returned_quantity정수필수

이 항목에서 반품한 수량입니다.

예제: 1
sku문자열필수

재고 관리 단위 코드입니다.

예제: "example"
totalMoneyData 필수

총금액입니다.

예제: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData 필수

한 단위의 가격입니다.

예제: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_id문자열 null필수

옵션 상품 식별자입니다.

예제: "example"
variant_options배열 <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > 필수

상품 또는 스냅샷과 연결된 옵션입니다.

예제: [{"name":"Example","value":"example"}]

추가 필드: 아니요

이 작업에서 허용하는 상태입니다

RequestStatusData · 스키마 · 데이터 스키마: 반품, 불만 접수, 교환
id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (RequestStatusData).

예제: "example"
locale문자열필수

이 요청에서 선택한 언어입니다.

예제: "en"
name문자열 null필수

해당 컨텍스트의 리소스 이름입니다.

예제: "Example"

추가 필드: 아니요

목록 조회 · 상태 목록 — 반품, 불만 접수, 교환 — 응답

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
code문자열필수

안정적인 기계 판독용 코드입니다.

예제: "example"
created_at문자열필수

생성 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

예제: "example"
is_initial불리언필수

초기 상태인지 나타냅니다.

예제: false
locale문자열필수

이 요청에서 선택한 언어입니다.

예제: "en"
name문자열 null필수

해당 컨텍스트의 리소스 이름입니다.

예제: "Example"
position정수필수

정렬된 컬렉션에서의 위치입니다.

예제: 1
typeRequestType 필수

리소스 유형입니다.

예제: "return"

추가 필드: 아니요

목록 조회 · 상태 목록 — 반품, 불만 접수, 교환 — 응답

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
data배열 <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > 필수

응답 예제 · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

예제: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"locale":"en","name":"Example","position":1,"type":"return"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

예제: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

추가 필드: 아니요

수정 · 상태 — 반품, 불만 접수, 교환 — 요청 본문

RequestStatusUpdate · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
expected_version정수필수

쓰기 전에 읽은 버전이며 일치하지 않으면 업데이트가 거부됩니다.

minimum: 1maximum: 9223372036854775807
예제: 1
status_id문자열필수

해당 상태 사전에서 얻은 식별자입니다.

제약 조건
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
예제: "example"

추가 필드: 아니요

목록 조회 — 반품, 불만 접수, 교환 — 응답

RequestSummaryData · API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.
created_at문자열필수

생성 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
customerRequestCustomerData 필수

이 리소스에 기록된 고객 정보입니다.

예제: {"email":"customer@example.invalid","name":"Example"}
id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (RequestSummaryData).

예제: "example"
number문자열필수

사용자에게 표시하는 주문 또는 요청 번호입니다.

예제: "example"
order_id문자열필수

관련 주문 식별자입니다.

예제: "example"
order_number문자열필수

관련 주문 번호입니다.

예제: "example"
products_valueMoneyData 필수

주문에 포함된 상품 금액입니다.

예제: {"amount":"0.00","currency":"PLN","minor_units":2}
refundRefundData 필수

기록된 환불 정보입니다.

예제: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}
resolution_state문자열필수

고객 요청의 해결 상태입니다.

제약 조건
enum
["unknown", "open", "completed", "rejected", "cancelled"]
예제: "unknown"
statusRequestStatusData 필수

이 작업에서 허용하는 상태입니다.

예제: {"id":"example","locale":"en","name":"Example"}
typeRequestType 필수

리소스 유형입니다.

예제: "return"
updated_at문자열필수

가장 최근 업데이트 시각입니다.

format: "date-time"
예제: "2026-01-01T12:00:00Z"
version정수필수

동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

리소스 유형입니다

RequestType · 스키마 · 데이터 스키마: 반품, 불만 접수, 교환 문자열
제약 조건
enum
["return", "exchange", "complaint"]

추가 필드: 예

상품 또는 스냅샷과 연결된 옵션입니다

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · 스키마 · 데이터 스키마: 반품, 불만 접수, 교환
name문자열필수

해당 컨텍스트의 리소스 이름입니다.

예제: "Example"
value문자열필수

주변 스키마에서 설명하는 값입니다.

예제: "example"

추가 필드: 아니요