Messaging API v1 reference

AmazonSPAPI

# 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

# Operations

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

# Paths

# getMessagingActionsForOrder

GET /messaging/v1/orders/{amazonOrderId}

# 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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which you want a list of available message types. string
Query marketplaceIds
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 Code Description Schema
200 Returns 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# confirmCustomizationDetails

POST /messaging/v1/orders/{amazonOrderId}/messages/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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the confirmCustomizationDetails operation. CreateConfirmCustomizationDetailsRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# createConfirmDeliveryDetails

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

# 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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the createConfirmDeliveryDetails operation. CreateConfirmDeliveryDetailsRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# createLegalDisclosure

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

# 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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the createLegalDisclosure operation. CreateLegalDisclosureRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# createNegativeFeedbackRemoval

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

# 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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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 Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# createConfirmOrderDetails

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

# Description

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

Usage Plan:

Rate (requests per second) Burst
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the createConfirmOrderDetails operation. CreateConfirmOrderDetailsRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# createConfirmServiceDetails

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

# 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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the createConfirmServiceDetails operation. CreateConfirmServiceDetailsRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# CreateAmazonMotors

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

# 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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the createAmazonMotors operation. CreateAmazonMotorsRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# CreateWarranty

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

# 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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the createWarranty operation. CreateWarrantyRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# GetAttributes

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

# Description

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

Usage Plan:

Rate (requests per second) Burst
1 5

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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 Code Description Schema
200 Response 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# createDigitalAccessKey

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

# 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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the createDigitalAccessKey operation. CreateDigitalAccessKeyRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# createUnexpectedProblem

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

# 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
1 5

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

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the createUnexpectedProblem operation. CreateUnexpectedProblemRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 Indicates 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
404 The 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
413 The 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
415 The 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
429 The 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
500 An 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
503 Temporary 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

# sendInvoice

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

# Description

Sends a message providing the buyer an invoice

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a message is sent. string
Query marketplaceIds
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
Body body
required
The request schema for the sendInvoice operation. InvoiceRequest

# Responses

HTTP Code Description Schema
201 The 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
400 Request 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
403 403 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
404 The 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
413 The 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
415 The 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
429 The 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
500 Encountered 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
503 Temporary 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 (opens new window) operation of the Selling Partner API for Uploads.

Name Description Schema
uploadDestinationId
required
The identifier of the upload destination. Get this value by calling the createUploadDestinationForResource (opens new window) 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.

Name Description Schema
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.

Name Schema
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.

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

_links

Name Description Schema
self
required
- LinkObject
actions
required
Eligible actions for the specified amazonOrderId. < LinkObject > array

_embedded

Name Schema
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.

Name Description Schema
_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

Name Schema
self
required
LinkObject
schema
required
LinkObject

_embedded

Name Schema
schema
optional
GetSchemaResponse

# GetSchemaResponse

Name Description Schema
_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

Name Schema
self
required
LinkObject

# InvoiceRequest

The request schema for the sendInvoice operation.

Name Description Schema
attachments
optional
Attachments to include in the message to the buyer. < Attachment > array

# InvoiceResponse

The response schema for the sendInvoice operation.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# CreateConfirmCustomizationDetailsRequest

The request schema for the confirmCustomizationDetails operation.

Name Description Schema
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.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# CreateConfirmDeliveryDetailsRequest

The request schema for the createConfirmDeliveryDetails operation.

Name Description Schema
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.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# CreateNegativeFeedbackRemovalResponse

The response schema for the createNegativeFeedbackRemoval operation.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# CreateLegalDisclosureRequest

The request schema for the createLegalDisclosure operation.

Name Description Schema
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.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# CreateConfirmOrderDetailsRequest

The request schema for the createConfirmOrderDetails operation.

Name Description Schema
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.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# CreateConfirmServiceDetailsRequest

The request schema for the createConfirmServiceDetails operation.

Name Description Schema
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.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# CreateAmazonMotorsRequest

The request schema for the createAmazonMotors operation.

Name Description Schema
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.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# CreateWarrantyRequest

The request schema for the createWarranty operation.

Name Description Schema
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.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# GetAttributesResponse

The response schema for the GetAttributes operation.

Name Description Schema
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

Name Description Schema
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.

Name Description Schema
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.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# CreateUnexpectedProblemRequest

The request schema for the createUnexpectedProblem operation.

Name Description Schema
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.

Name Description Schema
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.

Name Description Schema
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
Last Updated: 10/11/2022, 9:45:34 PM