createDestination

post https://sellingpartnerapi-na.amazon.com/notifications/v1/destinations

Creates a destination resource to receive notifications. The createDestination operation is grantless. For more information, refer to Grantless operations.

Usage Plan:

Rate (requests per second)	Burst
1	5

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Responses

Response body

object

payload

object

Information about the destination created when you call the createDestination operation.

name

string

required

length ≤ 256

The developer-defined name for this destination.

destinationId

string

required

The destination identifier generated when you created the destination.

resource

object

required

The destination resource types.

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 POST \
2
     --url https://sellingpartnerapi-na.amazon.com/notifications/v1/destinations \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
23
 
1
{
2
  "payload": {
3
    "name": "string",
4
    "destinationId": "string",
5
    "resource": {
6
      "sqs": {
7
        "arn": "string"
8
      },
9
      "eventBridge": {
10
        "name": "string",
11
        "region": "string",
12
        "accountId": "string"
13
      }
14
    }
15
  },
16
  "errors": [
17
    {
18
      "code": "string",
19
      "message": "string",
20
      "details": "string"
21
    }
22
  ]
23
}

200Success.

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.

409The resource specified conflicts with the current state.

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.