DOCS

注文詳細

注文詳細エンドポイントの仕組みを学びます。

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レスポンス

エラーコード↕メッセージ↕意味↕
415Unsupported media typeHTMLエンティティ。HTTPの「Content-Type」ヘッダーが無効です。
406Not AcceptableHTMLエンティティ。HTTPの「Accept」ヘッダーが無効です。
400Bad Request“error”:”orderId: 999-99999 is not a valid orderId”“error”:”Could not find an order with orderId: 999-99999”“error”:”Invalid security credentials”“error”:”Invalid post body”“error”:”Parameter orderId or referenceId is required”“error”:”Cannot specify both Parameters orderId and referenceId”“error”:”No order found with orderId: 999-99999”“error”:”Parameter store required”“error”:”No order found with referenceId: 999999 for storeId: 999”“error”:”referenceId: 999999 for storeId: 999 has been duplicated”“error”:”Couldn’t retrieve order with referenceId: 999999”
500Internal Server Error“error”:”Couldn’t process order details”

レスポンス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.brokerageFee仲介手数料の金額(USD)。正の浮動小数点数、小数点以下2桁integer
order.dutyTaxesBreakdown.dispursementFee支払手数料の金額(USD)。正の浮動小数点数、小数点以下2桁integer
order.dutyTaxesBreakdown.duty関税額(USD)。正の浮動小数点数、小数点以下2桁integer
order.dutyTaxesBreakdown.prepaymentFee前払い手数料の金額(USD)。正の浮動小数点数、小数点以下2桁integer
order.dutyTaxesBreakdown.vatOnDispursementFee支払手数料に対するVAT/税金の金額(USD)。正の浮動小数点数、小数点以下2桁integer
order.dutyTaxesBreakdown.vatTaxVAT/税金の金額(USD)。支払手数料に対するVAT/税金は含みません。正の浮動小数点数、小数点以下2桁integer
order.dutyTaxesTotal関税と税金の合計(USD)。正の浮動小数点数、小数点以下2桁integer
order.foreignCurrencyCode注文の支払いが決済された通貨コード。string
remittance_amount特定の国に納付する必要がある金額(例:英国VAT)。decimal
order.grandTotal総合計(USD)。正の浮動小数点数、小数点以下2桁integer
order.grandTotalForeign決済通貨での総合計。正の浮動小数点数、小数点以下2桁integer
order.itemsアイテムマップのリストアイテムマップには、一時カート作成時にZonos Checkoutに渡されたアイテムの詳細が含まれますアイテムのプロパティの詳細については、createTempCart APIドキュメントをご確認くださいJSON string
order.itemsCount注文明細アイテムの数integer
order.itemsTotalアイテム/商品の合計(USD)。正の浮動小数点数、小数点以下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.merchantOrderIdupdateMerchantOrderId APIサービスエンドポイントを通じて注文に関連付けられたMerchantOrderId。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内で「ニュースレターに登録する」チェックボックスを選択したことを示しますチェックアウトページにこのチェックボックスを表示するよう選択している場合にのみ適用されます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.shippingTotal配送合計(USD)。正の浮動小数点数、小数点以下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

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


このページでは: