DOCS

Order details

/
Checkout•
ホームAPIリファレンス Checkout REST API 注文の詳細

注文の詳細

注文の詳細エンドポイントの動作を学びましょう。

orderDetail エンドポイントは、Zonos Checkout を介して完了した注文の詳細とステータスを安全に取得するために使用されます。

エンドポイント 

注意: レスポンスキーは変更される可能性があり、追加のキーが追加される場合があります。エンドポイントを使用する場合は、これらの可能性に対応できるようにコードを設定してください。

POST | https://api.iglobalstores.com/v2/orderDetail

HTTPS リクエスト

フィールドノート
HTTP メソッドPOST
エンドポイントhttps://api.iglobalstores.com/v2/orderDetail
プロトコルHTTPS
メッセージ形式JSON
Accept HTTP ヘッダーAccept: application/json
Content-Type HTTP ヘッダーContent-Type: application/json

リクエストボディ内の JSON キー/値ペア

フィールドノート
orderId オプション、referenceId パラメータを渡す場合Zonos 注文 Id は、ストア Id とハイフンを含めることなく渡すことができます（例: 123-45678 または 45678）。注意: 注文の完了と支払い後、顧客はあなたのドメインにホストされた注文完了 / 注文ありがとうページにリダイレクトされます。URL には、この値を含むクエリ文字列パラメータ “orderId” が含まれます。integer / string
referenceId オプション、orderId パラメータを渡す場合このパラメータは、createTempCart API サービスエンドポイントで渡されたユニークな referenceId によって注文のデータを検索するために使用されます。このパラメータは、orderId パラメータに基づいて注文の詳細を検索する場合は省略するか、null にする必要があります。string
secret 必須Zonos によって提供された API シークレット GUIDstring
storeId 必須Zonos によって提供されたストア ID。integer

エラー HTTP レスポンス

エラーコードメッセージ意味
415サポートされていないメディアタイプHTML エンティティ。HTTP “Content-Type” ヘッダーが無効です。
406受け入れ不可HTML エンティティ。HTTP “Accept” ヘッダーが無効です。
400不正なリクエスト“error”:”orderId: 999-99999 は有効な orderId ではありません”“error”:”orderId: 999-99999 の注文が見つかりませんでした”“error”:”無効なセキュリティ資格情報”“error”:”無効なポストボディ”“error”:”orderId または referenceId パラメータが必要です”“error”:”orderId と referenceId の両方のパラメータを指定することはできません”“error”:”orderId: 999-99999 の注文が見つかりませんでした”“error”:”store パラメータが必要です”“error”:”storeId: 999 の referenceId: 999999 の注文が見つかりませんでした”“error”:”storeId: 999 の referenceId: 999999 が重複しています”“error”:”referenceId: 999999 で注文を取得できませんでした”
500内部サーバーエラー“error”:”注文の詳細を処理できませんでした”

レスポンス JSON 定義

フィールドノート
errorこのパラメータはエラーが発生した場合のみ存在し、エラーの説明を含みます。string
order注文の詳細のマップです。JSON string
order.billingZip注文の請求先住所 - 値はZonos Checkoutに入力されました。string
orderboxCountこのフィールドは、注文を発送するために使用されるボックスの数を説明しますcreateTempCart リクエストに渡されます。string
order.carrierAccountNumber訪問者自身の配送業者アカウント番号; 訪問者の配送業者アカウントが有効な場合に使用されます。string
order.carrierAccountShippingMethod訪問者自身の配送業者アカウントで選択された配送方法; 訪問者の配送業者アカウントが有効な場合に使用されます。string
order.cslListMatch統合スクリーニングリスト (CSL) の一致。顧客情報が米国の統合スクリーニングリストで一致した場合にレビューが必要であることを示すブール値です。boolean
order.customerSelectedShippingNameZonos Checkout内の配送オプションの表示名。string
order.dutyTaxesBreakdown税金/関税の内訳のマップ。注 - 該当する場合、IPF (国際処理手数料) は含まれません。JSON string
order.dutyTaxesBreakdown.brokerageFeeUSDでの仲介手数料の金額; 正の浮動小数点数、2桁の小数点以下。integer
order.dutyTaxesBreakdown.dispursementFeeUSDでの支払い手数料の金額; 正の浮動小数点数、2桁の小数点以下。integer
order.dutyTaxesBreakdown.dutyUSDでの関税の金額; 正の浮動小数点数、2桁の小数点以下。integer
order.dutyTaxesBreakdown.prepaymentFeeUSDでの前払い手数料の金額; 正の浮動小数点数、2桁の小数点以下。integer
order.dutyTaxesBreakdown.vatOnDispursementFeeUSDでの支払い手数料に対するVAT/税金の金額; 正の浮動小数点数、2桁の小数点以下。integer
order.dutyTaxesBreakdown.vatTaxUSDでのVAT/税金の金額; 支払い手数料に対するVAT/税金は含まれません; 正の浮動小数点数、2桁の小数点以下。integer
order.dutyTaxesTotalUSDでの関税および税金の合計; 正の浮動小数点数、2桁の小数点以下。integer
order.foreignCurrencyCode注文の支払いが決済された通貨コード。string
remittance_amount特定の国（例：英国のVAT）に送金する必要がある金額。decimal
order.grandTotalUSDでの合計金額; 正の浮動小数点数、2桁の小数点以下。integer
order.grandTotalForeign決済通貨での合計金額; 正の浮動小数点数、2桁の小数点以下。integer
order.itemsアイテムのマップのリスト。アイテムマップには、Zonos Checkoutの一時カート作成時に渡されたアイテムの詳細が含まれています。アイテムプロパティの詳細についてはcreateTempCart APIドキュメントを参照してください。JSON string
order.itemsCount注文のラインアイテムのカウント。integer
order.itemsTotalUSDでのアイテム/製品の合計; 正の浮動小数点数、2桁の小数点以下。integer
order.itemsTotalForeign決済通貨でのアイテム/製品の合計; 正の浮動小数点数、2桁の小数点以下。integer
order.items[index].height正の浮動小数点数、2桁の小数点以下。integer
order.items[index].itemNonShippableboolean
order.items[index].length正の浮動小数点数、2桁の小数点以下。integer
order.items[index].quantityinteger
order.items[index].weight正の浮動小数点数、少数点以下2桁integer
order.items[index].width正の浮動小数点数、少数点以下2桁integer
order.items[index].unitPrice正の浮動小数点数、少数点以下2桁integer
order.merchantOrderId注文に関連付けられたMerchantOrderIdはupdateMerchantOrderId APIサービスエンドポイントを通じて取得されます。string
order.misc1createTempCart APIサービスエンドポイントを通じて注文に関連付けられた追加の値。string
order.misc2createTempCart APIサービスエンドポイントを通じて注文に関連付けられた追加の値。string
order.misc3createTempCart APIサービスエンドポイントを通じて注文に関連付けられた追加の値。string
order.misc4createTempCart APIサービスエンドポイントを通じて注文に関連付けられた追加の値。string
order.misc5createTempCart APIサービスエンドポイントを通じて注文に関連付けられた追加の値。string
order.misc6createTempCart APIサービスエンドポイントを通じて注文に関連付けられた追加の値。string
order.nationalIdentifier必要に応じて、注文のための追加の国際請求先住所情報。値はZonos Checkoutに入力されました。string
order.notes注文ノートに関する詳細を含むノートマップのリスト。JSON string
order.notes[index].createdByUserstring
order.notes[index].customerNote注文、配送などに関する顧客作成のノートであるかどうかを示すブール値。boolean
order.notes[index].dateCreatedmillis
order.notes[index].dateCreatedStringstring
order.notes[index].flaggedこのノートが重要としてフラグ付けされたかどうかを示すboolean
order.notes[index].noteノートの内容string
order.optInEmail顧客がZonos Checkout内の「ニュースレターにサインアップする」ためのチェックボックスを選択したことを示します。このチェックボックスをcheckoutページに表示することを選択した場合にのみ適用されます。boolean
order.orderIdZonosシステム内の注文の識別番号string
order.orderDateUTC/GMTでの注文作成タイムスタンプミリ秒。millis
order.orderDateStringUTC/GMTでの注文作成タイムスタンプ文字列。string
order.orderStatusZonosシステム内の注文の状態/ステータス。orderStatusの使用に関する詳細はここで注文を取得するを確認してください。注文ステータスに関する追加情報はここで注文を更新するを参照してください。string
order.orderStatusDateZonosシステム内の最も最近のorderStatus変更のUTC/GMTでのタイムスタンプミリ秒。millis
order.orderStatusDateStringZonosシステム内の最も最近のorderStatus変更のUTC/GMTでのタイムスタンプ文字列。string
order.paymentProcessingpaymentProcessingの詳細のマップ。一部のパラメータはアカウントに適用されない場合があり、レスポンスから除外されます。JSON string
order.paymentProcessing.captureDate利用可能な場合、ミリ秒単位の支払いキャプチャの日付。Zonosが支払いを処理している場合、このノードはレスポンスから除外されます。millis
order.paymentProcessing.captureDateString利用可能な場合、文字列としての支払いキャプチャの日付。Zonosが支払いを処理している場合、このノードはレスポンスから除外されます。string
order.paymentProcessing.cardTypeクレジットカードブランド。Zonosが支払いを処理している場合、このノードはレスポンスから除外されます。string
order.paymentProcessing.lastFour請求書のクレジットカード番号の最後の4桁。Zonos が支払いを処理している場合、このノードはレスポンスから除外されます。string
order.paymentProcessing.paymentGateway支払いゲートウェイ名。Zonos が支払いを処理している場合、「iGlobal_CC」または「iGlobal_PayPal」と表示されます。string
order.paymentProcessing.transactionType取引の種類を示します。「AUTH_CAPTURE」または「AUTH_ONLY」。Zonos が支払いを処理している場合、このノードはレスポンスから除外されます。string
order.poNumberZonos Checkout 内で指定された注文の購入注文番号。購入注文が有効になっている場合に使用されます。string
order.quotedDutyTaxesZonos Checkout で引用された関税および税金、USDで表示されます。正の浮動小数点、2桁の小数点。integer
order.quotedDutyTaxesForeignZonos Checkout で引用された関税および税金。決済通貨で表示されます。正の浮動小数点、2桁の小数点。integer
order.referenceIdcreateTempCart APIサービスエンドポイントを通じて注文に関連付けられた一意の referenceId。string
order.shipComplete注文が複数の部分で出荷されるべきかどうかを示します。boolean
order.shippingCarrierServiceLevel選択された配送オプションのキャリアおよびサービスレベル識別子。string
order.shippingInstructions配送サービスレベルのカスタマイズ可能な指示。string
order.shippingTotalUSDでの配送合計。正の浮動小数点、2桁の小数点。integer
order.shippingTotalForeign決済通貨での配送合計。正の浮動小数点、2桁の小数点。integer
order.testOrder注文がテスト注文であるかどうかを示します。boolean
order.trackingNumber出荷のために生成された追跡番号（該当する場合）。string
order.zip注文の宛先/配送先住所 - 値はZonos Checkout に入力されたか、Zonos Checkout へのリダイレクトを通じて注文に渡されました。string

追加データ型:

  • order.address1
  • order.address2
  • order.address3
  • order.altPhone
  • order.billingAddress1
  • order.billingAddress2
  • order.billingAddress3
  • order.billingAltPhone
  • order.billingCity
  • order.birthDate
  • order.billingCompany
  • order.billingCountryCode
  • order.billingCountryName
  • order.billingEmail
  • order.billingName
  • order.billingPhone
  • order.billingState
  • order.city
  • order.company
  • order.countryCode
  • order.countryName
  • order.email
  • order.items[index].countryOfOrigin
  • order.items[index].description
  • order.items[index].imageURL
  • order.items[index].itemBrand
  • order.items[index].itemCategory
  • order.items[index].itemColor
  • order.items[index].itemCustomization
  • order.items[index].itemDescriptionDetailed
  • order.items[index].itemDescriptionLong
  • order.items[index].itemFabricContent
  • order.items[index].itemHSCode
  • order.items[index].itemLtlClass
  • order.items[index].itemMaterial
  • order.items[index].itemURL
  • order.items[index].productId
  • order.items[index].sku
  • order.items[index].productId
  • order.items[index].weightUnits
  • order.name
  • order.phone
  • order.state

このページは役に立ちましたか？

Zonosを見る

ポリシーと契約
© 2024 Zonoszonos.com
このページには：