CreateOrderReferenceForId | Amazon Pay Japan

CreateOrderReferenceForId

与えられたオブジェクトのOrder Referenceを生成します。

説明

CreateOrderReferenceForId処理は、IdIdType リクエストパラメータによって指定されたオブジェクトからOrder Referenceオブジェクトを生成するために利用します。

Order ReferenceをBilling Agreementオブジェクトから生成するためには、Billing Agreementが Draft状態である間では、1つだけOrder Referenceを生成することができます。多くのOrder ReferenceはBilling AgreementがOpen状態である場合に生成できます。Order Referenceの購入者、配送先住所、支払方法は、Billing Agreementから引き継がれます。 Confirmed状態のOrder Referenceオブジェクトを生成するためには、ConfirmNowリクエストパラメータをtrueにセットします。

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

リクエストパラメータ

パラメータ名 必須 タイプ 説明
Id 必須 xs:string Order Referenceを生成させるオブジェクトのIDです。

現在は、Billing AgreementのIDのみ許可されています。この値はAmazonのボタンアドレス帳お支払い方法ウィジェットから返されます。
IdType 必須 xs:string Id リクエストパラメータによって指定されたオブジェクトのタイプです。

現在はBilling Agreementのみ生成できるので、BillingAgreement の文字列を指定します。
InheritShippingAddress オプション xs:boolean Id リクエストパラメータで指定されたオブジェクトから配送先住所詳細を引き継ぐか指定します。

許可されている値
  • true - Order ReferenceオブジェクトにId リクエストパラメータで指定されたオブジェクトに指定されている配送先住所詳細が設定されます。
  • false - Order Referenceオブジェクトに配送先住所詳細が設定されません。
*明示的に値を設定してください。
ConfirmNow オプション xs:boolean 要求されたOrder Referenceをすぐに承認するか指定します。

true - Order Referenceはすぐに承認されます。ConfirmOrderReference処理を呼び出す必要はありません。

false - Order Referenceを承認するためにはConfirmOrderReference処理を呼び出さなければなりません。

デフォルト:false
OrderReferenceAttributes ConfirmNowがTrueの場合のみ必須 OrderReference

Atributes
Order Referenceの販売事業者が指定する属性です。

レスポンス要素

パラメータ名 説明
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=CreateOrderReferenceForId  
&Id=C01-1234567-1234567  
&IdType=BillingAgreement  
&SellerId=YOUR_SELLER_ID_HERE  
&SignatureMethod=HmacSHA256  
&SignatureVersion=2  
&Timestamp=2012-10-03T19%3A01%3A11Z  
&Version=2013-01-01  
&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

レスポンスのサンプル

 
<CreateOrderReferenceForIdResponse  
  xmlns="http://mws.amazonservices.com/  
    schema/OffAmazonPayments_Sandbox/2013-01-01">  
  <CreateOrderReferenceForIdResult>  
    <OrderReferenceDetails>  
      <AmazonOrderReferenceId>S01-1234567-1234567</AmazonOrderReferenceId>  
      <CreationTimestamp>2013-12-05T00:21:19Z</CreationTimestamp>  
      <ExpirationTimestamp>2014-05-05T00: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>  
  </CreateOrderReferenceForIdResult>  
  <ResponseMetadata>  
    <RequestId>5f20169b-7ab2-11df-bcef-d35615e2b044</RequestId>  
  </ResponseMetadata>  
</CreateOrderReferenceForIdResponse>