getMessagingActionsForOrder

get https://sellingpartnerapi-na.amazon.com/messaging/v1/orders/{amazonOrderId}

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

The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

Responses

Response body

object

_links

object

The links response that is associated with the specified amazonOrderId.

self

object

required

A Link object.

actions

array of objects

required

Eligible actions for the specified amazonOrderId.

actions*

object

href

string

required

A URI for this object.

name

string

An identifier for this object.

_embedded

object

The messaging actions response that is associated with the specified amazonOrderId.

actions

array of objects

required

actions*

object

_links

object

The links response that is associated with the messaging action.

_embedded

object

The embedded response associated with the messaging action.

payload

object

A simple object containing the name of the template.

errors

array of objects

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

errors

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

errors

array of objects

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

errors

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/messaging/v1/orders/amazonOrderId \
3
     --header 'accept: application/hal+json'


xxxxxxxxxx
29
}
1
{
2
  "_links": {
3
    "actions": [
4
      {
5
        "href": "/messaging/v1/orders/903-1671087-0812628/messages/negativeFeedbackRemoval?marketplaceIds=ATVPDKIKX0DER",
6
        "name": "negativeFeedbackRemoval"
7
      }
8
    ],
9
    "self": {
10
      "href": "/messaging/v1/orders/903-1671087-0812628?marketplaceIds=ATVPDKIKX0DER"
11
    }
12
  },
13
  "_embedded": {
14
    "actions": [
15
      {
16
        "_links": {
17
          "schema": {
18
            "href": "/messaging/v1/orders/903-1671087-0812628/messages/negativeFeedbackRemoval/schema",
19
            "name": "negativeFeedbackRemoval"
20
          },
21
          "self": {
22
            "href": "/messaging/v1/orders/903-1671087-0812628/messages/negativeFeedbackRemoval?marketplaceIds=ATVPDKIKX0DER",
23
            "name": "negativeFeedbackRemoval"
24
          }
25
        }

200Returns hypermedia links under the _links.actions key that specify which messaging actions are allowed for the order.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.