SetOrderAttributes | Amazon Pay Japan

SetOrderAttributes

注文合計金額、販売事業者ID、店舗名、OrderReferenceに含める追加情報などの注文属性を設定します。

Description

SetOrderAttributesを実行し、注文合計金額、販売事業者ID、店舗名、購入者メールに表示する注文説明、ソリューションプロバイダーのSellerId、OrderReferenceに含める追加情報などの注文属性を指定します。 また、SetOrderAttributesは、OrderReferenceが生成され、ConfirmOrderReference実行後にもOrderReferenceにさらに情報を追加することができます。

リクエストパラメータ

Amazon MWSについて必要なリクエストパラメータについては, Amazon MWS開発者ガイド必須リクエストパラメータをご参照ください。

パラメータ名 必須 タイプ 説明
AmazonOrderReferenceId 必須 String この値は、購入者が Amazonで正常に認証された後、Amazon Button ウィジェットから取得できます。

変更不可
OrderAttributes オプション OrderAttributes 販売事業者指定する注文属性です。

変更可能 (下記の 変更可能な注文属性 を参照)。

変更可能な注文属性

SetOrderAttributesを実行することで、Order Referenceオブジェクトに情報を追加したり、ConfirmOrderReference実行後に変更することができます。

パラメータ名 必須 タイプ 説明 ConfirmOrderReference実行前の変更 ConfirmOrderReference実行後の変更
Amount オプション OrderTotal 注文合計金額を指定します。 変更可
CurrencyCode オプション OrderTotal ISO4217形式の通貨コードです。日本ではJPYを指定してください。 変更可
PaymentServiceProviderId オプション PaymentServiceProviderAttributes 決済サービスプロバイダ(PSP)が指定するIDです。 変更可 ConfirmOrderReference実行前に未設定の場合に限り、実行後1回まで変更可
PaymentServiceProviderOrderId オプション PaymentServiceProviderAttributes 決済サービスプロバイダによって作成された注文IDです。 変更可 ConfirmOrderReference実行前に未設定の場合に限り、実行後1回まで変更可
SellerOrderId オプション SellerOrderAttributes 販売事業者が指定するこのOrder ReferenceのIDです。

この値は購入者のメールと

Amazon Pay Webサイトのトランザクション履歴に表示されます。

この値は、一意である必要はありません。

Amazonは以下の文字のみ利用することを推奨します。
  • 小文字の英字
  • 大文字の英字
  • 数字
  • ハイフン(ダッシュ)
  • アンダースコア
変更可 ConfirmOrderReference実行前に未設定の場合に限り、実行後1回まで変更可
StoreName オプション SellerOrderAttributes 店舗名を表します。

この値は購入者のメールと

Amazon Pay Webサイトのトランザクション履歴に表示されます。

通常は、セラーセントラルの設定->出品用アカウント情報の値を

表示しますが、この値を設定することで上書きできます。
変更可 ConfirmOrderReference実行前に未設定の場合に限り、実行後1回まで変更可
CustomInformation オプション SellerOrderAttributes このOrder Referenceに含めたい追加情報です。 変更可 変更可
PlatformId オプション String ECプラットフォームを開発したソリューションプロバイダのSellerIdです。

ソリューションプロバイダのみが使用します。

ソリューションプロバイダを利用していない販売事業者は設定する必要はございません。

販売事業者は、このPlatformIdを設定しないようお気をつけください。
変更可 ConfirmOrderReference実行前に未設定の場合に限り、実行後1回まで変更可
SellerNote オプション String 購入者へ送信するメールに表示される注文説明を表します。 変更可 ConfirmOrderReference実行前に未設定の場合に限り、実行後1回まで変更可

レスポンス要素

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

サンプル

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


POST /OffAmazonPayments/2013-01-01 HTTP/1.1
Content-Type: x-www-form-urlencoded
Host: mws.amazonservices.com
User-Agent: 

AWSAccessKeyId=0GS7553JW74RRM612K02EXAMPLE
&Action=SetOrderAttributes
&AmazonOrderReferenceId=P01-1234567-1234567
&OrderAttributes.OrderTotal.Amount=106
&OrderAttributes.OrderTotal.CurrencyCode=EUR
&OrderAttributes.PlatformId=PLATFORM_ID_HERE
&OrderAttributes.SellerNote=Lorem%20ipsum
&OrderAttributes.SellerOrderAttributes.SellerOrderId=5678-23
&OrderAttributes.SellerOrderAttributes.StoreName=YOUR_STORE_NAME
&OrderAttributes.PaymentServiceProviderAttributes.PaymentServiceProviderId=PAYMENT_SERVICE_PROVIDER_ID
&OrderAttributes.PaymentServiceProviderAttributes.PaymentServiceProviderOrderId=PAYMENT_SERVICE_PROVIDER_ORDER_ID
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2012-11-05T19%3A01%3A11Z
&Version=2013-01-01
&Signature=2RPzkOgQmDybUjk0dA54maCEXAMPLE

次の点について注意してください。

  • &Actionは&AmazonOrderReferenceIdより先に記載しなければなりません。
  • &SignatureMethod値のHmacSHA256は大文字小文字を区別します。

レスポンスのサンプル


<SetOrderAttrbutesResponse
  xmlns="https://mws.amazonservices.com/
        schema/OffAmazonPayments/2013-01-01">
<SetOrderReferenceDetailsResult>
  <OrderReferenceDetails>
    <AmazonOrderReferenceId>P01-1234567-1234567</AmazonOrderReferenceId>
    <OrderTotal>
      <Amount>106</Amount>
      <CurrencyCode>EUR</CurrencyCode>
    </OrderTotal>
    <SellerOrderAttributes>
      <SellerOrderId>5678-23</SellerOrderId>
    </SellerOrderAttributes>
    <PaymentServiceProviderAttributes>
      <PaymentServiceProviderId>AXWZLM</PaymentServiceProviderId>
      <PaymentServiceProviderOrderId>229810</PaymentServiceProviderOrderId>
    </PaymentServiceProviderAttributes>
    <SellerNote>Lorem ipsum</SellerNote>
    <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>
</SetOrderReferenceDetailsResult>
<ResponseMetadata>
  <RequestId>f42df4b1-8047-11df-8d5c-bf56a38ef3b4</RequestId>
</ResponseMetadata>
</SetOrderReferenceDetailsResponse>

ご参考