コンテンツにスキップ
ShopentlyLearn
日本語

データスキーマ: 注文

データスキーマ: 注文. API が受け取る、または返すデータのフィールド、型、制約。

データスキーマ

配送先住所

AddressData · スキーマ · データスキーマ: 注文
address_line_1文字列 null必須

住所の1行目。

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_OrderFileListData_

ApiResponse_OrderFileListData_ · API が受け取る、または返すデータのフィールド、型、制約。 upload_idを作成した後、multipart/form-dataでファイルを送信し、商品に関連付けます。ダウンロードにはBearerトークンとcategoryの権限が必要です。応答はファイルのバイト列で、公開URLやパスワードは使いません。mode=periodではdays（1～3650）または従来のmonthsのどちらか一方を指定します。条件は購入時に保存され、返金された明細のみアクセスが取り消されます。
dataOrderFileListData 必須

成功レスポンスのデータ。

例: {"files":[{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}],"updates_pending":false}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必須

レスポンスのメタデータ。

例: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

追加フィールド: いいえ

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · API が受け取る、または返すデータのフィールド、型、制約。 upload_idを作成した後、multipart/form-dataでファイルを送信し、商品に関連付けます。ダウンロードにはBearerトークンとcategoryの権限が必要です。応答はファイルのバイト列で、公開URLやパスワードは使いません。mode=periodではdays（1～3650）または従来のmonthsのどちらか一方を指定します。条件は購入時に保存され、返金された明細のみアクセスが取り消されます。
dataOrderReleaseListData 必須

成功レスポンスのデータ。

例: {"releases":[{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}],"updates_pending":false}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必須

レスポンスのメタデータ。

例: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

追加フィールド: いいえ

一覧取得 — 注文 — レスポンス

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"}

追加フィールド: いいえ

CurrentReleaseData

CurrentReleaseData · API が受け取る、または返すデータのフィールド、型、制約。 upload_idを作成した後、multipart/form-dataでファイルを送信し、商品に関連付けます。ダウンロードにはBearerトークンとcategoryの権限が必要です。応答はファイルのバイト列で、公開URLやパスワードは使いません。mode=periodではdays（1～3650）または従来のmonthsのどちらか一方を指定します。条件は購入時に保存され、返金された明細のみアクセスが取り消されます。
acquired真偽値必須

購入後のアクセス (true / false)

changelog文字列必須

変更内容

covered_by_purchase真偽値必須

購入後のアクセス (true / false)

id文字列必須

リソース識別子。返された値をそのまま保持してください。

published_at文字列必須

リリースを公開 · UTC

format: "date-time"
requires_new_purchase真偽値必須

購入後に追加されたファイルへのアクセス不可 · requires_new_purchase

sequence整数必須

順序付きコレクション内の位置。

version_label文字列必須

バージョン

追加フィールド: いいえ

このリソースに記録された顧客情報

CustomerData · スキーマ · データスキーマ: 注文
email文字列必須

メールアドレス。

例: "customer@example.invalid"
first_name文字列 null必須

名。

例: "Example"
last_name文字列 null必須

姓。

例: "Example"
phone文字列 null必須

電話番号。

例: null

追加フィールド: いいえ

DeliveryContentDeletion

DeliveryContentDeletion · 履歴を残して内容を完全に削除します。コードは販売可能な在庫に戻りません。
expected_version整数必須

書き込み前に取得したバージョン。不一致の場合は更新を拒否します。

minimum: 1
例: 1
reason文字列必須

変更の記録理由。

minLength: 1maxLength: 500
例: "Withdraw a revoked license"

追加フィールド: いいえ

発送日と配送予定日

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"

追加フィールド: いいえ

DeliveryReplacement

DeliveryReplacement · 既存の未使用在庫を選んで置き換えます。保管期限は最初から数え直されません。
expected_unit_version整数必須

未使用の置き換え在庫の現在のバージョン。

minimum: 1
例: 1
expected_version整数必須

書き込み前に取得したバージョン。不一致の場合は更新を拒否します。

minimum: 1
例: 1
reason文字列必須

変更の記録理由。

minLength: 1maxLength: 500
例: "Replace an invalid activation code"
replacement_unit_id文字列必須

置き換え用の既存未使用在庫のID。

format: "uuid"
例: "00000000-0000-4000-8000-000000000008"

追加フィールド: いいえ

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"

追加フィールド: いいえ

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · コードを表示せずに割り当て済みの在庫を取得します。返金時は対象の注文項目のみアクセスを失います。
data配列 <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > 必須

成功レスポンスのデータ。

例: [{"can_download":true,"content_state":"present","delete_due_at":null,"filename":null,"first_available_at":"2026-11-03T12:00:00Z","generation":1,"id":"00000000-0000-4000-8000-000000000005","kind":"code","line_id":"line-example","order_id":"order-example","payload_id":"00000000-0000-4000-8000-000000000012","product_id":"example","reason":"","size_bytes":null,"state":"available","unit_id":"00000000-0000-4000-8000-000000000011","unit_ordinal":1,"variant_id":null,"version":2}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 必須

レスポンスのメタデータ。

例: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

追加フィールド: いいえ

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · コードを表示せずに割り当て済みの在庫を取得します。返金時は対象の注文項目のみアクセスを失います。
can_download真偽値必須

ダウンロード (true / false)

例: true
content_state文字列必須

内容の状態：present / deleting / deleted。

例: "present"
delete_due_at文字列 null必須

ファイルの削除予定日時。nullで無効になります。

文字列:format: "date-time"
例: null
filename文字列 null必須

ファイル

例: null
first_available_at文字列 null必須

この購入で初めてアクセス可能になった日時。置き換えても期限はリセットされません。

文字列:format: "date-time"
例: "2026-11-03T12:00:00Z"
generation整数必須

割り当ての世代。置き換えると増加します。

例: 1
id文字列必須

リソース識別子。返された値をそのまま保持してください。

format: "uuid"
例: "00000000-0000-4000-8000-000000000005"
kind文字列 null必須

許可された値で示されるデータ構造の種類。

例: "code"
line_id文字列必須

注文項目の固定識別子.

例: "line-example"
order_id文字列必須

関連する注文の識別子。

例: "order-example"
payload_id文字列必須

内容のID。公開ダウンロードURLではありません。

format: "uuid"
例: "00000000-0000-4000-8000-000000000012"
product_id文字列必須

商品識別子。

例: "example"
reason文字列必須

変更の記録理由。

例: ""
size_bytes整数 null必須

サイズ（バイト）

例: null
state文字列必須

ステータス

例: "available"
unit_id文字列必須

個別のコードまたはファイルのID。

format: "uuid"
例: "00000000-0000-4000-8000-000000000011"
unit_ordinal整数必須

注文項目の購入数量内での単位番号。

例: 1
variant_id文字列 null必須

商品バリエーション識別子。

例: null
version整数必須

同時更新制御に使うリソースバージョン。

例: 2

追加フィールド: いいえ

請求書情報

InvoiceData · スキーマ · データスキーマ: 注文
address_line_1文字列 null必須

住所の1行目。

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.

例: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData null必須

税抜金額 · 割引後; 不明: null、既知のゼロ: 0.

例: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData null必須

税額 · 割引後; 不明: null、既知のゼロ: 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 文字列として表した10進数の金額。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 文字列として表した10進数の金額。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}}}

追加フィールド: いいえ

OrderFileData

OrderFileData · API が受け取る、または返すデータのフィールド、型、制約。 upload_idを作成した後、multipart/form-dataでファイルを送信し、商品に関連付けます。ダウンロードにはBearerトークンとcategoryの権限が必要です。応答はファイルのバイト列で、公開URLやパスワードは使いません。mode=periodではdays（1～3650）または従来のmonthsのどちらか一方を指定します。条件は購入時に保存され、返金された明細のみアクセスが取り消されます。
can_download真偽値必須

ダウンロード (true / false)

例: true
categoryFileCategory 必須

ファイルの種類: internal / customer_document / digital

例: "digital"
filename文字列必須

ファイル

例: "manual.pdf"
id文字列必須

リソース識別子。返された値をそのまま保持してください。

例: "example"
label文字列必須

該当コンテキストでのリソース名。

例: "Manual"
line_id文字列必須

注文項目の固定識別子.

例: "example"
mime_type文字列必須

メディアのコンテンツタイプ。

例: "application/pdf"
product_id文字列必須

商品識別子。

例: "example"
purchase_id文字列必須

リソース識別子。返された値をそのまま保持してください。 · purchase_id

例: "00000000-0000-4000-8000-000000000001"
reason文字列必須

変更の記録理由。

例: "paid"
sha256文字列必須

SHA-256 (hex, 64)

例: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytes整数必須

サイズ（バイト）

minimum: 1maximum: 262144000
例: 46
source_file_id文字列必須

リソース識別子。返された値をそのまま保持してください。 · source_file_id

例: "00000000-0000-4000-8000-000000000001"
source_version_id文字列必須

リソース識別子。返された値をそのまま保持してください。 · source_version_id

例: "00000000-0000-4000-8000-000000000001"
source_version_number整数必須

バージョン

minimum: 1
例: 1
state文字列必須

ステータス

例: "active"

追加フィールド: いいえ

OrderFileListData

OrderFileListData · API が受け取る、または返すデータのフィールド、型、制約。 upload_idを作成した後、multipart/form-dataでファイルを送信し、商品に関連付けます。ダウンロードにはBearerトークンとcategoryの権限が必要です。応答はファイルのバイト列で、公開URLやパスワードは使いません。mode=periodではdays（1～3650）または従来のmonthsのどちらか一方を指定します。条件は購入時に保存され、返金された明細のみアクセスが取り消されます。
files配列 <OrderFileData > 必須

商品ファイル

例: [{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}]
updates_pending真偽値必須

購入後に追加されるファイルへのアクセス · updates_pending

例: false

追加フィールド: いいえ

画像のメタデータと URL

OrderImageData · スキーマ · データスキーマ: 注文
alt文字列 null必須

画像の代替テキスト。

source文字列任意

記録された活動の発生元。

const: "current_catalog"
既定値: "current_catalog"
url文字列必須

リソースの URL。

追加フィールド: いいえ

業務上のライフサイクル状態

OrderLifecycleState · スキーマ · データスキーマ: 注文 文字列
制約
enum
["placed", "cancelled", "fulfilled", "returned"]

追加フィールド: はい

注文明細のスナップショット

OrderLineData · スキーマ · データスキーマ: 注文
discount_amountMoneyData 必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

例: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData 必須

税込金額 · 割引; 不明: null、既知のゼロ: 0.

例: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData null必須

税抜金額 · 割引; 不明: null、既知のゼロ: 0.

例: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData null必須

税額 · 割引; 不明: null、既知のゼロ: 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.

例: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData null必須

税抜金額 · 商品 · 割引前; 不明: null、既知のゼロ: 0.

例: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData null必須

税額 · 商品 · 割引前; 不明: null、既知のゼロ: 0.

例: {"amount":"46.00","currency":"PLN","minor_units":2}
position整数必須

順序付きコレクション内の位置。

例: 1
product_id文字列必須

商品識別子。

例: "product-api"
quantity整数必須

数量。

例: 2
sku文字列必須

在庫管理単位のコード。

例: "A"
taxMoneyData null必須

税額 · 1単位 · 保存された注文データ; tax ≠ unit_tax; 不明: null、既知のゼロ: 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.

例: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData null必須

税抜金額 · 商品 · 割引後; 不明: null、既知のゼロ: 0.

例: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData null必須

税額 · 商品 · 割引後 · 保存された注文データ; 不明: null、既知のゼロ: 0.

例: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData 必須

税込金額 · 1単位 · 割引前; 不明: null、既知のゼロ: 0.

例: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData null必須

税抜金額 · 1単位 · 割引前; 不明: null、既知のゼロ: 0.

例: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData 必須

単価。

例: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData null必須

税額 · 1単位 · 割引前; 不明: null、既知のゼロ: 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"]

追加フィールド: はい

OrderReleaseData

OrderReleaseData · API が受け取る、または返すデータのフィールド、型、制約。 upload_idを作成した後、multipart/form-dataでファイルを送信し、商品に関連付けます。ダウンロードにはBearerトークンとcategoryの権限が必要です。応答はファイルのバイト列で、公開URLやパスワードは使いません。mode=periodではdays（1～3650）または従来のmonthsのどちらか一方を指定します。条件は購入時に保存され、返金された明細のみアクセスが取り消されます。
access_reason文字列必須

購入後のアクセス · 変更の記録理由。

例: "paid"
access_state文字列必須

購入後のアクセス · ステータス

例: "active"
current_releaseCurrentReleaseData null必須

デジタルリリース · current_release

例: null
grant_reason文字列必須

購入後のアクセス · 変更の記録理由。

例: "purchase"
granted_at文字列必須

購入後のアクセス · UTC

format: "date-time"
例: "2026-01-01T12:00:00Z"
id文字列必須

リソース識別子。返された値をそのまま保持してください。

例: "example"
line_id文字列必須

注文項目の固定識別子.

例: "example"
manifest_sha256文字列必須

デジタルリリース · SHA-256

例: "1111111111111111111111111111111111111111111111111111111111111111"
product_id文字列必須

商品識別子。

例: "example"
published_at文字列必須

リリースを公開 · UTC

format: "date-time"
例: "2026-01-01T12:00:00Z"
purchase_id文字列必須

リソース識別子。返された値をそのまま保持してください。 · purchase_id

例: "00000000-0000-4000-8000-000000000001"
release_id文字列必須

リソース識別子。返された値をそのまま保持してください。 · release_id

例: "00000000-0000-4000-8000-000000000001"
release_sequence整数必須

デジタルリリース · 順序付きコレクション内の位置。

例: 1
update_days整数 null必須

日数 (days; null)

例: 365
update_mode文字列必須

購入後に追加されるファイルへのアクセス: none / period / unlimited

例: "period"
update_months整数 null必須

月数 (months; null)

例: null
updates_until文字列 null必須

購入後に追加されるファイルへのアクセス · UTC

文字列:format: "date-time"
例: "2027-01-01T12:00:00Z"
version_label文字列必須

バージョン

例: "1.0"

追加フィールド: いいえ

OrderReleaseListData

OrderReleaseListData · API が受け取る、または返すデータのフィールド、型、制約。 upload_idを作成した後、multipart/form-dataでファイルを送信し、商品に関連付けます。ダウンロードにはBearerトークンとcategoryの権限が必要です。応答はファイルのバイト列で、公開URLやパスワードは使いません。mode=periodではdays（1～3650）または従来のmonthsのどちらか一方を指定します。条件は購入時に保存され、返金された明細のみアクセスが取り消されます。
releases配列 <OrderReleaseData > 必須

デジタルリリース

例: [{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}]
updates_pending真偽値必須

購入後に追加されるファイルへのアクセス · updates_pending

例: false

追加フィールド: いいえ

この操作で受け付けるステータス

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).

例: "status-0"
is_initial真偽値必須

初期ステータスかどうか。

例: true
name文字列必須

該当コンテキストでのリソース名。

例: "New"
position整数必須

順序付きコレクション内の位置。

例: 0

追加フィールド: いいえ

一覧取得 · ステータス一覧 — 注文 — レスポンス

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":"status-0","is_initial":true,"name":"New","position":0},{"created_at":"2026-01-01T12:00:00Z","id":"status-1","is_initial":false,"name":"Processing","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}$"
例: "status-1"

追加フィールド: いいえ

一覧取得 — 注文 — レスポンス

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 文字列として表した10進数の金額。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 文字列として表した10進数の金額。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.

例: [{"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.

例: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData null必須

税抜金額 · 割引後; 不明: null、既知のゼロ: 0.

例: {"amount":"180.00","currency":"PLN","minor_units":2}
source文字列必須

発生元: products (商品), shipping (配送).

制約
enum
["products", "shipping"]
例: "products"
taxMoneyData null必須

税額 · 割引後; 不明: null、既知のゼロ: 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
例: 0
reason文字列必須

変更の記録理由。

minLength: 1maxLength: 500
例: "Bank transfer confirmed"
statusPaymentStatus 必須

この操作で受け付けるステータス。 unpaid: 未払い; paid: 支払済み; failed: 支払い失敗; refunded: 返金済み.

例: "paid"

追加フィールド: いいえ

この操作で受け付けるステータス

PaymentStatus · スキーマ · データスキーマ: 注文 文字列
制約
enum
["unpaid", "paid", "failed", "refunded"]

追加フィールド: はい

PickupPointAddressData

PickupPointAddressData · API が受け取る、または返すデータのフィールド、型、制約。
address_line_1文字列必須

住所の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文字列必須

住所の1行目。

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", "address_only", "name_contact", "contact_only"]
例: "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.

例: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData null必須

税抜金額 · 割引; 不明: null、既知のゼロ: 0.

例: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData null必須

税額 · 割引; 不明: null、既知のゼロ: 0.

例: {"amount":"4.60","currency":"PLN","minor_units":2}
discounts配列 <OrderDeliveryDiscountData > null必須

配送 · 割引; []: 0; null: 不明: null、既知のゼロ: 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.

例: {"amount":"0.00","currency":"PLN","minor_units":2}
method_code文字列 null必須

配送方法または支払い方法のコード。

例: "shipping-old"
method_name文字列 null必須

配送方法または支払い方法の名前。

例: "Historic carrier"
netMoneyData null必須

税抜金額 · 割引後; 不明: null、既知のゼロ: 0.

例: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData 必須

税込金額 · 配送 · 割引前; 不明: null、既知のゼロ: 0.

例: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData null必須

税抜金額 · 配送 · 割引前; 不明: null、既知のゼロ: 0.

例: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData null必須

税額 · 配送 · 割引前; 不明: null、既知のゼロ: 0.

例: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData null必須

受取場所

例: null
recipient_mode文字列必須

許可された値で示されるデータ構造の種類。

制約
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
例: "full_address"
taxMoneyData null必須

税額 · 割引後; 不明: null、既知のゼロ: 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"

追加フィールド: いいえ