콘텐츠로 건너뛰기
ShopentlyLearn

데이터 스키마: 주문

데이터 스키마: 주문. API가 받거나 반환하는 데이터의 필드, 유형 및 제약 조건입니다.

데이터 스키마

배송 주소입니다

AddressData · 스키마 · 데이터 스키마: 주문
address_line_1문자열 null필수

주소의 첫 번째 행입니다.

address_line_2문자열 null필수

추가 주소 정보입니다.

city문자열 null필수

도시 또는 지역입니다.

country_code문자열 null필수

국가 코드입니다.

first_name문자열 null필수

이름입니다.

house_number문자열 null필수

건물 또는 주택 번호입니다.

last_name문자열 null필수

성입니다.

phone문자열 null필수

전화번호입니다.

postal_code문자열 null필수

우편번호입니다.

region문자열 null필수

행정 구역입니다.

street문자열 null필수

도로명입니다.

추가 필드: 아니요

목록 조회 — 주문 — 응답

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

응답 예제 · ApiResponse_list_OrderSummaryData__.

예제: [{"created_at":"2026-10-19T10:00:00Z","customer":{"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null},"delivery":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"},"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"id":"order-0000","lifecycle_state":"placed","locale":"pl","market_id":"market-pl","number":"0001","payment":{"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0},"prices_include_tax":true,"shipping_discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"status":{"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1},"subtotal":{"amount":"329.40","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2},"tax_country_code":"PL","total":{"amount":"329.40","currency":"PLN","minor_units":2}}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

조회 — 주문 — 응답

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

응답 예제 · OrderDetailData.

예제: {"created_at":"2026-10-19T10:00:00Z","customer":{"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null},"delivery":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}],"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"method_code":"shipping-old","method_name":"Historic carrier","net":{"amount":"0.00","currency":"PLN","minor_units":2},"original_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"original_net":{"amount":"20.00","currency":"PLN","minor_units":2},"original_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"pickup_point":null,"recipient_mode":"full_address","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23"},"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"version":3}],"id":"order-0000","invoice":null,"invoice_requested":false,"lifecycle_state":"placed","lines":[{"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":null,"version":3}],"identifiers":{},"image":null,"line_id":"saved-line-a","manual_discount":{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"},"name":"Saved A","original_total":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"200.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"46.00","currency":"PLN","minor_units":2},"position":1,"product_id":"product-api","quantity":2,"sku":"A","tax":{"amount":"20.70","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23","total":{"amount":"221.40","currency":"PLN","minor_units":2},"total_gross":{"amount":"221.40","currency":"PLN","minor_units":2},"total_net":{"amount":"180.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"41.40","currency":"PLN","minor_units":2},"unit_gross":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"23.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]},{"discount_amount":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_gross":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_net":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"0.00","currency":"PLN","minor_units":2},"discounts":[],"identifiers":{},"image":null,"line_id":"b548a171-c331-505f-98f8-db3a06070998","manual_discount":null,"name":"Saved B","original_total":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"position":2,"product_id":"deleted-product","quantity":1,"sku":"B","tax":null,"tax_category_id":"reduced","tax_category_name":"VAT 8%","tax_rate":"0.08","total":{"amount":"108.00","currency":"PLN","minor_units":2},"total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"unit_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]}],"locale":"pl","market_id":"market-pl","number":"0001","payment":{"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0},"pickup_point":null,"prices_include_tax":true,"shipping_address":null,"shipping_discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"status":{"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1},"subtotal":{"amount":"329.40","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2},"tax_breakdown":{"groups":[{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}],"unallocated_tax":{"amount":"0.00","currency":"PLN","minor_units":2}},"tax_country_code":"PL","total":{"amount":"329.40","currency":"PLN","minor_units":2},"totals":{"before_discounts":{"gross":{"amount":"378.60","currency":"PLN","minor_units":2},"net":{"amount":"320.00","currency":"PLN","minor_units":2},"tax":{"amount":"58.60","currency":"PLN","minor_units":2}},"discounts":{"gross":{"amount":"49.20","currency":"PLN","minor_units":2},"net":{"amount":"40.00","currency":"PLN","minor_units":2},"tax":{"amount":"9.20","currency":"PLN","minor_units":2}},"order":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"product_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"products":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"products_before_discounts":{"gross":{"amount":"354.00","currency":"PLN","minor_units":2},"net":{"amount":"300.00","currency":"PLN","minor_units":2},"tax":{"amount":"54.00","currency":"PLN","minor_units":2}},"shipping":{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"tax":{"amount":"0.00","currency":"PLN","minor_units":2}},"shipping_before_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"shipping_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}}}
metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

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

추가 필드: 아니요

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

CustomerData · 스키마 · 데이터 스키마: 주문
email문자열필수

이메일 주소입니다.

예제: "customer@example.invalid"
first_name문자열 null필수

이름입니다.

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

성입니다.

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

전화번호입니다.

예제: null

추가 필드: 아니요

발송일 및 예상 배송일

DeliveryDatesData · 주문 목록과 상세 정보에는 delivery.dates가 포함됩니다. YYYY-MM-DD 날짜는 예정이며 실제 발송을 확인하지 않습니다. 현재 날짜가 우선하며 이전 주문은 저장된 예상치를 사용합니다. 삭제되거나 알 수 없는 값은 null입니다. 상세 정보에는 모든 주문 항목과 상품 이미지도 포함됩니다.
dispatch_timezone문자열 null필수

발송 시간대 (IANA; null).

예제: "Europe/Warsaw"
estimated_delivery_from문자열 null필수

예상 배송 시작일 (YYYY-MM-DD; null).

문자열:format: "date"
예제: "2026-10-20"
estimated_delivery_to문자열 null필수

예상 배송 종료일 (YYYY-MM-DD; null).

문자열:format: "date"
예제: "2026-10-21"
planned_dispatch_on문자열 null필수

발송 예정일 (YYYY-MM-DD; null).

문자열:format: "date"
예제: "2026-10-19"

추가 필드: 아니요

DeliveryPickupPointData

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

배송 주소입니다.

code문자열필수

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

제약 조건
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData null필수

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

country_code문자열필수

국가 코드입니다.

제약 조건
pattern
"^[A-Z]{2}$"
environment문자열필수

레코드에 첨부된 환경 정보입니다.

제약 조건
enum
["live", "sandbox"]
kind문자열필수

허용 값으로 설명된 데이터 구조 유형입니다.

제약 조건
enum
["locker", "pickup_point"]
location_description문자열 null필수

선택한 언어의 설명입니다.

문자열:maxLength: 1000
name문자열필수

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

minLength: 1maxLength: 160
opening_hours문자열 null필수

Opening hours

문자열:maxLength: 500
operator문자열필수

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

minLength: 1maxLength: 63
verified_at문자열필수

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

format: "date-time"

추가 필드: 아니요

청구서 정보입니다

InvoiceData · 스키마 · 데이터 스키마: 주문
address_line_1문자열 null필수

주소의 첫 번째 행입니다.

address_line_2문자열 null필수

추가 주소 정보입니다.

city문자열 null필수

도시 또는 지역입니다.

company_name문자열 null필수

회사명입니다.

country_code문자열 null필수

국가 코드입니다.

house_number문자열 null필수

건물 또는 주택 번호입니다.

postal_code문자열 null필수

우편번호입니다.

region문자열 null필수

행정 구역입니다.

street문자열 null필수

도로명입니다.

tax_identifier문자열 null필수

납세자 식별 번호입니다.

tax_scheme문자열 null필수

세금 계산 방식입니다.

추가 필드: 아니요

세전 금액 / 세액 / 세금 포함 금액

OrderAmountBreakdownData · 금액과 세율은 항목 수정 사항을 포함한 저장된 주문에서 가져옵니다. 과거 데이터가 없으면 null이며 현재 카탈로그 세율로 채우지 않습니다. 금액은 십진수 문자열로 유지합니다.
grossMoneyData 필수

세금 포함 금액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData null필수

세전 금액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData null필수

세액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"58.60","currency":"PLN","minor_units":2}

추가 필드: 아니요

배송 · 할인

OrderDeliveryDiscountData · 금액과 세율은 항목 수정 사항을 포함한 저장된 주문에서 가져옵니다. 과거 데이터가 없으면 null이며 현재 카탈로그 세율로 채우지 않습니다. 금액은 십진수 문자열로 유지합니다.
amountMoneyData 필수

세금 포함 금액 · 배송 · 할인.

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_id문자열필수

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

예제: "saved-coupon"
code문자열 null필수

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

예제: "SAVE"
kind문자열필수

허용 값으로 설명된 데이터 구조 유형입니다.

제약 조건
enum
["coupon", "promotion"]
예제: "coupon"
name문자열필수

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

예제: "Saved coupon"
sequence정수 null필수

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

예제: 1
version정수필수

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

예제: 3

추가 필드: 아니요

조회 — 주문 — 응답

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

생성 시각입니다.

format: "date-time"
예제: "2026-10-19T10:00:00Z"
customerCustomerData 필수

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

예제: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData 필수

배송 방법과 관련 정보입니다.

예제: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}],"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"method_code":"shipping-old","method_name":"Historic carrier","net":{"amount":"0.00","currency":"PLN","minor_units":2},"original_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"original_net":{"amount":"20.00","currency":"PLN","minor_units":2},"original_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"pickup_point":null,"recipient_mode":"full_address","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23"}
discount_amountMoneyData 필수

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

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
discounts배열 <OrderDiscountData > 필수

할인

예제: [{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"version":3}]
id문자열필수

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

예제: "order-0000"
invoiceInvoiceData null필수

청구서 정보입니다.

예제: null
invoice_requested불리언필수

청구서를 요청했는지 나타냅니다.

예제: false
lifecycle_stateOrderLifecycleState 필수

업무 수명 주기 상태입니다.

예제: "placed"
lines배열 <OrderLineData > 필수

주문 항목의 스냅샷입니다.

예제: [{"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":null,"version":3}],"identifiers":{},"image":null,"line_id":"saved-line-a","manual_discount":{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"},"name":"Saved A","original_total":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"200.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"46.00","currency":"PLN","minor_units":2},"position":1,"product_id":"product-api","quantity":2,"sku":"A","tax":{"amount":"20.70","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23","total":{"amount":"221.40","currency":"PLN","minor_units":2},"total_gross":{"amount":"221.40","currency":"PLN","minor_units":2},"total_net":{"amount":"180.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"41.40","currency":"PLN","minor_units":2},"unit_gross":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"23.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]},{"discount_amount":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_gross":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_net":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"0.00","currency":"PLN","minor_units":2},"discounts":[],"identifiers":{},"image":null,"line_id":"b548a171-c331-505f-98f8-db3a06070998","manual_discount":null,"name":"Saved B","original_total":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"position":2,"product_id":"deleted-product","quantity":1,"sku":"B","tax":null,"tax_category_id":"reduced","tax_category_name":"VAT 8%","tax_rate":"0.08","total":{"amount":"108.00","currency":"PLN","minor_units":2},"total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"unit_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]}]
locale문자열필수

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

예제: "pl"
market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

예제: "market-pl"
number문자열필수

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

예제: "0001"
paymentPaymentData 필수

주문에 기록된 결제 상세 정보입니다.

예제: {"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0}
pickup_pointPickupPointData null필수

수령 장소

예제: null
prices_include_tax불리언필수

표시 가격에 세금이 포함되는지 나타냅니다.

예제: true
shipping_addressAddressData null필수

배송 주소입니다.

예제: null
shipping_discount_amountMoneyData 필수

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

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData 필수

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

예제: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData 필수

응답에 표시된 추가 구성 요소를 반영하기 전 금액입니다.

예제: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData 필수

세금 정보입니다.

예제: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData 필수

세금 그룹 · source + tax_rate; unallocated_tax.

예제: {"groups":[{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}],"unallocated_tax":{"amount":"0.00","currency":"PLN","minor_units":2}}
tax_country_code문자열 null필수

과세 국가 · 저장된 주문 데이터 · ISO 3166-1 alpha-2; null.

예제: "PL"
totalMoneyData 필수

총금액입니다.

예제: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData 필수

합계 · net / tax / gross; 할인 전 / 할인 후.

예제: {"before_discounts":{"gross":{"amount":"378.60","currency":"PLN","minor_units":2},"net":{"amount":"320.00","currency":"PLN","minor_units":2},"tax":{"amount":"58.60","currency":"PLN","minor_units":2}},"discounts":{"gross":{"amount":"49.20","currency":"PLN","minor_units":2},"net":{"amount":"40.00","currency":"PLN","minor_units":2},"tax":{"amount":"9.20","currency":"PLN","minor_units":2}},"order":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"product_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"products":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"products_before_discounts":{"gross":{"amount":"354.00","currency":"PLN","minor_units":2},"net":{"amount":"300.00","currency":"PLN","minor_units":2},"tax":{"amount":"54.00","currency":"PLN","minor_units":2}},"shipping":{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"tax":{"amount":"0.00","currency":"PLN","minor_units":2}},"shipping_before_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"shipping_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}}

추가 필드: 아니요

이미지 메타데이터와 URL입니다

OrderImageData · 스키마 · 데이터 스키마: 주문
alt문자열 null필수

이미지 대체 텍스트입니다.

source문자열선택 사항

기록된 활동의 출처입니다.

const: "current_catalog"
기본값: "current_catalog"
url문자열필수

리소스 URL입니다.

추가 필드: 아니요

업무 수명 주기 상태입니다

OrderLifecycleState · 스키마 · 데이터 스키마: 주문
문자열
제약 조건
enum
["placed", "cancelled", "fulfilled", "returned"]

추가 필드: 예

주문 항목의 스냅샷입니다

OrderLineData · 스키마 · 데이터 스키마: 주문
discount_amountMoneyData 필수

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

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData 필수

세금 포함 금액 · 할인; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData null필수

세전 금액 · 할인; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData null필수

세액 · 할인; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"4.60","currency":"PLN","minor_units":2}
discounts배열 <OrderDiscountData > 필수

할인 · net / tax / gross.

예제: [{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":null,"version":3}]
identifiers객체추가 필드: 문자열필수

상품 식별 코드입니다.

예제: {}
imageOrderImageData null필수

이미지 메타데이터와 URL입니다.

예제: null
line_id문자열필수

주문 항목의 고정 식별자.

예제: "saved-line-a"
manual_discountOrderManualDiscountData null필수

수동 할인; null.

예제: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
name문자열필수

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

예제: "Saved A"
original_totalMoneyData 필수

총금액입니다.

예제: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData 필수

세금 포함 금액 · 상품 · 할인 전; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData null필수

세전 금액 · 상품 · 할인 전; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData null필수

세액 · 상품 · 할인 전; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"46.00","currency":"PLN","minor_units":2}
position정수필수

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

예제: 1
product_id문자열필수

상품 식별자입니다.

예제: "product-api"
quantity정수필수

단위 수량입니다.

예제: 2
sku문자열필수

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

예제: "A"
taxMoneyData null필수

세액 · 한 단위 · 저장된 주문 데이터; tax ≠ unit_tax; 알 수 없음: null; 확인된 0: 0.

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

세금 범주 식별자 · 저장된 주문 데이터; null.

예제: "standard"
tax_category_name문자열 null필수

저장된 세금 범주 이름; null.

예제: "VAT 23%"
tax_rate문자열 null필수

tax_rate · 저장된 주문 데이터: "0.23" = 23%; "0" ≠ null.

예제: "0.23"
totalMoneyData 필수

총금액입니다.

예제: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData 필수

세금 포함 금액 · 상품 · 할인 후; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData null필수

세전 금액 · 상품 · 할인 후; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData null필수

세액 · 상품 · 할인 후 · 저장된 주문 데이터; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData 필수

세금 포함 금액 · 한 단위 · 할인 전; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData null필수

세전 금액 · 한 단위 · 할인 전; 알 수 없음: null; 확인된 0: 0.

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

한 단위의 가격입니다.

예제: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData null필수

세액 · 한 단위 · 할인 전; 알 수 없음: null; 확인된 0: 0.

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

옵션 상품 식별자입니다.

예제: null
variant_options배열 <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > 필수

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

예제: []

추가 필드: 아니요

수동 할인

OrderManualDiscountData · 금액과 세율은 항목 수정 사항을 포함한 저장된 주문에서 가져옵니다. 과거 데이터가 없으면 null이며 현재 카탈로그 세율로 채우지 않습니다. 금액은 십진수 문자열로 유지합니다.
amountMoneyData 필수

세금 포함 금액 · 수동 할인 · 저장된 주문 데이터.

예제: {"amount":"12.30","currency":"PLN","minor_units":2}
kind문자열필수

할인 유형: percentage / fixed.

제약 조건
enum
["percentage", "fixed"]
예제: "fixed"
value문자열필수

설정값: percentage "10" = 10%; fixed = 세금 포함 금액.

예제: "12.30"

추가 필드: 아니요

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

OrderPaymentStatus · 스키마 · 데이터 스키마: 주문
문자열
제약 조건
enum
["unpaid", "paid", "failed", "refunded"]

추가 필드: 예

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

OrderStatusData · 스키마 · 데이터 스키마: 주문
id문자열필수

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

예제: "status-0"
name문자열필수

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

예제: "Status 0"
updated_at문자열필수

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

format: "date-time"
예제: "2026-10-19T10:00:00Z"
version정수필수

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

예제: 1

추가 필드: 아니요

목록 조회 · 상태 목록 — 주문 — 응답

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

생성 시각입니다.

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

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

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

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

예제: false
name문자열필수

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

예제: "Example"
position정수필수

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

예제: 1

추가 필드: 아니요

목록 조회 · 상태 목록 — 주문 — 응답

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

응답 예제 · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

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

응답 메타데이터입니다.

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

추가 필드: 아니요

수정 · 상태 — 주문 — 요청 본문

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

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

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

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

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

추가 필드: 아니요

목록 조회 — 주문 — 응답

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

생성 시각입니다.

format: "date-time"
예제: "2026-10-19T10:00:00Z"
customerCustomerData 필수

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

예제: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData 필수

배송 방법과 관련 정보입니다.

예제: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"}
discount_amountMoneyData 필수

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

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
id문자열필수

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

예제: "order-0000"
lifecycle_stateOrderLifecycleState 필수

업무 수명 주기 상태입니다.

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

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

예제: "pl"
market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

예제: "market-pl"
number문자열필수

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

예제: "0001"
paymentPaymentData 필수

주문에 기록된 결제 상세 정보입니다.

예제: {"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0}
prices_include_tax불리언필수

표시 가격에 세금이 포함되는지 나타냅니다.

예제: true
shipping_discount_amountMoneyData 필수

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

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData 필수

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

예제: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData 필수

응답에 표시된 추가 구성 요소를 반영하기 전 금액입니다.

예제: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData 필수

세금 정보입니다.

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

과세 국가 · 저장된 주문 데이터 · ISO 3166-1 alpha-2; null.

예제: "PL"
totalMoneyData 필수

총금액입니다.

예제: {"amount":"329.40","currency":"PLN","minor_units":2}

추가 필드: 아니요

주문 · 세금 그룹

OrderTaxBreakdownData · 금액과 세율은 항목 수정 사항을 포함한 저장된 주문에서 가져옵니다. 과거 데이터가 없으면 null이며 현재 카탈로그 세율로 채우지 않습니다. 금액은 십진수 문자열로 유지합니다.
groups배열 <OrderTaxGroupData > 필수

세금 그룹 · source + tax_rate; 알 수 없음: null; 확인된 0: 0.

예제: [{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}]
unallocated_taxMoneyData 필수

미배분 세액 = order.tax − Σ groups.tax; ±.

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

추가 필드: 아니요

세금 그룹

OrderTaxGroupData · 금액과 세율은 항목 수정 사항을 포함한 저장된 주문에서 가져옵니다. 과거 데이터가 없으면 null이며 현재 카탈로그 세율로 채우지 않습니다. 금액은 십진수 문자열로 유지합니다.
grossMoneyData 필수

세금 포함 금액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData null필수

세전 금액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"180.00","currency":"PLN","minor_units":2}
source문자열필수

출처: products (상품), shipping (배송).

제약 조건
enum
["products", "shipping"]
예제: "products"
taxMoneyData null필수

세액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

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

tax_rate · 저장된 주문 데이터: "0.23" = 23%; "0" ≠ null.

예제: "0.23"

추가 필드: 아니요

주문 · 합계

OrderTotalsData · 금액과 세율은 항목 수정 사항을 포함한 저장된 주문에서 가져옵니다. 과거 데이터가 없으면 null이며 현재 카탈로그 세율로 채우지 않습니다. 금액은 십진수 문자열로 유지합니다.
before_discountsOrderAmountBreakdownData 필수

주문 · 할인 전 · net / tax / gross.

예제: {"gross":{"amount":"378.60","currency":"PLN","minor_units":2},"net":{"amount":"320.00","currency":"PLN","minor_units":2},"tax":{"amount":"58.60","currency":"PLN","minor_units":2}}
discountsOrderAmountBreakdownData 필수

할인 · net / tax / gross.

예제: {"gross":{"amount":"49.20","currency":"PLN","minor_units":2},"net":{"amount":"40.00","currency":"PLN","minor_units":2},"tax":{"amount":"9.20","currency":"PLN","minor_units":2}}
orderOrderAmountBreakdownData 필수

주문 · 할인 후 · net / tax / gross.

예제: {"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}}
product_discountsOrderAmountBreakdownData 필수

상품 · 할인 · net / tax / gross.

예제: {"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}
productsOrderAmountBreakdownData 필수

상품 · 할인 후 · net / tax / gross.

예제: {"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}}
products_before_discountsOrderAmountBreakdownData 필수

상품 · 할인 전 · net / tax / gross.

예제: {"gross":{"amount":"354.00","currency":"PLN","minor_units":2},"net":{"amount":"300.00","currency":"PLN","minor_units":2},"tax":{"amount":"54.00","currency":"PLN","minor_units":2}}
shippingOrderAmountBreakdownData 필수

배송 · 할인 후 · net / tax / gross.

예제: {"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"tax":{"amount":"0.00","currency":"PLN","minor_units":2}}
shipping_before_discountsOrderAmountBreakdownData 필수

배송 · 할인 전 · net / tax / gross.

예제: {"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}
shipping_discountsOrderAmountBreakdownData 필수

배송 · 할인 · net / tax / gross.

예제: {"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}

추가 필드: 아니요

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

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · 스키마 · 데이터 스키마: 주문
name문자열필수

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

value문자열필수

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

추가 필드: 아니요

OrderDiscountData

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

세금 포함 금액 · 상품 · 할인.

예제: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_id문자열필수

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

예제: "saved-coupon"
code문자열 null필수

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

예제: "SAVE"
kind문자열필수

허용 값으로 설명된 데이터 구조 유형입니다.

제약 조건
enum
["coupon", "promotion"]
예제: "coupon"
name문자열필수

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

예제: "Saved coupon"
sequence정수 null선택 사항

적용 순서; null.

예제: 1
shipping_amountMoneyData null선택 사항

세금 포함 금액 · 배송 · 할인; null.

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
version정수필수

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

예제: 3

추가 필드: 아니요

주문에 기록된 결제 상세 정보입니다

PaymentData · 스키마 · 데이터 스키마: 주문
amountMoneyData 필수

payment.amount는 주문 총액입니다. 결제 상태로 결제액, 환불액 또는 미결제액을 확정할 수 없습니다.

예제: {"amount":"329.40","currency":"PLN","minor_units":2}
environment문자열필수

레코드에 첨부된 환경 정보입니다.

제약 조건
enum
["live", "sandbox"]
예제: "live"
method_code문자열 null필수

배송 또는 결제 방법 코드입니다.

예제: "payment-old"
method_name문자열 null필수

배송 또는 결제 방법 이름입니다.

예제: "Historic method"
paid_at문자열 null필수

결제가 완료로 표시된 날짜와 시각입니다.

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

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

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

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

format: "date-time"
예제: "2026-10-19T10:00:00Z"
version정수필수

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

예제: 0

추가 필드: 아니요

수정 · 결제 상태 — 주문 — 요청 본문

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

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

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

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

minLength: 1maxLength: 500
예제: "Example"
statusPaymentStatus 필수

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

예제: "paid"

추가 필드: 아니요

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

PaymentStatus · 스키마 · 데이터 스키마: 주문
문자열
제약 조건
enum
["unpaid", "paid", "failed", "refunded"]

추가 필드: 예

PickupPointAddressData

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

주소의 첫 번째 행입니다.

minLength: 1maxLength: 240
city문자열필수

도시 또는 지역입니다.

minLength: 1maxLength: 160
postal_code문자열필수

우편번호입니다.

minLength: 1maxLength: 32

추가 필드: 아니요

PickupPointCoordinatesData

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

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitude숫자필수

WGS84 λ (°)

minimum: -180.0maximum: 180.0

추가 필드: 아니요

PickupPointData

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

주소의 첫 번째 행입니다.

city문자열필수

도시 또는 지역입니다.

code문자열필수

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

country_code문자열필수

국가 코드입니다.

kind문자열필수

허용 값으로 설명된 데이터 구조 유형입니다.

제약 조건
enum
["locker", "pickup_point"]
latitude숫자 null필수

WGS84 φ (°)

location_description문자열 null필수

선택한 언어의 설명입니다.

longitude숫자 null필수

WGS84 λ (°)

name문자열필수

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

opening_hours문자열 null필수

Opening hours

operator문자열필수

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

postal_code문자열필수

우편번호입니다.

추가 필드: 아니요

PickupPointSummaryData

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

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

제약 조건
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_code문자열필수

국가 코드입니다.

제약 조건
pattern
"^[A-Z]{2}$"
environment문자열필수

레코드에 첨부된 환경 정보입니다.

제약 조건
enum
["live", "sandbox"]
kind문자열필수

허용 값으로 설명된 데이터 구조 유형입니다.

제약 조건
enum
["locker", "pickup_point"]
operator문자열필수

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

minLength: 1maxLength: 63

추가 필드: 아니요

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

RequestCustomerData · 스키마 · 데이터 스키마: 주문
email문자열필수

이메일 주소입니다.

예제: "customer@example.invalid"
name문자열필수

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

예제: "Example"

추가 필드: 아니요

배송 방법과 관련 정보입니다

ShippingData · 스키마 · 데이터 스키마: 주문
amountMoneyData 필수

주문에 MoneyData로 기록된 세금 포함 배송 금액입니다. 이후 세금이 변경되어도 이 과거 금액은 변경되지 않습니다.

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

발송일 및 예상 배송일. 주문 목록과 상세 정보에는 delivery.dates가 포함됩니다. YYYY-MM-DD 날짜는 예정이며 실제 발송을 확인하지 않습니다. 현재 날짜가 우선하며 이전 주문은 저장된 예상치를 사용합니다. 삭제되거나 알 수 없는 값은 null입니다. 상세 정보에는 모든 주문 항목과 상품 이미지도 포함됩니다.

예제: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_code문자열 null필수

배송 또는 결제 방법 코드입니다.

예제: "shipping-old"
method_name문자열 null필수

배송 또는 결제 방법 이름입니다.

예제: "Historic carrier"
pickup_pointPickupPointSummaryData null필수

수령 장소

예제: null
recipient_mode문자열필수

허용 값으로 설명된 데이터 구조 유형입니다.

제약 조건
enum
["full_address", "pickup_contact"]
예제: "full_address"

추가 필드: 아니요

ShippingDetailData

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

주문에 MoneyData로 기록된 세금 포함 배송 금액입니다. 이후 세금이 변경되어도 이 과거 금액은 변경되지 않습니다.

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

발송일 및 예상 배송일. 주문 목록과 상세 정보에는 delivery.dates가 포함됩니다. YYYY-MM-DD 날짜는 예정이며 실제 발송을 확인하지 않습니다. 현재 날짜가 우선하며 이전 주문은 저장된 예상치를 사용합니다. 삭제되거나 알 수 없는 값은 null입니다. 상세 정보에는 모든 주문 항목과 상품 이미지도 포함됩니다.

예제: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
discount_grossMoneyData 필수

세금 포함 금액 · 할인; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData null필수

세전 금액 · 할인; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData null필수

세액 · 할인; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"4.60","currency":"PLN","minor_units":2}
discounts배열 <OrderDeliveryDiscountData > null필수

배송 · 할인; []: 0; null: 알 수 없음: null; 확인된 0: 0.

예제: [{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}]
grossMoneyData 필수

세금 포함 금액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

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

배송 또는 결제 방법 코드입니다.

예제: "shipping-old"
method_name문자열 null필수

배송 또는 결제 방법 이름입니다.

예제: "Historic carrier"
netMoneyData null필수

세전 금액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

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

세금 포함 금액 · 배송 · 할인 전; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData null필수

세전 금액 · 배송 · 할인 전; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData null필수

세액 · 배송 · 할인 전; 알 수 없음: null; 확인된 0: 0.

예제: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData null필수

수령 장소

예제: null
recipient_mode문자열필수

허용 값으로 설명된 데이터 구조 유형입니다.

제약 조건
enum
["full_address", "pickup_contact"]
예제: "full_address"
taxMoneyData null필수

세액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

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

세금 범주 식별자 · 저장된 주문 데이터; null.

예제: "standard"
tax_category_name문자열 null필수

저장된 세금 범주 이름; null.

예제: "VAT 23%"
tax_rate문자열 null필수

tax_rate · 저장된 주문 데이터: "0.23" = 23%; "0" ≠ null.

예제: "0.23"

추가 필드: 아니요