GetOrderReferenceDetails | Amazon Pay Japan

GetOrderReferenceDetails

Order Referenceオブジェクトの詳細と現在の状態を返します。

説明

GetOrderReferenceDetails処理は、Order Referenceオブジェクトの詳細と現在の状態を返します。Order Referenceオブジェクトは次の注文詳細を提供します。

  • 購入者
  • 金額
  • 説明
  • 配送先(オプション)
  • 販売事業者の注文情報の属性(オプション)
  • 制約のリスト(オプション)

本番環境では、この処理の最大リクエストクォーターは20であり、回復レートは1秒間に2回です。SANDBOX環境では、最大リクエストクォーターは5であり、回復レートは1秒間に1回です。

リクエストパラメータ

パラメータ名 必須 タイプ 説明
AmazonOrderReferenceId 必須 xs:string Order ReferenceのIDです。

この値は購入者がAmazonによって認証に成功した後にAmazonボタンウィジェットから取得されます。
AccessToken オプション xs:string Amazonログインのアクセストークンです。

このトークンはAmazonログインでの認証に成功した後で利用可能です。

注文完了前に完全な配送先住所を受け取るために必要です。追加のscopeパラメータのpayments:shipping_addressをセットしなければなりません。

レスポンス要素

パラメータ名 説明
OrderReferenceDetails Order Referenceオブジェクトの詳細とそのステータスが含まれます。

タイプ:OrderReferenceDetails

サンプル

呼び出しリクエストのサンプル

 
POST /OffAmazonPayments/2013-01-01 HTTP/1.1  
Content-Type: x-www-form-urlencoded  
Host: mws.amazonservices.com  
User-Agent: <Your User Agent Header>  
AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE  
&Action=GetOrderReferenceDetails  
&AccessToken=YOUR_ACCESS_TOKEN  
&AmazonOrderReferenceId=P01-1234567-1234567  
&SellerId=YOUR_SELLER_ID_HERE  
&SignatureMethod=HmacSHA256  
&SignatureVersion=2  
&Timestamp=2012-11-05T19%3A01%3A11Z  
&Version=2013-01-01  
&Signature=CLZOdtJGjAo81IxaLoE7af6HqK0EXAMPLE

レスポンスのサンプル

 
<GetOrderReferenceDetailsResponse  
  xmlns="http://mws.amazonservices.com/  
    schema/OffAmazonPayments/2013-01-01">  
<GetOrderReferenceDetailsResult>  
  <OrderReferenceDetails>  
    <AmazonOrderReferenceId>P01-1234567-1234567</AmazonOrderReferenceId>  
    <CreationTimestamp>2012-11-05T20:21:19Z</CreationTimestamp>  
    <ExpirationTimestamp>2013-05-07T23:21:19Z</ExpirationTimestamp>  
    <OrderReferenceStatus>  
      <State>Draft</State>  
    </OrderReferenceStatus>  
    <Destination>  
      <DestinationType>Physical</DestinationType>  
      <PhysicalDestination>  
        <City>New York</City>  
        <StateOrRegion>NY</StateOrRegion>  
        <PostalCode>10101-9876</PostalCode>  
        <CountryCode>US</CountryCode>  
      </PhysicalDestination>  
    </Destination>  
    <ReleaseEnvironment>Live</ReleaseEnvironment>  
  </OrderReferenceDetails>  
</GetOrderReferenceDetailsResult>  
<ResponseMetadata>  
  <RequestId>5f20169b-7ab2-11df-bcef-d35615e2b044</RequestId>  
</ResponseMetadata>  
</GetOrderReferenceDetailsResponse>