Sample sandbox notification templates

You can use the Selling Partner API sandbox to test app template types and response payloads. The following examples demonstrate a successful request, an unsuccessful request, and a request that returns an internal server error.

Successful request

The following request example uses the example app notification template, SALES_SUMMARY.

POST https://https://sellingpartnerapi-na.amazon.com/appIntegrations/2024-04-01/notifications/SALES_SUMMARY
{
  "templateId":"SALES_SUMMARY",
  "notificationParameters":{
    "summaryAsOnDate":"2022-08-30",
    "salesSummaryInUSD":1000.50
  }
}

The following is a successful response example for SALES_SUMMARY.

Status code: 200
{
  "notificationId": "174ec9ce-4c66-4208-ac92-46e22a925aa2"
}

Unsuccessful request

The following request example uses the example app notification template, BAD_REQUEST_TYPE.

POST https://https://sellingpartnerapi-na.amazon.com/appIntegrations/2024-04-01/notifications/BAD_REQUEST_TYPE
{
  "notificationParameters": {
    "summaryAsOnDate": "2022-08-30",
    "salesSummaryInUSD": 1000.50
  }
}

The following is an unsuccessful response for BAD_REQUEST_TYPE.

Status code: 400
{
  "errors": [
    {
        "code": "InvalidInput",
        "message": "Invalid input.",
        "details": "Bad request"
    }
  ]
}

Internal server error

The following request example uses the INTERNAL_SERVER_ERROR example app notification template.

POST https://https://sellingpartnerapi-na.amazon.com/appIntegrations/2024-04-01/notifications/INTERNAL_SERVER_ERROR_TYPE
{
  "notificationParameters": {
    "summaryAsOnDate": "2022-08-30",
    "salesSummaryInUSD": 1000.50
  }
}

The following is a response for INTERNAL_SERVER_ERROR.

Status code: 500
{
  "errors": [
    {        "code": "InternalFailure",
        "message": "We encountered an internal error. Please try again.",
        "details": ""
    }
  ]
}