Amazon Pay and Login with Amazon integration guide

Buyer-facing email content that you can provide

Amazon sends an email to buyers in the following situations:

  • When an Order Reference object is confirmed
  • Any time that funds are captured
  • Any time that a refund is issued
  • Any time that a payment method is changed

Amazon supplies most of the content for the emails, but you can provide several elements within the body of the message. The following table lists the buyer-facing email content that you can define based on account settings and API operation parameters:

Email field

Source

Seller customer service email address

Specified when you set up your Amazon merchant account or from the Seller Central Settings section under Account Info.

Seller customer service phone number

Specified when you set up your Amazon merchant account or from the Seller Central Settings section under Account Info.

Seller store name

Specified when you set up your Amazon merchant account or from the Seller Central Settings section under Account Info. Can be overridden by specifying the StoreName request parameter of the SetOrderReferenceDetails operation.

Seller order identifier

Specified in the SellerOrderId request parameter of the SetOrderReferenceDetails operation.

Total order amount

Specified in the OrderTotal request parameter of the SetOrderReferenceDetails operation.

Order date

The date and time when the Order Reference object is confirmed and moves to the Open state.

Seller note

Specified in the SellerNote request parameter of the SetOrderReferenceDetails operation, the Authorize operation, the Capture operation, or the Refund operation.

Best practices

As a best practice, we recommend that you set the following information in your API calls:

  • Order total
  • Store name
  • Seller order ID
  • Seller note

Setting the Store Name and Seller information affects the details that appear in the following:

  • Buyer emails and account status
  • Information that is returned to you in IPN messages
  • Settlement and Ttansaction reports

If you have multiple stores and sites, you can filter settlement reports by Store Name.

You can compare and reconcile reports with your SellerOrderId.

Payment initiated emails

When your buyer authenticates with Amazon, Amazon Pay and Login with Amazon creates a system object called the Order Reference object, and you then call the SetOrderReferenceDetails operation to set additional attributes in the Order Reference object.

The screenshot below shows a part of a Payment initiated email that is sent to a buyer. Note the numbered fields and the corresponding parameter in the Order Reference object that is used to populate that field.

Notes:

  • You specify the Seller Information email address and phone number (shown in the screenshot as "customerservice@courtandcherry.com" and "888-555-5678," respectively) when you set up your Amazon merchant account or anytime from Seller Central in the Settings section under Account Info. The SetOrderReferenceDetails API call cannot override them.
  • The Payment initiated email is not sent in two cases:
    • When the merchant cancels the transaction (CancelOrderReference) within 5 minutes of confirmation (ConfirmOrderReference).
    • When OrderReference is closed within 5 minutes of confirmation of the OrderReference (ConfirmOrderReference).
1

Seller Information is populated with the Store Name:

&OrderReferenceAttributes.SellerOrderAttributes.StoreName

If this attribute is not set, the store name defaults to one specified during registration.

Example:

&OrderReferenceAttributes.SellerOrderAttributes.StoreName=CourtAndCherry.com

2

Order Total is set by two parameters:

&OrderReferenceAttributes.OrderTotal.Amount

&OrderReferenceAttributes.OrderTotal.CurrencyCode

Example:

&OrderReferenceAttributes.OrderTotal.Amount=106

&OrderReferenceAttributes.OrderTotal.CurrencyCode=USD

3

Seller Order ID:

&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId

Example:

&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId=5678-23

4

Note from the Seller (shown here as "Lorem Ipsum dolor," although in actuality it would be something like "Your order for Blue Shoes"):

&OrderReferenceAttributes.SellerNote

Example:

&OrderReferenceAttributes.SellerNote=Your%20order%20for%20Blue%20Shoes

Charge notification emails

Charge notification emails show parameters similar to refund notification emails, as shown in the screenshot below:

Note: You specify the Seller Information email address and phone number (shown in the screenshot as "customerservice@courtandcherry.com" and "888-555-5678," respectively) when you set up your Amazon merchant account or anytime from Seller Central in the Settings section under Account Info. The SetOrderReferenceDetails API call cannot override them.

1

Seller Information is populated with the Store Name:

&OrderReferenceAttributes.SellerOrderAttributes.StoreName

If this attribute is not set, the store name defaults to one specified during registration.

Example:

&OrderReferenceAttributes.SellerOrderAttributes.StoreName=CourtAndCherry.com

2

Order Total is set by two parameters:

&OrderReferenceAttributes.OrderTotal.Amount

&OrderReferenceAttributes.OrderTotal.CurrencyCode

Example:

&OrderReferenceAttributes.OrderTotal.Amount=106

&OrderReferenceAttributes.OrderTotal.CurrencyCode=USD

3

Seller Order ID:

&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId

Example:

&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId=5678-23

6

Note from the Seller (shown here as "Lorem Ipsum dolor," although in actuality it would be something like "Payment for Blue Shoes"):

&SellerCaptureNote

Example:

&SellerCaptureNote=Payment%20for%20Blue%20Shoes

7

Total Amount Charged appears in the opening sentence of the email as well as the Total Amount Charged and is set by two parameters:

&CaptureAmount.Amount

&CaptureAmount.CurrencyCode

Example:

&CaptureAmount.Amount=106

&CaptureAmount.CurrencyCode=USD

Refund notification emails

The screenshot below shows a refund notification email. Note that the Store Name and Seller Order ID come from the Order Reference and that some of the information in the email comes from the call to the refund operation.

Note: You specify the Seller Information email address and phone number (shown in the screenshot as "customerservice@courtandcherry.com" and "888-555-5678," respectively) when you set up your Amazon merchant account or anytime from Seller Central in the Settings section under Account Info. The SetOrderReferenceDetails API call cannot override them.

1

Seller Information is populated with the Store Name:

&OrderReferenceAttributes.SellerOrderAttributes.StoreName

If this attribute is not set, the store name defaults to one specified during registration.

Example:

&OrderReferenceAttributes.SellerOrderAttributes.StoreName=CourtAndCherry.com

3

Seller Order ID:

&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId

Example:

&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId=5678-23

6

Note from the Seller (shown here as "Lorem Ipsum dolor," although in actuality it would be something like "Refund for Blue Shoes"):

&SellerRefundNote

Example:

&SellerRefundNote=Refund%20for%20Blue%20Shoes

7

Total Amount Refunded appears in the opening sentence of the email as well as in the Payment Information section and is set by two parameters:

&RefundAmount.Amount

&RefundAmount.CurrencyCode

Example:

&RefundAmount.Amount=83.50

&RefundAmount.CurrencyCode=USD

Payment information updated emails

The payment information updated email parameters are similar to those in the refund notification email, as shown in the screenshot below:

Note: You specify the Seller Information email address and phone number (shown in the screenshot as "customerservice@courtandcherry.com" and "888-555-5678," respectively) when you set up your Amazon merchant account or anytime from Seller Central in the Settings section under Account Info. The SetOrderReferenceDetails API call cannot override them.

1

Seller Information is populated with the Store Name:

&OrderReferenceAttributes.SellerOrderAttributes.StoreName

If this attribute is not set, the store name defaults to one specified during registration.

Example:

&OrderReferenceAttributes.SellerOrderAttributes.StoreName=CourtAndCherry.com

2

Order Total is set by two parameters:

&OrderReferenceAttributes.OrderTotal.Amount

&OrderReferenceAttributes.OrderTotal.CurrencyCode

Example:

&OrderReferenceAttributes.OrderTotal.Amount=106

&OrderReferenceAttributes.OrderTotal.CurrencyCode=USD

3

Seller Order ID:

&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId

Example:

&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId=5678-23

6

Note from the Seller (shown here as "Lorem Ipsum dolor," although in actuality it would be something like "Payment for Blue Shoes"):

&SellerCaptureNote

Example:

&SellerCaptureNote= Payment%20for%20Blue%20Shoes


Copyright © 2009-2017 Amazon.com, Inc. or its affiliates. Amazon and Amazon.com are registered trademarks of Amazon.com, Inc. or its affiliates. All other trademarks are the property of their respective owners.