Referencia de Notifications API v1
Suscríbase a las notificaciones que son relevantes para el negocio de un Selling Partner
Descripción
La API de Selling Partner para notificaciones le permite suscribirse a notificaciones que son relevantes para el negocio de un selling partner. Con esta API, puede crear un destino para recibir notificaciones, suscribirse a notificaciones, eliminar suscripciones a notificaciones y más.
Para obtener más información, consulte las Guía de casos de uso de la Notificationes API v1.
Información de la versión
Versión : v1
Información de contacto
Contacto : Soporte para desarrolladores Selling Partner API
Contacto dirección URL : https://sellercentral.amazon.com/gp/mws/contactus.html
La información de la licencia
Licencia : Licencia Apache 2.0
Licencia de URL : http://www.apache.org/licenses/LICENSE-2.0
Esquema de URI
Host : sellingpartnerapi-na.amazon.com
Esquemas : HTTPS
Consume
application/json
Produce
application/json
Las operaciones de
getSubscription
createSubscription
getSubscriptionById
deleteSubscriptionById
getDestinations
createDestination
getDestination
deleteDestination
Rutas
GET /notificaciones/v1/suscripciones/{notificationType}
Operación: getSubscription
Descripción
Devuelve información sobre las suscripciones del tipo de notificación especificado. Puede usar esta API para obtener información de suscripción cuando no tiene un identificador de suscripción.
El Plan De Uso:
| Tasa de (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit header de respuesta retorna el plan de usos de los límites de frecuencia que se aplica a la operación solicitada, cuando esté disponible. La tabla anterior indica que la tasa de incumplimiento y la Burst de valores para esta operación. Selling partners cuya actividad requiere un mayor rendimiento puede ver la tasa más alta y la Burst de valores de los que se muestran aquí. Para obtener más información, consulte Planes de Uso y los Límites de la Frecuencia en la Selling Partner API.
Parámetros
| Tipo de | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | notificationType se requiere | El tipo de notificación. Para obtener más información acerca de los tipos de notificación, ver las Guía de casos de uso de la Notificationes API v1. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
| 400 | solicitud falta o no es válido parámetros y no puede ser analizado. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
| 403 | Indica que el acceso a los recursos está prohibido. Posibles razones incluyen Acceso Denegado, no autorizada, el Token Caducado, o la Firma no válida. Headers : x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
| 413 | El tamaño de la solicitud supera el tamaño máximo aceptado. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el encabezado de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
| 415 | La solicitud de payload está en un formato no compatible. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
| 429 | La frecuencia de las solicitudes fue mayor de lo permitido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
| 500 | Una condición inesperada ocurrió que impidió que el servidor desde el cumplimiento de la request. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
| 503 | Temporal de sobrepayload o de mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
POST /notifications/v1/subscriptions/{notificationType}
Operación: createSubscription
Descripción
Crea una suscripción para el tipo de notificación para ser entregados al destino especificado. Antes de poder suscribirte, debes crear primero el destino llamando a la operación createDestination.
El Plan De Uso:
| Tasa de (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit header de respuesta retorna el plan de usos de los límites de frecuencia que se aplica a la operación solicitada, cuando esté disponible. La tabla anterior indica que la tasa de incumplimiento y la Burst de valores para esta operación. Selling partners cuya actividad requiere un mayor rendimiento puede ver la tasa más alta y la Burst de valores de los que se muestran aquí. Para obtener más información, consulte Planes de Uso y los Límites de la Frecuencia en la Selling Partner API.
Parámetros
| Tipo de | Nombre | Descripción | Esquema |
|---|---|---|---|
| Body | body se requiere | La solicitud de esquema para la operación createSubscription. | CreateSubscriptionRequest |
| Path | notificationType se requiere | El tipo de notificación. Para obtener más información acerca de los tipos de notificación, ver las Guía de casos de uso de la Notificationes API v1. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
| 400 | solicitud falta o no es válido parámetros y no puede ser analizado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
| 403 | Indica que el acceso a los recursos está prohibido. Posibles razones incluyen Acceso Denegado, no autorizada, el Token Caducado, o la Firma no válida. Headers : x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
| 409 | El recurso especificado conflictos con el estado actual. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
| 413 | El tamaño de la solicitud supera el tamaño máximo aceptado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
| 415 | La solicitud de payload está en un formato no compatible. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
| 429 | La frecuencia de las solicitudes fue mayor de lo permitido. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
| 500 | Una condición inesperada ocurrió que impidió que el servidor desde el cumplimiento de la request. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
| 503 | Temporal de sobrepayload o de mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateSubscriptionResponse |
GET /notifications/v1/subscriptions/{notificationType}/{subscriptionId}
Operación: getSubscriptionById
Descripción
Devuelve información acerca de la suscripción durante un determinado tipo de notificación. El getSubscriptionById API es grantless. Para obtener más información, consulte Grantless operaciones en la Guía para dessarrollador de la Selling Partner API.
El Plan De Uso:
| Tasa de (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit header de respuesta retorna el plan de usos de los límites de frecuencia que se aplica a la operación solicitada, cuando esté disponible. La tabla anterior indica que la tasa de incumplimiento y la Burst de valores para esta operación. Selling partners cuya actividad requiere un mayor rendimiento puede ver la tasa más alta y la Burst de valores de los que se muestran aquí. Para obtener más información, consulte Planes de Uso y los Límites de la Frecuencia en la Selling Partner API.
Parámetros
| Tipo de | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | subscriptionId se requiere | El identificador de la suscripción que desea obtener. | string |
| Path | notificationType se requiere | El tipo de notificación. Para obtener más información acerca de los tipos de notificación, ver las Guía de casos de uso de la Notificationes API v1. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionByIdResponse |
| 400 | solicitud falta o no es válido parámetros y no puede ser analizado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionByIdResponse |
| 403 | Indica que el acceso a los recursos está prohibido. Posibles razones incluyen Acceso Denegado, no autorizada, el Token Caducado, o la Firma no válida. Headers : x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionByIdResponse |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionResponse |
| 409 | El recurso especificado conflictos con el estado actual. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionByIdResponse |
| 413 | El tamaño de la solicitud supera el tamaño máximo aceptado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionByIdResponse |
| 415 | La solicitud de payload está en un formato no compatible. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionByIdResponse |
| 429 | La frecuencia de las solicitudes fue mayor de lo permitido. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionByIdResponse |
| 500 | Una condición inesperada ocurrió que impidió que el servidor desde el cumplimiento de la request. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionByIdResponse |
| 503 | Temporal de sobrepayload o de mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetSubscriptionByIdResponse |
DELETE /notifications/v1/subscriptions/{notificationType}/{subscriptionId}
Operación: deleteSubscriptionById
Descripción
Elimina la suscripción indicado por el identificador de suscripción y el tipo de notificación que especifique. La suscripción identificador puede ser para cualquier suscripción asociados con su request. Después de llamar correctamente esta operación, las notificaciones se deja de ser enviado para la suscripción asociada. El deleteSubscriptionById API es grantless. Para obtener más información, consulte Grantless operaciones en la Guía para dessarrollador de la Selling Partner API.
El Plan De Uso:
| Tasa de (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit header de respuesta retorna el plan de usos de los límites de frecuencia que se aplica a la operación solicitada, cuando esté disponible. La tabla anterior indica que la tasa de incumplimiento y la Burst de valores para esta operación. Selling partners cuya actividad requiere un mayor rendimiento puede ver la tasa más alta y la Burst de valores de los que se muestran aquí. Para obtener más información, consulte Planes de Uso y los Límites de la Frecuencia en la Selling Partner API.
Parámetros
| Tipo de | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | subscriptionId se requiere | El identificador de la suscripción que desea eliminar. | string |
| Path | notificationType se requiere | El tipo de notificación. Para obtener más información acerca de los tipos de notificación, ver las Guía de casos de uso de la Notificationes API v1. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
| 400 | solicitud falta o no es válido parámetros y no puede ser analizado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
| 403 | Indica que el acceso a los recursos está prohibido. Posibles razones incluyen Acceso Denegado, no autorizada, el Token Caducado, o la Firma no válida. Headers : x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
| 409 | El recurso especificado conflictos con el estado actual. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
| 413 | El tamaño de la solicitud supera el tamaño máximo aceptado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
| 415 | La solicitud de payload está en un formato no compatible. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
| 429 | La frecuencia de las solicitudes fue mayor de lo permitido. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
| 500 | Una condición inesperada ocurrió que impidió que el servidor desde el cumplimiento de la request. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
| 503 | Temporal de sobrepayload o de mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteSubscriptionByIdResponse |
GET /notifications/v1/destinations
Operación: getDestinations
Descripción
Devuelve información acerca de todos los destinos. El getDestinations API es grantless. Para obtener más información, consulte Grantless operaciones en la Guía para dessarrollador de la Selling Partner API.
El Plan De Uso:
| Tasa de (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit header de respuesta retorna el plan de usos de los límites de frecuencia que se aplica a la operación solicitada, cuando esté disponible. La tabla anterior indica que la tasa de incumplimiento y la Burst de valores para esta operación. Selling partners cuya actividad requiere un mayor rendimiento puede ver la tasa más alta y la Burst de valores de los que se muestran aquí. Para obtener más información, consulte Planes de Uso y los Límites de la Frecuencia en la Selling Partner API.
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
| 400 | solicitud falta o no es válido parámetros y no puede ser analizado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
| 403 | Indica que el acceso a los recursos está prohibido. Posibles razones incluyen Acceso Denegado, no autorizada, el Token Caducado, o la Firma no válida. Headers : x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
| 409 | El recurso especificado conflictos con el estado actual. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
| 413 | El tamaño de la solicitud supera el tamaño máximo aceptado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
| 415 | La solicitud de payload está en un formato no compatible. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
| 429 | La frecuencia de las solicitudes fue mayor de lo permitido. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
| 500 | Una condición inesperada ocurrió que impidió que el servidor desde el cumplimiento de la request. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
| 503 | Temporal de sobrepayload o de mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationsResponse |
POST /notifications/v1/destinations
Operación: createDestination
Descripción
Crea un destino de recursos para recibir notificaciones. El createDestination API es grantless. Para obtener más información, consulte Grantless operaciones en la Guía para dessarrollador de la Selling Partner API.
El Plan De Uso:
| Tasa de (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit header de respuesta retorna el plan de usos de los límites de frecuencia que se aplica a la operación solicitada, cuando esté disponible. La tabla anterior indica que la tasa de incumplimiento y la Burst de valores para esta operación. Selling partners cuya actividad requiere un mayor rendimiento puede ver la tasa más alta y la Burst de valores de los que se muestran aquí. Para obtener más información, consulte Planes de Uso y los Límites de la Frecuencia en la Selling Partner API.
Parámetros
| Tipo de | Nombre | Descripción | Esquema |
|---|---|---|---|
| Body | body se requiere | La solicitud de esquema para la operación createDestination. | CreateDestinationRequest |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
| 400 | solicitud falta o no es válido parámetros y no puede ser analizado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
| 403 | Indica que el acceso a los recursos está prohibido. Posibles razones incluyen Acceso Denegado, no autorizada, el Token Caducado, o la Firma no válida. Headers : x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
| 409 | El recurso especificado conflictos con el estado actual. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
| 413 | El tamaño de la solicitud supera el tamaño máximo aceptado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
| 415 | La solicitud de payload está en un formato no compatible. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
| 429 | La frecuencia de las solicitudes fue mayor de lo permitido. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
| 500 | Una condición inesperada ocurrió que impidió que el servidor desde el cumplimiento de la request. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
| 503 | Temporal de sobrepayload o de mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | CreateDestinationResponse |
GET /notifications/v1/destinations/{destinationId}
Operación: getDestination
Descripción
Devuelve información sobre todos los destinos. El getDestination API es grantless. Para obtener más información, consulte Grantless operaciones en la Guía para dessarrollador de la Selling Partner API.
El Plan De Uso:
| Tasa de (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit header de respuesta retorna el plan de usos de los límites de frecuencia que se aplica a la operación solicitada, cuando esté disponible. La tabla anterior indica que la tasa de incumplimiento y la Burst de valores para esta operación. Selling partners cuya actividad requiere un mayor rendimiento puede ver la tasa más alta y la Burst de valores de los que se muestran aquí. Para obtener más información, consulte Planes de Uso y los Límites de la Frecuencia en la Selling Partner API.
Parámetros
| Tipo de | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | destinationId se requiere | El identificador generado cuando se creó el destino. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
| 400 | solicitud falta o no es válido parámetros y no puede ser analizado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
| 403 | Indica que el acceso a los recursos está prohibido. Posibles razones incluyen Acceso Denegado, no autorizada, el Token Caducado, o la Firma no válida. Headers : x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
| 409 | El recurso especificado conflictos con el estado actual. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
| 413 | El tamaño de la solicitud supera el tamaño máximo aceptado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
| 415 | La solicitud de payload está en un formato no compatible. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
| 429 | La frecuencia de las solicitudes fue mayor de lo permitido. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
| 500 | Una condición inesperada ocurrió que impidió que el servidor desde el cumplimiento de la request. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
| 503 | Temporal de sobrepayload o de mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | GetDestinationResponse |
DELETE /notifications/v1/destinations/{destinationId}
Operación: deleteDestination
Descripción
Elimina el destino que especifiques. El deleteDestination API es grantless. Para obtener más información, consulte Grantless operaciones en la Guía para dessarrollador de la Selling Partner API.
El Plan De Uso:
| Tasa de (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit header de respuesta retorna el plan de usos de los límites de frecuencia que se aplica a la operación solicitada, cuando esté disponible. La tabla anterior indica que la tasa de incumplimiento y la Burst de valores para esta operación. Selling partners cuya actividad requiere un mayor rendimiento puede ver la tasa más alta y la Burst de valores de los que se muestran aquí. Para obtener más información, consulte Planes de Uso y los Límites de la Frecuencia en la Selling Partner API.
Parámetros
| Tipo de | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | destinationId se requiere | El identificador para el destino que desea eliminar. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
| 400 | solicitud falta o no es válido parámetros y no puede ser analizado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
| 403 | Indica que el acceso a los recursos está prohibido. Posibles razones incluyen Acceso Denegado, no autorizada, el Token Caducado, o la Firma no válida. Headers : x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
| 409 | El recurso especificado conflictos con el estado actual. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
| 413 | El tamaño de la solicitud supera el tamaño máximo aceptado. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
| 415 | La solicitud de payload está en un formato no compatible. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
| 429 | La frecuencia de las solicitudes fue mayor de lo permitido. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
| 500 | Una condición inesperada ocurrió que impidió que el servidor desde el cumplimiento de la request. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
| 503 | Temporal de sobrepayload o de mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : El límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el límite de tasa de cabecera es obsoleto y ya no regresó. x-amzn-RequestId (string) : Única solicitud identificador de referencia. | DeleteDestinationResponse |
Definiciones
ProcessingDirective
Información adicional pasa a la suscripción para el control de la tramitación de las notificaciones. Por ejemplo, puede utilizar un eventFilter para personalizar su suscripción para el envío de notificaciones por sólo el especificado marketplaceId, o seleccione la agregación período de tiempo en el que para enviar notificaciones (por ejemplo, limitar a una notificación cada cinco minutos para la alta frecuencia de las notificaciones). Las características específicas disponibles varían dependiendo de la notificationType.
Esta función está limitada a determinadas notificationTypes y actualmente sólo es compatible por el ANY_OFFER_CHANGED notificationType.
| Nombre | Descripción | Esquema |
|---|---|---|
| eventFilter opcional | Un notificationType filtro específico. | EventFilter |
EventFilter
Un notificationType filtro específico. Este objeto contiene todos los disponibles en la actualidad los filtros y las propiedades que puede utilizar para definir un notificationType filtro específico.
Polymorphism : Composition
| Nombre | Descripción | Esquema |
|---|---|---|
| aggregationSettings opcional | Un recipiente que contiene todas las propiedades necesarias para configurar la agregación de las notificaciones. | AggregationSettings |
| marketplaceIds opcional | Una lista de marketplace de los identificadores de suscribirse (por ejemplo, ATVPDKIKX0DER). Para recibir las notificaciones en cada marketplace, no proporcionar esta lista. | MarketplaceIds |
| eventFilterType se requiere | Un eventFilterType valor que es apoyado por el notificationType. Esto es utilizado por el servicio de suscripción para determinar el tipo de filtro de eventos. Consulte la sección de las Guía de casos de uso de la Notificationes API v1 que describe los específicos notificationType para determinar si un eventFilterType es compatible. | string |
MarketplaceFilter
El uso de este filtro de eventos para personalizar su suscripción para el envío de notificaciones por sólo el especificado marketplaceId del.
| Nombre | Descripción | Esquema |
|---|---|---|
| marketplaceIds opcional | Una lista de marketplace de los identificadores de suscribirse (por ejemplo, ATVPDKIKX0DER). Para recibir las notificaciones en cada marketplace, no proporcionar esta lista. | MarketplaceIds |
MarketplaceIds
Una lista de marketplace de los identificadores de suscribirse (por ejemplo, ATVPDKIKX0DER). Para recibir las notificaciones en cada marketplace, no proporcionar esta lista.
Tipo : < string > array
AggregationFilter
Utilice este filtro para seleccionar la agregación período de tiempo en el que para enviar notificaciones (por ejemplo, limitar a una notificación cada cinco minutos para la alta frecuencia de las notificaciones).
| Nombre | Descripción | Esquema |
|---|---|---|
| aggregationSettings opcional | Un recipiente que contiene todas las propiedades necesarias para configurar la agregación de las notificaciones. | AggregationSettings |
AggregationSettings
Un recipiente que contiene todas las propiedades necesarias para configurar la agregación de las notificaciones.
| Nombre | Descripción | Esquema |
|---|---|---|
| aggregationTimePeriod se requiere | Admite el período de tiempo a utilizar para realizar el marketplace-ASIN nivel de agregación. | AggregationTimePeriod |
AggregationTimePeriod
La agregación admitidos períodos de tiempo. Por ejemplo, si FiveMinutes es el valor elegido, y 50 el precio de las actualizaciones se producen por un ASIN dentro de los 5 minutos, Amazon enviará sólo dos notificaciones, una para el primer evento, y posteriormente una notificación 5 minutos más tarde, con el final estado final de los datos. El 48 provisional eventos serán descartados.
Tipo : enum
| Valor | Descripción |
|---|---|
| FiveMinutes | Un agregado notificación será enviada a cada cinco minutos. |
| TenMinutes | Un agregado a la notificación será enviada a cada diez minutos. |
Subscription
Representa una suscripción para recibir notificaciones.
| Nombre | Descripción | Esquema |
|---|---|---|
| subscriptionId se requiere | La suscripción identificador generado cuando la creación de la suscripción. | string |
| payloadVersion se requiere | La versión de la payload de objeto para ser usado en la notificación. | string |
| destinationId se requiere | El identificador para el destino en el que las notificaciones serán entregados. | string |
| processingDirective opcional | Información adicional pasa a la suscripción para el control de la tramitación de las notificaciones. Por ejemplo, puede utilizar un eventFilter para personalizar su suscripción para el envío de notificaciones por sólo el especificado marketplaceId, o seleccione la agregación período de tiempo en el que para enviar notificaciones (por ejemplo, limitar a una notificación cada cinco minutos para la alta frecuencia de las notificaciones). Las características específicas disponibles varían dependiendo de la notificationType. Esta función está limitada a determinadas notificationTypes y actualmente sólo es compatible por el ANY_OFFER_CHANGED notificationType. | ProcessingDirective |
CreateSubscriptionResponse
La respuesta de esquema para la operación createSubscription.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | La payload para la createSubscription operación. | Subscription |
| errores opcional | Uno o más inesperado se produjeron errores durante la createSubscription operación. | ErrorList |
CreateSubscriptionRequest
La solicitud de esquema para el createSubscription operación.
| Nombre | Descripción | Esquema |
|---|---|---|
| payloadVersion opcional | La versión de la payload de objeto para ser usado en la notificación. | string |
| destinationId opcional | El identificador para el destino en el que las notificaciones serán entregados. | string |
| processingDirective opcional | Información adicional pasa a la suscripción para el control de la tramitación de las notificaciones. Por ejemplo, puede utilizar un eventFilter para personalizar su suscripción para el envío de notificaciones por sólo el especificado marketplaceId, o seleccione la agregación período de tiempo en el que para enviar notificaciones (por ejemplo, limitar a una notificación cada cinco minutos para la alta frecuencia de las notificaciones). Las características específicas disponibles varían dependiendo de la notificationType. Esta función está limitada a determinadas notificationTypes y actualmente sólo es compatible por el ANY_OFFER_CHANGED notificationType. | ProcessingDirective |
GetSubscriptionByIdResponse
La respuesta de esquema para la operación getSubscriptionById.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | La payload para la getSubscriptionById operación. | Subscription |
| errores opcional | Una condición inesperada se produjo durante el getSubscriptionById operación. | ErrorList |
GetSubscriptionResponse
La respuesta de esquema para la operación getSubscription.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | La payload para la getSubscription operación. | Subscription |
| errores opcional | Uno o más inesperado se produjeron errores durante la getSubscription operación. | ErrorList |
DeleteSubscriptionByIdResponse
La respuesta de esquema para la operación deleteSubscriptionById.
| Nombre | Descripción | Esquema |
|---|---|---|
| errores opcional | Una condición inesperada se produjo durante el deleteSubscriptionById operación. | ErrorList |
DestinationList
Una lista de destinos.
Tipo : < Destination > array
Destination
Representa un destino creado cuando se llama a la operación createDestination.
| Nombre | Descripción | Esquema |
|---|---|---|
| name se requiere | El Desarrollador nombre definido para este destino. maxLength : 256 | string |
| destinationId se requiere | El destino identificador generado cuando se creó el destino. | string |
| resource se requiere | Los recursos que recibirá las notificaciones asociadas con este destino. | DestinationResource |
DestinationResource
El destino de los tipos de recursos.
| Nombre | Descripción | Esquema |
|---|---|---|
| sqs opcional | Amazon Simple Queue Service (SQS) de la cola de destino. | SqsResource |
| eventBridge opcional | Amazon EventBridge destino. | EventBridgeResource |
DestinationResourceSpecification
La información necesaria para crear un destino de los recursos. Las aplicaciones deben utilizar un tipo de recurso (sqs o eventBridge) por destino.
| Nombre | Descripción | Esquema |
|---|---|---|
| sqs opcional | La información necesaria para crear un Amazon Simple Queue Service (SQS) de la cola de destino. | SqsResource |
| eventBridge opcional | La información necesaria para crear un Amazon EventBridge destino. | EventBridgeResourceSpecification |
SqsResource
La información necesaria para crear un Amazon Simple Queue Service (Amazon SQS) de la cola de destino.
| Nombre | Descripción | Esquema |
|---|---|---|
| arn se requiere | El Nombre de Recurso de Amazon (ARN) asociados con la cola SQS. maxLength : 1000 Pattern : "^arn:aws:sqs:\\S+:\\S+:\\S+" | string |
EventBridgeResourceSpecification
La información necesaria para crear un Amazon EventBridge destino.
| Nombre | Descripción | Esquema |
|---|---|---|
| region se requiere | La región de AWS en el que va a recibir las notificaciones. | string |
| accountId se requiere | El identificador de la cuenta de AWS que es responsable de los gastos relacionados con la recepción de las notificaciones. | string |
EventBridgeResource
Representa un Amazon EventBridge destino.
| Nombre | Descripción | Esquema |
|---|---|---|
| name se requiere | El nombre de la pareja de origen de evento asociado con el destino. maxLength : 256 | string |
| region se requiere | La región de AWS en el que recibirá las notificaciones. Para las regiones de AWS que se admiten en Amazon EventBridge, ver https://docs.aws.amazon.com/general/latest/gr/ev.html. | string |
| accountId se requiere | El identificador de la cuenta de AWS que es responsable de los gastos relacionados con la recepción de las notificaciones. | string |
CreateDestinationRequest
La solicitud de esquema para la operación createDestination.
| Nombre | Descripción | Esquema |
|---|---|---|
| resourceSpecification se requiere | La información necesaria para crear un destino de los recursos. Las aplicaciones deben utilizar un tipo de recurso (sqs o eventBridge) por destino. | DestinationResourceSpecification |
| name se requiere | Un Desarrollador nombre definido para ayudar a identificar a este destino. | string |
CreateDestinationResponse
La respuesta de esquema para la operación createDestination.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | La payload para la createDestination operación. | Destination |
| errores opcional | Uno o más inesperado se produjeron errores durante la createDestination operación. | ErrorList |
GetDestinationResponse
La respuesta de esquema para el getDestination operación.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | La payload para la getDestination operación. | Destination |
| errores opcional | Uno o más inesperado se produjeron errores durante la getDestination operación. | ErrorList |
GetDestinationsResponse
La respuesta de esquema para la operación getDestinations.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | La payload para la getDestinations operación. | DestinationList |
| errores opcional | Uno o más inesperado se produjeron errores durante la getDestinations operación. | ErrorList |
DeleteDestinationResponse
La respuesta de esquema para la operación deleteDestination .
| Nombre | Descripción | Esquema |
|---|---|---|
| errores opcional | Uno o más inesperado se produjeron errores durante la deleteDestination operación. | ErrorList |
ErrorList
Una lista de respuestas de error devuelto cuando una solicitud es incorrecta.
Tipo : < Error > array
Error
Respuesta de Error devuelto cuando la solicitud es incorrecta.
| Nombre | Descripción | Esquema |
|---|---|---|
| código se requiere | Un error de código que identifica el tipo de error que se produjo. | string |
| mensaje se requiere | Un mensaje que describe la condición de error en una forma legible. | string |
| detalles opcional | Los detalles adicionales que pueden ayudar a la persona que llama entender o solucionar el problema. | string |
Updated over 1 year ago