オーダー REST API v2 (レガシー)
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
このREST APIの新しいバージョン(v2.1)が利用可能です。このREST APIを初めて使用する場合は、新しいバージョンを使用してください。または、すでに古いバージョンを使用している場合は、v2とv2.1の違いについて読んで アップグレードできるようにしてください。
orderオブジェクトは、他のすべてのオブジェクトの親オブジェクトであり、注文全体に共通の属性が含まれています。
航空会社の場合、注文は予約への1対1のマッピングです。オーダー REST APIは、乗客番号レコード(PNR)など、同じreferenceId値を持ち、orderedAt値(購入日)が別のオーダーから2日以内であるオーダーと一致します。
次の表では、orderオブジェクトの属性について説明します。
|
属性 |
種類 |
形容 |
使用例 |
|---|---|---|---|
|
referenceId |
糸 |
注文を参照するために組織によって生成される一意のID。フライトの注文の場合、これは多くの場合PNRです。 |
"B94TXY-1" |
|
channel |
糸 |
注文で使用されるチャネル。 |
"AIRPORT_KIOSK", "BRANCH", "CALL_CENTER", "GDS", "KIOSK", "MOBILE_APP", "MOBILE_WEB", "OFFLINE", "OTA", "OTHER", "WEB" |
|
pointOfSale |
文字列 (クライアントによって事前定義済み) |
注文に使用された販売時点情報。 |
"spinflight.com", "spinair.com" |
|
status |
string (大文字) |
注文のステータス。 |
"RESERVED", "PAYMENT_PENDING", "DECLINED", "PURCHASED", "PENDING", "CONFIRMED", "PARTIALY_CONFIRMED", "CANCELLED", "REFUNDED", "PARTIALY_REFUNDED", "UNKNOWN" |
|
orderedAt |
ISO 8601日付/時刻UTC |
注文が行われた日時。 |
"2025-01-01T16:17:16.000Z" |
|
currencyCode |
3文字のISO 4217 |
ゲストが購入を完了するために使用した通貨。これを組織の既定の通貨に設定します。 |
"EUR", "NZD","USD" |
|
price |
数値 (通貨) |
注文に対して支払われた金額。 |
50, 30.6 |
|
paymentType |
string (タイトルケースを推奨) |
注文の支払い方法。 |
"Card", "Paypal", "Voucher", "ATM", "Cash", "Other" |
|
cardType |
string (タイトルケースを推奨) |
注文の支払いに使用されたカードの種類。 |
"Mastercard", "Visa", "Diners", "American Express" |
|
contact |
JSONオブジェクト |
注文に関連付けられている連絡先。 |
該当なし |
|
consumers |
JSONオブジェクトのJSON配列 |
注文に関連付けられているコンシューマーの一覧。 |
該当なし |
|
orderItems |
JSONオブジェクトのJSON配列 |
注文内の1つ以上の項目の一覧。 |
該当なし |
標準の応答属性は次のとおりです。
|
属性 |
形容 |
種類 |
使用例 |
|---|---|---|---|
|
href |
リソースの完全修飾ロケーションUniform Resource Identifier (URI)。 |
糸 |
"https://{apiEndpoint}/v2/{resourceName}/{resourceRef}" |
|
ref |
リソースの参照。 |
文字列UUID |
"9d94ee11-7043-4b71-980c-a777d00a7b46" |
|
createdAt |
リソースがSitecore CDPで作成された日時。 |
ISO 8601日付/時刻UTC |
"2025-01-01T16:17:16.000Z" |
|
modifiedAt |
リソースがSitecore CDP年に更新された日時。 |
ISO 8601日付/時刻UTC |
"2025-01-01T16:17:16.000Z" |