Referencia de Listings Items API v2020-09-01
Acceda a datos selling partner listings en Amazon.
Descripción general
La Selling Partner API para elementos de listados (Listings Items API) brinda acceso programático a los listados de selling partner en Amazon. Use esta API en colaboración con la Selling Partner API para definiciones de tipos de productos(Product Type Definitions) que utiliza para recuperar la información sobre los tipos de productos de Amazon necesarios para usar la Listings Items API.
Para obtener más información, consulte la Guía de casos de uso de la Listings Items API .
Información de versión
Versión : 2020-09-01
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
putListingsItem
deleteListingsItem
patchListingsItem
Paths
Caminos
PUT /listings/2020-09-01/items/{sellerId}/{sku}
Operación: putListingsItem
Descripción
Crea un Item nuevo o actualiza por completo uno existente para un selling partner.
Nota: Los parámetros asociados con esta operación pueden contener caracteres especiales que deben codificarse para llamar correctamente a la API. Para evitar errores con SKU al codificar URL, consulte Codificación de URL .
Plan de uso:
Tasa (solicitudes por segundo) | Explosión |
---|---|
5 | 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 API de Selling partners .
Parámetros
Tipo | Nombre | Descripción | Esquema |
---|---|---|---|
Path | sellerId requerido | Un identificador de selling partner, como una cuenta de comerciante o un código de vendor. | string |
Path | sku requerido | Un selling partner proporcionó un identificador para una lista de Amazon. | string |
Query | marketplaceIds requerido | Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. | array (csv) |
Query | issueLocale opcional | Una configuración regional para la localización de problemas. Cuando no se proporciona, se utiliza el código de idioma predeterminado del primer marketplace. Ejemplos: "en_US", "fr_CA", "fr_FR". Los mensajes localizados tienen el valor predeterminado "en_US" cuando una localización no está disponible en la configuración regional especificada. | string |
Body | body requerido | El esquema del body de la solicitud para la operación putListingsItem. | ListingsItemPutRequest |
Respuestas
Código HTTP | Descripción | Esquema |
---|---|---|
200 | Entendió con éxito la solicitud para crear o actualizar completamente un elemento de listados. Consulte la respuesta para determinar si se ha aceptado el envío. headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): identificador de referencia de solicitud único. | ListingsItemSubmissionResponse |
Para códigos de estado de error, descripciones y esquemas, consulte Respuestas y esquemas de error .
consume
application/json
produce
application/json
DELETE /listings/2020-09-01/items/{sellerId}/{sku}
Operación: deleteListingsItem
Descripción
Eliminar un listings item para un selling partner.
Nota: Los parámetros asociados con esta operación pueden contener caracteres especiales que deben codificarse para llamar correctamente a la API. Para evitar errores con SKU al codificar URL, consulte Codificación de URL .
Plan de uso:
Tasa (solicitudes por segundo) | Explosión |
---|---|
5 | 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 API de Selling partners .
Parámetros
Tipo | Nombre | Descripción | Esquema |
---|---|---|---|
Path | sellerId requerido | Un identificador de selling partner, como una cuenta de comerciante o un código de vendor. | string |
Path | sku requerido | Un selling partner proporcionó un identificador para una lista de Amazon. | string |
Query | marketplaceIds requerido | Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. | array (csv) |
Query | issueLocale opcional | Una configuración regional para la localización de problemas. Cuando no se proporciona, se utiliza el código de idioma predeterminado del primer marketplace. Ejemplos: "en_US", "fr_CA", "fr_FR". Los mensajes localizados tienen el valor predeterminado "en_US" cuando una localización no está disponible en la configuración regional especificada. | string |
Respuestas
Código HTTP | Descripción | Esquema |
---|---|---|
200 | Entendió con éxito la solicitud de eliminación de elementos de listados. Consulte la respuesta para determinar si se ha aceptado el envío. headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): identificador de referencia de solicitud único. | ListingsItemSubmissionResponse |
Para códigos de estado de error, descripciones y esquemas, consulte Respuestas y esquemas de error .
consume
application/json
produce
application/json
PATCH /listings/2020-09-01/items/{sellerId}/{sku}
Operación: patchListingsItem
Descripción
Actualice parcialmente (patch) un listings item para un selling partner. Solo se pueden aplicar patches a los atributos de elementos de listados de nivel superior. No se admite la aplicación de patches a los atributos anidados.
Nota: Los parámetros asociados con esta operación pueden contener caracteres especiales que deben codificarse para llamar correctamente a la API. Para evitar errores con SKU al codificar URL, consulte Codificación de URL .
Plan de uso:
Tasa (solicitudes por segundo) | Explosión |
---|---|
5 | 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 API de Selling partners .
Parámetros
Tipo | Nombre | Descripción | Esquema |
---|---|---|---|
Path | sellerId requerido | Un identificador de selling partner, como una cuenta de comerciante o un código de vendor. | string |
Path | sku requerido | Un selling partner proporcionó un identificador para una lista de Amazon. | string |
Query | marketplaceIds requerido | Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. | array (csv) |
Query | issueLocale opcional | Una configuración regional para la localización de problemas. Cuando no se proporciona, se utiliza el código de idioma predeterminado del primer marketplace. Ejemplos: "en_US", "fr_CA", "fr_FR". Los mensajes localizados tienen el valor predeterminado "en_US" cuando una localización no está disponible en la configuración regional especificada. | string |
Body | body requerido | El esquema del body de la solicitud para la operación patchListingsItem. | ListingsItemPatchRequest |
Respuestas
Código HTTP | Descripción | Esquema |
---|---|---|
200 | Comprendió con éxito la solicitud de patch del listings items. Consulte la respuesta para determinar si se aceptó el envío. headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): identificador de referencia de solicitud único. | ListingsItemSubmissionResponse |
Para códigos de estado de error, descripciones y esquemas, consulte Respuestas y esquemas de error .
consume
application/json
produce
application/json
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): identificador de referencia de solicitud único. | Lista de errores |
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): identificador de referencia de solicitud único. | Lista de errores |
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): identificador de referencia de solicitud único. | Lista de errores |
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): identificador de referencia de solicitud único. | Lista de errores |
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): identificador de referencia de solicitud único. | Lista de errores |
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): identificador de referencia de solicitud único. | Lista de errores |
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): identificador de referencia de solicitud único. | Lista de errores |
Definiciones
Error
Respuesta de error devuelta cuando la solicitud no tiene é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. | string |
detalles opcional | Detalles adicionales que pueden ayudar a la persona que llama a comprender o solucionar el problema. | string |
Lista de errores
Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.
Issue
Un problema con un Item de las listas.
Nombre | Descripción | Esquema |
---|---|---|
código requerido | Un código de problema que identifica el tipo de problema. | string |
mensaje requerido | Un mensaje que describe el problema. | string |
severity requerido | La gravedad del problema. | enum ( Severity ) |
attributeNames opcional | Nombres de los atributos asociados con el problema, si corresponde. | < string > array |
PatchOperation
Operación de patch JSON individual para una solicitud HTTP PATCH.
Nombre | Descripción | Esquema |
---|---|---|
op requerido | Tipo de operación de patch JSON. Las operaciones de JSON Patch admitidas incluyen agregar, reemplazar y eliminar. Consulte https://tools.ietf.org/html/rfc6902 . | enum ( Op ) |
Path requerido | Ruta del puntero JSON del elemento a patchar. Consulte https://tools.ietf.org/html/rfc6902 . | string |
value opcional | Valor JSON para agregar, reemplazar o eliminar. | < object > array |
ListingsItemPatchRequest
El esquema del body de la solicitud para la operación patchListingsItem.
ListingsItemPutRequest
El esquema del body de la solicitud para la operación putListingsItem.
Nombre | Descripción | Esquema |
---|---|---|
productType requerido | El tipo de producto de Amazon del listings items. | string |
requirements opcional | El nombre de los requisitos establecidos para los datos proporcionados. | enum ( Requirements ) |
attributes requerido | object JSON que contiene datos de atributos de elementos de listados estructurados con clave por nombre de atributo. | object |
ListingsItemSubmissionResponse
Respuesta que contiene los resultados de un envío a la Selling Partner API para Items de listados.
Nombre | Descripción | Esquema |
---|---|---|
sku requerido | Un selling partner proporcionó un identificador para una lista de Amazon. | string |
status requerido | El estado del envío del listings items. | enum ( Status ) |
submissionId requerido | El identificador único del envío del listings items. | string |
issues opcional | Problemas de elementos de listados relacionados con el envío de elementos de listados. | < Issue > array |
Status
El estado del envío del artículo de listados.
Tipo : enumeración
Valor | Descripción |
---|---|
ACCEPTED | El envío de listados fue aceptado para su procesamiento. |
INVALID | El envío de listados no era válido y no fue aceptado para su procesamiento. |
Op
Tipo de operación de patch JSON. Las operaciones de JSON Patch admitidas incluyen agregar, reemplazar y eliminar. Consulte https://tools.ietf.org/html/rfc6902 .
Tipo : enum
Valor | Descripción |
---|---|
add | La operación "agregar" agrega o reemplaza la propiedad de destino. |
replace | La operación "reemplazar" agrega o reemplaza la propiedad de destino. |
delete | La operación "eliminar" elimina la propiedad de destino. No compatible con vendors (los vendors recibirán una respuesta de código de estado HTTP 400). |
Severity
La gravedad del problema.
Tipo : enum
Valor | Descripción |
---|---|
ERROR | Indica que se ha producido un problema que impide que se procese el envío, como un error de validación. |
WARNING | Indica que se ha producido un problema que debe revisarse, pero que no ha impedido que se procese el envío. |
INFO | Indica que se ha proporcionado información adicional que debe revisarse. |
Requirements
El nombre de los requisitos establecidos para los datos proporcionados.
Tipo : enum
Valor | Descripción |
---|---|
LISTING | Indica que los datos enviados contienen información sobre productos y condiciones de venta. |
LISTING_PRODUCT_ONLY | Indica que los datos enviados solo contienen información sobre el producto. |
LISTING_OFFER_ONLY | Indica que los datos enviados solo contienen términos de venta. No compatible con vendors (los vendors recibirán una respuesta de código de estado HTTP 400). |
Updated over 1 year ago