Referencia de la Feeds API v2021-06-30
Cargue datos en Amazon para administrar un negocio de venta.
Descripción general
La Selling Partner API para feeds le permite cargar datos en Amazon en nombre de un selling partner.
Información de versión
Versión : 2021-06-30
Información del contacto
Contacto : Soporte para desarrolladores Selling Partner API
URL de contacto : https://sellercentral.amazon.com/gp/mws/contactus.html
Información de licencia
Licencia : Licencia Apache 2.0
URL de la licencia : http://www.apache.org/licenses/LICENSE-2.0
esquema URI
Anfitrión : sellingpartnerapi-na.amazon.com
Esquemas : HTTPS
consume
application/json
produce
application/json
Operaciones
getFeeds
crearFeed
getFeed
cancelFeed
crearFeedDocument
getFeedDocument
Rutas
GET /feeds/2021-06-30/feeds
Operación: getFeeds
Descripción
Devuelve detalles de feed para los feeds que coinciden con los filtros que especifica.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0222 | 10 |
El header de respuesta x-amzn-RateLimit-Limit devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema | Por defecto |
|---|---|---|---|---|
| Query | feedTypes opcional | Una lista de tipos de feed utilizados para filtrar feeds. Cuando se proporciona feedTypes, también se pueden proporcionar los otros parámetros de filtro (processingStatuses, marketplaceIds, createdSince, createdUntil) y pageSize. Se requiere feedTypes o nextToken. Número mínimo : 1 Número máximo : 10 | < string > array | - |
| Query | marketplaceIds opcional | Una lista de identificadores de marketplace utilizados para filtrar feeds. Los feeds devueltos coincidirán con al menos uno de los marketplace que especifique. Número mínimo : 1 Número máximo : 10 | < string > array | - |
| Query | pageSize opcional | El número máximo de feeds para devolver en una sola llamada. Mínimo : 1 Máximo : 100 | integer | 10 |
| Query | processingStatuses opcional | Una lista de estados de procesamiento utilizados para filtrar feeds. Recuento mínimo : 1 | < enum ( processingStatuses ) > array | - |
| Query | createdSince opcional | La fecha y hora de creación de feeds más antigua para los feeds incluidos en la respuesta, en formato ISO 8601. El valor predeterminado es hace 90 días. Los feeds se conservan durante un máximo de 90 días. | string (date-time) | - |
| Query | createdUntil opcional | La última fecha y hora de creación del feed para los feeds incluidos en la respuesta, en formato ISO 8601. El valor predeterminado es ahora. | string (date-time) | - |
| Query | nextToken opcional | Un token de string devuelto en la respuesta a su solicitud anterior. nextToken se devuelve cuando el número de resultados supera el valor de tamaño de página especificado. Para obtener la siguiente página de resultados, llame a la operación getFeeds e incluya este token como el único parámetro. Especificar nextToken con cualquier otro parámetro hará que la solicitud falle. | string | - |
| 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): ID de referencia de solicitud única. | GetFeedsResponse |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 415 | El header de tipo de contenido de la solicitud no es válido. 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): identificador de referencia de solicitud único. | ErrorList |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
POST /feeds/2021-06-30/feeds
Operación: createFeed
Descripción
Crea un feed. Cargue el contenido del documento de feed antes de llamar a esta operación.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0083 | 15 |
El header de respuesta x-amzn-RateLimit-Limit devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Body | body requerido | Información necesaria para crear el feed. | CreateFeedSpecification |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 202 | Éxito. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | CreateFeedResponse |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 415 | El header de tipo de contenido de la solicitud no es válido. 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): identificador de referencia de solicitud único. | ErrorList |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
GET /feeds/2021-06-30/feeds/{feedId}
Operación: getFeed
Descripción
Devuelve los detalles del feed (incluido resultDocumentId, si está disponible) para el feed que especifique.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 2 | 15 |
El header de respuesta x-amzn-RateLimit-Limit devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | feedId requerido | El identificador del feed. Este identificador es único solo en combinación con uno seller ID. | 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): ID de referencia de solicitud única. | Feed |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 415 | El header de tipo de contenido de la solicitud no es válido. 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): identificador de referencia de solicitud único. | ErrorList |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
DELETE /feeds/2021-06-30/feeds/{feedId}
Operación: cancelFeed
Descripción
Cancela el feed que especifique. Solo se pueden cancelar los feeds con processingStatus=IN_QUEUE. Los feeds cancelados se devuelven en llamadas posteriores a las operaciones getFeed y getFeeds.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 2 | 15 |
El header de respuesta x-amzn-RateLimit-Limit devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | feedId requerido | El identificador del feed. Este identificador es único solo en combinación con uno seller ID. | 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): ID de referencia de solicitud única. | Sin contenido |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 415 | El header de tipo de contenido de la solicitud no es válido. 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): identificador de referencia de solicitud único. | ErrorList |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
POST /feeds/2021-06-30/documents
Operación: createFeedDocument
Descripción
Crea un documento de feed para el tipo de feed que especifique. Esta operación devuelve una URL prefirmada para cargar el contenido del documento de feed. También devuelve un valor de feedDocumentId que puede pasar con una llamada posterior a la operación createFeed.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.5 | 15 |
El header de respuesta x-amzn-RateLimit-Limit devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Body | body requerido | Especifica el tipo de contenido para la operación createFeedDocument. | CreateFeedDocumentSpecification |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 201 | Se creó correctamente un documento de feed que está listo para recibir contenido. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | CreateFeedDocumentResponse |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 415 | La carga útil de la solicitud está en un formato no admitido. 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
GET /feeds/2021-06-30/documents/{feedDocumentId}
Operación: getFeedDocument
Descripción
Devuelve la información necesaria para recuperar el contenido de un documento de feed.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0222 | 10 |
El header de respuesta x-amzn-RateLimit-Limit devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | feedDocumentId requerido | El identificador del documento de feed . | 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): ID de referencia de solicitud única. | FeedDocumento |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 415 | El header de tipo de contenido de la solicitud no es válido. 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): identificador de referencia de solicitud único. | ErrorList |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
Respuestas de error y esquemas
Esta tabla contiene códigos de estado HTTP e información asociada para respuestas de error.
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 413 | El tamaño de la solicitud excedió 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 503 | Sobrecarga temporal o 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 header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
Definiciones
Error
Se devolvió una respuesta de error cuando la solicitud no tuvo éxito.
| Nombre | Descripción | Esquema |
|---|---|---|
| código requerido | Un código de error que identifica el tipo de error que ocurrió. | string |
| mensaje requerido | Un mensaje que describe la condición de error en un formato legible por humanos. | string |
| detalles opcional | Detalles adicionales que pueden ayudar a la persona que llama a comprender o solucionar el problema. | string |
ErrorList
Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.
CreateFeedResponse
esquema de respuesta.
| Nombre | Descripción | Esquema |
|---|---|---|
| feedId requerido | El identificador del feed. Este identificador es único solo en combinación con uno seller ID. | string |
Feed
Información detallada sobre el feed.
| Nombre | Descripción | Esquema |
|---|---|---|
| feedId requerido | El identificador del feed. Este identificador es único solo en combinación con uno seller ID. | string |
| feedType requerido | El tipo de feed . | string |
| marketplaceIds opcional | Una lista de identificadores para los marketplace a los que se aplica el feed. | < string > array |
| createdTime requerido | La fecha y la hora en que se creó el feed, en formato de fecha y hora ISO 8601. | string (date-time) |
| processingStatus requerido | El estado de procesamiento del feed. | enum ( ProcessingStatus ) |
| processingStartTime opcional | La fecha y la hora en que comenzó el procesamiento del feed, en formato de fecha y hora ISO 8601. | string (date-time) |
| processingEndTime opcional | La fecha y la hora en que se completó el procesamiento del feed, en formato de fecha y hora ISO 8601. | string (date-time) |
| resultFeedDocumentId opcional | El identificador del documento de feed. Este identificador es único solo en combinación con una seller ID. | string |
FeedList
Una lista de feeds.
Tipo : < feed > array
GetFeedsResponse
esquema de respuesta.
| Nombre | Descripción | Esquema |
|---|---|---|
| feeds requerido | Los feeds. | FeedList |
| nextToken opcional | Devuelto cuando el número de resultados supera el tamaño de página. Para obtener la siguiente página de resultados, llame a la operación getFeeds con este token como único parámetro. | string |
FeedDocument
Información necesaria para el documento de feed .
| Nombre | Descripción | Esquema |
|---|---|---|
| feedDocumentId requerido | El identificador del documento de feed. Este identificador es único solo en combinación con una seller ID. | string |
| URL requerido | Una URL prefirmada para el documento de feed. Si compressionAlgorithm no se devuelve, puede descargar el feed directamente desde esta URL. Esta URL caduca después de 5 minutos. | string |
| compressionAlgorithm opcional | Si el contenido del documento de feed se comprimió, el algoritmo de compresión utilizado se devuelve en esta propiedad y debe descomprimir la feed cuando la descarga. De lo contrario, puede descargar el feed directamente. Consulte el Paso 7. Descargue el reporte de procesamiento de feeds en la guía de casos de uso, donde se proporciona un código de muestra. | enum ( CompressionAlgorithm ) |
FeedOptions
Opciones adicionales para controlar el feed. Estos varían según el tipo de feed .
Tipo : < string, string > map
CreateFeedSpecification
Información necesaria para crear el feed.
| Nombre | Descripción | Esquema |
|---|---|---|
| feedType requerido | El tipo de feed . | string |
| marketplaceIds requerido | Una lista de identificadores para los marketplace a los que desea que se aplique el feed. | < string > array |
| inputFeedDocumentId requerido | El identificador de documento devuelto por la operación createFeedDocument. Cargue el contenido del documento de feed antes de llamar a la operación createFeed. | string |
| feedOptions opcional | Opciones adicionales para controlar el feed. Estos varían según el tipo de feed . | FeedOptions |
CreateFeedDocumentSpecification
Especifica el tipo de contenido para la operación createFeedDocument.
| Nombre | Descripción | Esquema |
|---|---|---|
| contentType requerido | El tipo de contenido del feed. | string |
CreateFeedDocumentResponse
Información necesaria para cargar el contenido de un documento de feed.
| Nombre | Descripción | Esquema |
|---|---|---|
| feedDocumentId requerido | El identificador del documento de feed . | string |
| URL requerido | La URL prefirmada para cargar el contenido del feed. Esta URL caduca después de 5 minutos. | string |
ProcessingStatuses
Tipo : enum
| Valor | Descripción |
|---|---|
| CANCELLED | El feed se canceló antes de que comenzara a procesarse. |
| DONE | El feed ha terminado de procesarse. Examine el contenido del documento de resultados para determinar si hubo errores durante el procesamiento. |
| FATAL | El feed se canceló debido a un error fatal. Es posible que algunas, ninguna o todas las operaciones del feed se hayan completado correctamente. |
| IN_PROGRESS | El feed se está procesando. |
| IN_QUEUE | El feed aún no ha comenzado a procesarse. Es posible que esté esperando otro feed IN_PROGRESS. |
ProcessingStatus
El estado de procesamiento del feed.
Tipo : enum
| Valor | Descripción |
|---|---|
| CANCELLED | El feed se canceló antes de que comenzara a procesarse. |
| DONE | El feed ha terminado de procesarse. Examine el contenido del documento de resultados para determinar si hubo errores durante el procesamiento. |
| FATAL | El feed se canceló debido a un error fatal. Es posible que algunas, ninguna o todas las operaciones del feed se hayan completado correctamente. |
| IN_PROGRESS | El feed se está procesando. |
| IN_QUEUE | El feed aún no ha comenzado a procesarse. Es posible que esté esperando otro feed IN_PROGRESS. |
CompressionAlgorithm
Si el contenido del documento de feed se comprimió, el algoritmo de compresión utilizado se devuelve en esta propiedad y debe descomprimir la feed cuando la descarga. De lo contrario, puede descargar el feed directamente. Consulte el Paso 7. Descargue el reporte de procesamiento de feeds en la guía de casos de uso, donde se proporciona un código de muestra.
Tipo : enum
| Valor | Descripción |
|---|---|
| GZIP | El algoritmo de compresión gzip. |
Updated over 1 year ago