AmzSpApi::MessagingApiModel::MessagingApi
¶ ↑
All URIs are relative to https://sellingpartnerapi-na.amazon.com/
Method | HTTP request | Description ————- | ————- | ————- {confirm_customization_details} | POST /messaging/v1/orders/{amazonOrderId}/messages/confirmCustomizationDetails | {create_amazon_motors} | POST /messaging/v1/orders/{amazonOrderId}/messages/amazonMotors | {create_confirm_delivery_details} | POST /messaging/v1/orders/{amazonOrderId}/messages/confirmDeliveryDetails | {create_confirm_order_details} | POST /messaging/v1/orders/{amazonOrderId}/messages/confirmOrderDetails | {create_confirm_service_details} | POST /messaging/v1/orders/{amazonOrderId}/messages/confirmServiceDetails | {create_digital_access_key} | POST /messaging/v1/orders/{amazonOrderId}/messages/digitalAccessKey | {create_legal_disclosure} | POST /messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure | {create_negative_feedback_removal} | POST /messaging/v1/orders/{amazonOrderId}/messages/negativeFeedbackRemoval | {create_unexpected_problem} | POST /messaging/v1/orders/{amazonOrderId}/messages/unexpectedProblem | {create_warranty} | POST /messaging/v1/orders/{amazonOrderId}/messages/warranty | {get_attributes} | GET /messaging/v1/orders/{amazonOrderId}/attributes | {get_messaging_actions_for_order} | GET /messaging/v1/orders/{amazonOrderId} |
confirm_customization_details¶ ↑
CreateConfirmCustomizationDetailsResponse confirm_customization_details(bodymarketplace_idsamazon_order_id)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new body = AmzSpApi::MessagingApiModel::CreateConfirmCustomizationDetailsRequest.new # CreateConfirmCustomizationDetailsRequest | marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. begin result = api_instance.confirm_customization_details(bodymarketplace_idsamazon_order_id) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->confirm_customization_details: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateConfirmCustomizationDetailsRequest}| | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. |
Return type¶ ↑
{CreateConfirmCustomizationDetailsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/hal+json
create_amazon_motors¶ ↑
CreateAmazonMotorsResponse create_amazon_motors(bodymarketplace_idsamazon_order_id)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new body = AmzSpApi::MessagingApiModel::CreateAmazonMotorsRequest.new # CreateAmazonMotorsRequest | marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. begin result = api_instance.create_amazon_motors(bodymarketplace_idsamazon_order_id) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->create_amazon_motors: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateAmazonMotorsRequest}| | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. |
Return type¶ ↑
{CreateAmazonMotorsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/hal+json
create_confirm_delivery_details¶ ↑
CreateConfirmDeliveryDetailsResponse create_confirm_delivery_details(bodymarketplace_idsamazon_order_id)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new body = AmzSpApi::MessagingApiModel::CreateConfirmDeliveryDetailsRequest.new # CreateConfirmDeliveryDetailsRequest | marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. begin result = api_instance.create_confirm_delivery_details(bodymarketplace_idsamazon_order_id) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->create_confirm_delivery_details: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateConfirmDeliveryDetailsRequest}| | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. |
Return type¶ ↑
{CreateConfirmDeliveryDetailsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/hal+json
create_confirm_order_details¶ ↑
CreateConfirmOrderDetailsResponse create_confirm_order_details(bodymarketplace_idsamazon_order_id)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new body = AmzSpApi::MessagingApiModel::CreateConfirmOrderDetailsRequest.new # CreateConfirmOrderDetailsRequest | marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. begin result = api_instance.create_confirm_order_details(bodymarketplace_idsamazon_order_id) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->create_confirm_order_details: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateConfirmOrderDetailsRequest}| | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. |
Return type¶ ↑
{CreateConfirmOrderDetailsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/hal+json
create_confirm_service_details¶ ↑
CreateConfirmServiceDetailsResponse create_confirm_service_details(bodymarketplace_idsamazon_order_id)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new body = AmzSpApi::MessagingApiModel::CreateConfirmServiceDetailsRequest.new # CreateConfirmServiceDetailsRequest | marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. begin result = api_instance.create_confirm_service_details(bodymarketplace_idsamazon_order_id) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->create_confirm_service_details: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateConfirmServiceDetailsRequest}| | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. |
Return type¶ ↑
{CreateConfirmServiceDetailsResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/hal+json
create_digital_access_key¶ ↑
CreateDigitalAccessKeyResponse create_digital_access_key(bodymarketplace_idsamazon_order_id)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new body = AmzSpApi::MessagingApiModel::CreateDigitalAccessKeyRequest.new # CreateDigitalAccessKeyRequest | marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. begin result = api_instance.create_digital_access_key(bodymarketplace_idsamazon_order_id) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->create_digital_access_key: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateDigitalAccessKeyRequest}| | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. |
Return type¶ ↑
{CreateDigitalAccessKeyResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/hal+json
create_legal_disclosure¶ ↑
CreateLegalDisclosureResponse create_legal_disclosure(bodymarketplace_idsamazon_order_id)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new body = AmzSpApi::MessagingApiModel::CreateLegalDisclosureRequest.new # CreateLegalDisclosureRequest | marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. begin result = api_instance.create_legal_disclosure(bodymarketplace_idsamazon_order_id) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->create_legal_disclosure: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateLegalDisclosureRequest}| | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. |
Return type¶ ↑
{CreateLegalDisclosureResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/hal+json
create_negative_feedback_removal¶ ↑
CreateNegativeFeedbackRemovalResponse create_negative_feedback_removal(amazon_order_id, marketplace_ids)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. begin result = api_instance.create_negative_feedback_removal(amazon_order_id, marketplace_ids) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->create_negative_feedback_removal: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. |
Return type¶ ↑
{CreateNegativeFeedbackRemovalResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: Not defined
-
Accept: application/hal+json
create_unexpected_problem¶ ↑
CreateUnexpectedProblemResponse create_unexpected_problem(bodymarketplace_idsamazon_order_id)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new body = AmzSpApi::MessagingApiModel::CreateUnexpectedProblemRequest.new # CreateUnexpectedProblemRequest | marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. begin result = api_instance.create_unexpected_problem(bodymarketplace_idsamazon_order_id) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->create_unexpected_problem: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateUnexpectedProblemRequest}| | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. |
Return type¶ ↑
{CreateUnexpectedProblemResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/hal+json
create_warranty¶ ↑
CreateWarrantyResponse create_warranty(bodymarketplace_idsamazon_order_id)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new body = AmzSpApi::MessagingApiModel::CreateWarrantyRequest.new # CreateWarrantyRequest | marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. begin result = api_instance.create_warranty(bodymarketplace_idsamazon_order_id) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->create_warranty: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- body | {CreateWarrantyRequest}| | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. |
Return type¶ ↑
{CreateWarrantyResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: application/json
-
Accept: application/hal+json
get_attributes¶ ↑
GetAttributesResponse get_attributes(amazon_order_id, marketplace_ids)
Returns a response containing attributes related to an order. This includes buyer preferences. Usage Plan: | Rate (requests per second) | Burst | | —- | —- | | 1 | 5 |
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which a message is sent. marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. begin result = api_instance.get_attributes(amazon_order_id, marketplace_ids) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->get_attributes: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- amazon_order_id | String| An Amazon order identifier. This specifies the order for which a message is sent. | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. |
Return type¶ ↑
{GetAttributesResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: Not defined
-
Accept: application/hal+json
get_messaging_actions_for_order¶ ↑
GetMessagingActionsForOrderResponse get_messaging_actions_for_order(amazon_order_id, marketplace_ids)
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.
Example¶ ↑
# load the gem require 'messaging-api-model' api_instance = AmzSpApi::MessagingApiModel::MessagingApi.new amazon_order_id = 'amazon_order_id_example' # String | An Amazon order identifier. This specifies the order for which you want a list of available message types. marketplace_ids = ['marketplace_ids_example'] # Array<String> | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. begin result = api_instance.get_messaging_actions_for_order(amazon_order_id, marketplace_ids) p result rescue AmzSpApi::MessagingApiModel::ApiError => e puts "Exception when calling MessagingApi->get_messaging_actions_for_order: #{e}" end
Parameters¶ ↑
Name | Type | Description | Notes ————- | ————- | ————- | ————- amazon_order_id | String| An Amazon order identifier. This specifies the order for which you want a list of available message types. | marketplace_ids | {Array<String>}| A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. |
Return type¶ ↑
{GetMessagingActionsForOrderResponse}
Authorization¶ ↑
No authorization required
HTTP request headers¶ ↑
-
Content-Type: Not defined
-
Accept: application/hal+json