Messaging API v1 reference

How to build applications that send messages to buyers.

Overview

With the Messaging API you can build applications that send messages to buyers. You can get a list of message types that are available for an order that you specify, then call an operation that sends a message to the buyer for that order. The Messaging API returns responses that are formed according to the JSON Hypertext Application Language (HAL) standard.

Version information

Version : v1

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/hal+json

Operations

getMessagingActionsForOrder
confirmCustomizationDetails
createConfirmDeliveryDetails
createLegalDisclosure
createNegativeFeedbackRemoval
createConfirmOrderDetails
createConfirmServiceDetails
CreateAmazonMotors
CreateWarranty
GetAttributes
createDigitalAccessKey
createUnexpectedProblem
sendInvoice

Paths

GET /messaging/v1/orders/{amazonOrderId}

Operation: getMessagingActionsForOrder

Description

Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which you want a list of available message types.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array

Responses

HTTP CodeDescriptionSchema
200Returns hypermedia links under the _links.actions key that specify which messaging actions are allowed for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetMessagingActionsForOrderResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetMessagingActionsForOrderResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetMessagingActionsForOrderResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetMessagingActionsForOrderResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetMessagingActionsForOrderResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetMessagingActionsForOrderResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetMessagingActionsForOrderResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetMessagingActionsForOrderResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetMessagingActionsForOrderResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/confirmCustomizationDetails

Operation: confirmCustomizationDetails

Description

Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the confirmCustomizationDetails operation.CreateConfirmCustomizationDetailsRequest

Responses

HTTP CodeDescriptionSchema
201The message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmCustomizationDetailsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmCustomizationDetailsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmCustomizationDetailsResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmCustomizationDetailsResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmCustomizationDetailsResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmCustomizationDetailsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmCustomizationDetailsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmCustomizationDetailsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmCustomizationDetailsResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/confirmDeliveryDetails

Operation: createConfirmDeliveryDetails

Description

Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the createConfirmDeliveryDetails operation.CreateConfirmDeliveryDetailsRequest

Responses

HTTP CodeDescriptionSchema
201The message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmDeliveryDetailsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmDeliveryDetailsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmDeliveryDetailsResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmDeliveryDetailsResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmDeliveryDetailsResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmDeliveryDetailsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmDeliveryDetailsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmDeliveryDetailsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmDeliveryDetailsResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure

Operation: createLegalDisclosure

Description

Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the createLegalDisclosure operation.CreateLegalDisclosureRequest

Responses

HTTP CodeDescriptionSchema
201The legal disclosure message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateLegalDisclosureResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateLegalDisclosureResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateLegalDisclosureResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateLegalDisclosureResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateLegalDisclosureResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateLegalDisclosureResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateLegalDisclosureResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateLegalDisclosureResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateLegalDisclosureResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/negativeFeedbackRemoval

Operation: createNegativeFeedbackRemoval

Description

Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer's problem.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array

Responses

HTTP CodeDescriptionSchema
201The negativeFeedbackRemoval message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateNegativeFeedbackRemovalResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateNegativeFeedbackRemovalResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateNegativeFeedbackRemovalResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateNegativeFeedbackRemovalResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateNegativeFeedbackRemovalResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateNegativeFeedbackRemovalResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateNegativeFeedbackRemovalResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateNegativeFeedbackRemovalResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateNegativeFeedbackRemovalResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/confirmOrderDetails

Operation: createConfirmOrderDetails

Description

Sends a message to ask a buyer an order-related question prior to shipping their order.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the createConfirmOrderDetails operation.CreateConfirmOrderDetailsRequest

Responses

HTTP CodeDescriptionSchema
201The message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmOrderDetailsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmOrderDetailsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmOrderDetailsResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmOrderDetailsResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmOrderDetailsResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmOrderDetailsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmOrderDetailsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmOrderDetailsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmOrderDetailsResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/confirmServiceDetails

Operation: createConfirmServiceDetails

Description

Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the createConfirmServiceDetails operation.CreateConfirmServiceDetailsRequest

Responses

HTTP CodeDescriptionSchema
201The message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmServiceDetailsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmServiceDetailsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmServiceDetailsResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmServiceDetailsResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmServiceDetailsResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmServiceDetailsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmServiceDetailsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmServiceDetailsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateConfirmServiceDetailsResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/amazonMotors

Operation: CreateAmazonMotors

Description

Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the createAmazonMotors operation.CreateAmazonMotorsRequest

Responses

HTTP CodeDescriptionSchema
201The message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateAmazonMotorsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateAmazonMotorsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateAmazonMotorsResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateAmazonMotorsResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateAmazonMotorsResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateAmazonMotorsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateAmazonMotorsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateAmazonMotorsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateAmazonMotorsResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/warranty

Operation: CreateWarranty

Description

Sends a message to a buyer to provide details about warranty information on a purchase in their order.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the createWarranty operation.CreateWarrantyRequest

Responses

HTTP CodeDescriptionSchema
201The message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateWarrantyResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateWarrantyResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateWarrantyResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateWarrantyResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateWarrantyResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateWarrantyResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateWarrantyResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateWarrantyResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateWarrantyResponse

GET /messaging/v1/orders/{amazonOrderId}/attributes

Operation: GetAttributes

Description

Returns a response containing attributes related to an order. This includes buyer preferences.

Usage Plan:

Rate (requests per second)Burst
15

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array

Responses

HTTP CodeDescriptionSchema
200Response has successfully been returned.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAttributesResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAttributesResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetAttributesResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAttributesResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAttributesResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAttributesResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAttributesResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAttributesResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAttributesResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/digitalAccessKey

Operation: createDigitalAccessKey

Description

Sends a message to a buyer to share a digital access key needed to utilize digital content in their order.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the createDigitalAccessKey operation.CreateDigitalAccessKeyRequest

Responses

HTTP CodeDescriptionSchema
201The message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDigitalAccessKeyResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDigitalAccessKeyResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDigitalAccessKeyResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDigitalAccessKeyResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDigitalAccessKeyResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDigitalAccessKeyResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDigitalAccessKeyResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDigitalAccessKeyResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateDigitalAccessKeyResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/unexpectedProblem

Operation: createUnexpectedProblem

Description

Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order.

Usage Plan:

Rate (requests per second)Burst
15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the createUnexpectedProblem operation.CreateUnexpectedProblemRequest

Responses

HTTP CodeDescriptionSchema
201The message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateUnexpectedProblemResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateUnexpectedProblemResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateUnexpectedProblemResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateUnexpectedProblemResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateUnexpectedProblemResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateUnexpectedProblemResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateUnexpectedProblemResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateUnexpectedProblemResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateUnexpectedProblemResponse

POST /messaging/v1/orders/{amazonOrderId}/messages/invoice

Operation: sendInvoice

Description

Sends a message providing the buyer an invoice

Parameters

TypeNameDescriptionSchema
PathamazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent.string
QuerymarketplaceIds
required
A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
Max count : 1
< string > array
Bodybody
required
The request schema for the sendInvoice operation.InvoiceRequest

Responses

HTTP CodeDescriptionSchema
201The message was created for the order.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
InvoiceResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
InvoiceResponse
403403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.
Headers :
x-amzn-RequestId (string) : Unique request reference id.
InvoiceResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
InvoiceResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
InvoiceResponse
415The entity of the request is in a format not supported by the requested resource.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
InvoiceResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
InvoiceResponse
500Encountered an unexpected condition which prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
InvoiceResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
InvoiceResponse

Definitions

Attachment

Represents a file uploaded to a destination that was created by the createUploadDestinationForResource operation of the Selling Partner API for Uploads.

NameDescriptionSchema
uploadDestinationId
required
The identifier of the upload destination. Get this value by calling the createUploadDestinationForResource operation of the Uploads API.string
fileName
required
The name of the file, including the extension. This is the file name that will appear in the message. This does not need to match the file name of the file that you uploaded.string

LinkObject

A Link object.

NameDescriptionSchema
href
required
A URI for this object.string
name
optional
An identifier for this object.string

MessagingAction

A simple object containing the name of the template.

NameSchema
name
required
string

Schema

A JSON schema document describing the expected payload of the action. This object can be validated against http://json-schema.org/draft-04/schema.

Type : object

GetMessagingActionsForOrderResponse

The response schema for the getMessagingActionsForOrder operation.

NameDescriptionSchema
_links
optional
-_links
_embedded
optional
-_embedded
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList


_links

NameDescriptionSchema
self
required
-LinkObject
actions
required
Eligible actions for the specified amazonOrderId.< LinkObject > array


_embedded

NameSchema
actions
required
< GetMessagingActionResponse > array

GetMessagingActionResponse

Describes a messaging action that can be taken for an order. Provides a JSON Hypertext Application Language (HAL) link to the JSON schema document that describes the expected input.

NameDescriptionSchema
_links
optional
-_links
_embedded
optional
-_embedded
payload
optional
A simple object containing the name of the template.MessagingAction
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList


_links

NameSchema
self
required
LinkObject
schema
required
LinkObject


_embedded

NameSchema
schema
optional
GetSchemaResponse

GetSchemaResponse

NameDescriptionSchema
_links
optional
-_links
payload
optional
A JSON schema document describing the expected payload of the action. This object can be validated against http://json-schema.org/draft-04/schema.Schema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList


_links

NameSchema
self
required
LinkObject

InvoiceRequest

The request schema for the sendInvoice operation.

NameDescriptionSchema
attachments
optional
Attachments to include in the message to the buyer.< Attachment > array

InvoiceResponse

The response schema for the sendInvoice operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateConfirmCustomizationDetailsRequest

The request schema for the confirmCustomizationDetails operation.

NameDescriptionSchema
text
optional
The text to be sent to the buyer. Only links related to customization details are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
minLength : 1
maxLength : 800
string
attachments
optional
Attachments to include in the message to the buyer.< Attachment > array

CreateConfirmCustomizationDetailsResponse

The response schema for the confirmCustomizationDetails operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateConfirmDeliveryDetailsRequest

The request schema for the createConfirmDeliveryDetails operation.

NameDescriptionSchema
text
optional
The text to be sent to the buyer. Only links related to order delivery are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
minLength : 1
maxLength : 2000
string

CreateConfirmDeliveryDetailsResponse

The response schema for the createConfirmDeliveryDetails operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateNegativeFeedbackRemovalResponse

The response schema for the createNegativeFeedbackRemoval operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateLegalDisclosureRequest

The request schema for the createLegalDisclosure operation.

NameDescriptionSchema
attachments
optional
Attachments to include in the message to the buyer. If any text is included in the attachment, the text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.< Attachment > array

CreateLegalDisclosureResponse

The response schema for the createLegalDisclosure operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateConfirmOrderDetailsRequest

The request schema for the createConfirmOrderDetails operation.

NameDescriptionSchema
text
optional
The text to be sent to the buyer. Only links related to order completion are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
minLength : 1
maxLength : 2000
string

CreateConfirmOrderDetailsResponse

The response schema for the createConfirmOrderDetails operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateConfirmServiceDetailsRequest

The request schema for the createConfirmServiceDetails operation.

NameDescriptionSchema
text
optional
The text to be sent to the buyer. Only links related to Home Service calls are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
minLength : 1
maxLength : 2000
string

CreateConfirmServiceDetailsResponse

The response schema for the createConfirmServiceDetails operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateAmazonMotorsRequest

The request schema for the createAmazonMotors operation.

NameDescriptionSchema
attachments
optional
Attachments to include in the message to the buyer. If any text is included in the attachment, the text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.< Attachment > array

CreateAmazonMotorsResponse

The response schema for the createAmazonMotors operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateWarrantyRequest

The request schema for the createWarranty operation.

NameDescriptionSchema
attachments
optional
Attachments to include in the message to the buyer. If any text is included in the attachment, the text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.< Attachment > array
coverageStartDate
optional
The start date of the warranty coverage to include in the message to the buyer.string (date-time)
coverageEndDate
optional
The end date of the warranty coverage to include in the message to the buyer.string (date-time)

CreateWarrantyResponse

The response schema for the createWarranty operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

GetAttributesResponse

The response schema for the GetAttributes operation.

NameDescriptionSchema
buyer
optional
The list of attributes related to the buyer.buyer
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList


buyer

NameDescriptionSchema
locale
optional
The buyer's language of preference, indicated with a locale-specific language tag. Examples: "en-US", "zh-CN", and "en-GB".string

CreateDigitalAccessKeyRequest

The request schema for the createDigitalAccessKey operation.

NameDescriptionSchema
text
optional
The text to be sent to the buyer. Only links related to the digital access key are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
minLength : 1
maxLength : 400
string
attachments
optional
Attachments to include in the message to the buyer.< Attachment > array

CreateDigitalAccessKeyResponse

The response schema for the createDigitalAccessKey operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateUnexpectedProblemRequest

The request schema for the createUnexpectedProblem operation.

NameDescriptionSchema
text
optional
The text to be sent to the buyer. Only links related to unexpected problem calls are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
minLength : 1
maxLength : 2000
string

CreateUnexpectedProblemResponse

The response schema for the createUnexpectedProblem operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occurred.string
message
required
A message that describes the error condition.string
details
optional
Additional details that can help the caller understand or fix the issue.string

Did this page help you?