Referencia de Listings Items API v2021-08-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, 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 : 2021-08-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

getListingsItem
putListingsItem
deleteListingsItem
patchListingsItem

Rutas

GET /listings/2021-08-01/items/{sellerId}/{sku}

Operación: getListingsItem

Descripción

Devuelve detalles sobre 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
510

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

TipoNombreDescripciónEsquema
PathsellerId
requerido
Un identificador de selling partner, como una cuenta de comerciante o un código de vendor.string
Pathsku
requerido
Un selling partner proporcionó un identificador para una lista de Amazon.string
QuerymarketplaceIds
requerido
Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. array (csv)
QueryissueLocale
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
QueryincludedData
opcional
Una lista delimitada por comas de conjuntos de datos para incluir en la respuesta. Predeterminado: summaries.< enum ( IncludedData ) > array(csv)

Respuestas

Código HTTPDescripciónEsquema
200Éxito.
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.
Item

Para códigos de estado de error, descripciones y esquemas, consulte Respuestas y esquemas de error .

consume

  • application/json

produce

  • application/json

PUT /listings/2021-08-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
510

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

TipoNombreDescripciónEsquema
PathsellerId
requerido
Un identificador de selling partner, como una cuenta de comerciante o un código de vendor.string
Pathsku
requerido
Un selling partner proporcionó un identificador para una lista de Amazon.string
QuerymarketplaceIds
requerido
Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. array (csv)
QueryissueLocale
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
Bodybody
requerido
El esquema del body de la solicitud para la operación putListingsItem.ListingsItemPutRequest

Respuestas

Código HTTPDescripciónEsquema
200Entendió 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/2021-08-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
510

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

TipoNombreDescripciónEsquema
PathsellerId
requerido
Un identificador de selling partner, como una cuenta de comerciante o un código de vendor.string
Pathsku
requerido
Un selling partner proporcionó un identificador para una lista de Amazon.string
QuerymarketplaceIds
requerido
Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. array (csv)
QueryissueLocale
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 HTTPDescripciónEsquema
200Entendió 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/2021-08-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
510

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

TipoNombreDescripciónEsquema
PathsellerId
requerido
Un identificador de selling partner, como una cuenta de comerciante o un código de vendor.string
Pathsku
requerido
Un selling partner proporcionó un identificador para una lista de Amazon.string
QuerymarketplaceIds
requerido
Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. array (csv)
QueryissueLocale
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
Bodybody
requerido
El esquema del body de la solicitud para la operación patchListingsItem.ListingsItemPatchRequest

Respuestas

Código HTTPDescripciónEsquema
200Comprendió 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 HTTPDescripciónEsquema
400La 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
403Indica 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
404El 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): identificador de referencia de solicitud único.
Lista de errores
413El tamaño de la solicitud excedió el tamaño máximo aceptado.
headers :
x-amzn-RequestId (string): identificador de referencia de solicitud único.
Lista de errores
415La carga útil de la solicitud está en un formato no admitido.
headers :
x-amzn-RequestId (string): identificador de referencia de solicitud único.
Lista de errores
429La frecuencia de las solicitudes fue mayor a la permitida.
headers :
x-amzn-RequestId (string): identificador de referencia de solicitud único.
Lista de errores
500Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud.
headers :
x-amzn-RequestId (string): identificador de referencia de solicitud único.
Lista de errores
503Sobrecarga temporal o mantenimiento del servidor.
headers :
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.

NombreDescripciónEsquema
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.

NombreEsquema
errores
requerido
array

Item

Un elemento de listados.

NombreDescripciónEsquema
sku
requerido
Un selling partner proporcionó un identificador para una lista de Amazon.string
summaries
opcional
Resumen de detalles de un listings items.ItemSummaries
attributes
opcional
object JSON que contiene datos de atributos de elementos de listados estructurados con clave por nombre de atributo.ItemAttributes
issues
opcional
Problemas asociados con el listings items.ItemIssues
offers
opcional
Detalles de la oferta para el listings items.ItemOffers
fulfillmentAvailability
opcional
Disponibilidad de cumplimiento para el listings items. array
procurement
opcional
Información de adquisición del vendor para el listings items.ItemProcurement

ItemSummaries

Resumen de detalles de un listings items.

Tipo : < ItemSummaryByMarketplace > array

ItemSummaryByMarketplace

Detalles resumidos de un listings item para un marketplace de Amazon.

NombreDescripciónEsquema
marketplaceId
requerido
Un identificador de marketplace. Identifica el marketplace de Amazon para el Item listado.string
asin
requerido
Número de identificación estándar de Amazon (ASIN) del Item publicado.string
productType
requerido
El tipo de producto de Amazon del listings items.string
conditionType
opcional
Identifica la condición del Item listado.enum ( ConditionType )
status
requerido
Estados que se aplican al listings items.< enum ( Status ) > array
fnSku
opcional
La unidad de mantenimiento de existencias de la red logística es un identificador utilizado por los centros logísticos de Amazon para identificar cada Item único.string
itemName
requerido
Nombre, o título, asociado con un Item del catálogo de Amazon.string
createdDate
requerido
Fecha en que se creó el listings items, en formato ISO 8601.string (fecha-hora)
lastUpdatedDate
requerido
Fecha en la que se actualizó por última vez el elemento de la lista, en formato ISO 8601.string (fecha-hora)
mainImage
opcional
Imagen principal del elemento de listados.ItemImage

ItemImage

Imagen para el listings items.

NombreDescripciónEsquema
link
requerido
link, o URL, para la imagen.string
height
requerido
height de la imagen en píxeles.integer
width
requerido
width de la imagen en píxeles.integer

ItemAttributes

object JSON que contiene datos de atributos de elementos de listados estructurados con clave por nombre de atributo.

Tipo : object

ItemIssues

Problemas asociados con el listings items.

Tipo : array

Issue

Un problema con un Item de las listas.

NombreDescripciónEsquema
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

ItemOffers

Detalles de la oferta para el listings items.

Tipo : array < ItemOfferByMarketplace >

ItemOfferByMarketplace

Detalles de la oferta de un listings item para un marketplace de Amazon.

NombreDescripciónEsquema
marketplaceId
requerido
Identificador del marketplace de Amazon.string
offerType
requerido
Tipo de oferta para el listings items.enum ( offerType )
price
requerido
Precio de compra del Item listadoMoney
points
opcional
La cantidad de Amazon Points ofrecidos con la compra de un Item y su valor monetario. Tenga en cuenta que el elemento Puntos solo se devuelve en Japón (JP).Points

ItemProcurement

Información de adquisición del vendor para el listings items.

NombreDescripciónEsquema
costPrice
requerido
El precio (valor numérico) que quieres que Amazon te pague por este producto.Money

FulfillmentAvailability

Detalles de disponibilidad de cumplimiento para el listings items.

NombreDescripciónEsquema
fulfillmentChannelCode
requerido
Designa qué red de cumplimiento se utilizará.string
quantity
opcional
La cantidad del Item que está poniendo a disposición para la venta.
Valor mínimo : 0
integer

Money

El tipo de moneda y la cantidad.

NombreDescripciónEsquema
currencyCode
requerido
Código de moneda de tres dígitos. En formato ISO 4217.string
amount
requerido
El monto de la moneda.Decimal

Decimal

Un número decimal sin pérdida de precisión. Útil cuando la pérdida de precisión es inaceptable, como ocurre con las monedas. Sigue RFC7159 para la representación de números.

Tipo : string

Points

La cantidad de Amazon Points ofrecidos con la compra de un Item y su valor monetario. Tenga en cuenta que el elemento Puntos solo se devuelve en Japón (JP).

NombreEsquema
pointsNumber
requerido
integer

PatchOperation

Operación de patch JSON individual para una solicitud HTTP PATCH.

NombreDescripciónEsquema
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.

NombreDescripciónEsquema
productType
requerido
El tipo de producto de Amazon del listings items.string
patches
requerido
Una o más operaciones de JSON Patch para realizar en el elemento de listados. array

ListingsItemPutRequest

El esquema del body de la solicitud para la operación putListingsItem.

NombreDescripciónEsquema
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.

NombreDescripciónEsquema
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

IncludedData

Tipo : enum

ValorDescripción
summariesResumen de los detalles del Item de la lista.
attributesobject JSON que contiene datos de atributo de elemento de listado estructurado con clave por nombre de atributo.
issuesProblemas asociados con el Item de la lista.
offersoffers actuales para el Item de la lista.
fulfillmentAvailabilityDetalles de disponibilidad de cumplimiento para el listings item.
procurementDetalles de adquisición del vendor para el listings item.

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

ValorDescripción
addLa operación "agregar" agrega o reemplaza la propiedad de destino.
replaceLa operación "reemplazar" agrega o reemplaza la propiedad de destino.
deleteLa operación "eliminar" elimina la propiedad de destino. No compatible con vendores (los vendores recibirán una respuesta de código de estado HTTP 400).

Severity

La gravedad del problema.

Tipo : enum

ValorDescripción
ERRORIndica que se ha producido un problema que impide que se procese el envío, como un error de validación.
WARNINGIndica que se ha producido un problema que debe revisarse, pero que no ha impedido que se procese el envío.
INFOIndica que se ha proporcionado información adicional que debe revisarse.

ConditionType

Identifica la condición del Item listado.

Tipo : enum

ValorDescripción
new_newNuevo
new_open_boxNuevo - Caja Abierta.
new_oemNuevo - OEM.
refurbished_refurbishedRenovar
used_like_newUsado - Como Nuevo.
used_very_goodUsado - Muy Bueno.
used_goodUsado - Bueno.
used_acceptableUsado - Aceptable.
collectible_like_newColeccionable - Como nuevo.
collectible_very_goodColeccionable - Muy bueno.
collectible_goodColeccionable - Bueno.
collectible_acceptableColeccionable - Aceptable.
club_clubClub

Requirements

El nombre de los requisitos establecidos para los datos proporcionados.

Tipo : enum

ValorDescripción
LISTINGIndica que los datos enviados contienen información sobre productos y condiciones de venta.
LISTING_PRODUCT_ONLYIndica que los datos enviados solo contienen información sobre el producto.
LISTING_OFFER_ONLYIndica que los datos enviados solo contienen términos de venta. No compatible con vendores (los vendores recibirán una respuesta de código de estado HTTP 400).

OfferType

Tipo de oferta para el listings items.

Tipo : enum

ValorDescripción
B2CLa oferta de este listings items está disponible para la compra de empresa a consumidor, lo que significa que está disponible para los compradores en los sitios minoristas de Amazon.
B2BLa oferta en este listings items está disponible para la compra de empresa a empresa.

Status

Tipo : enum

Para usar con la(s) definición(es): ItemSummaryByMarketplace

ValorDescripción
BUYABLELos compradores pueden comprar el Item de los listados. Este estado no se aplica a los listados de vendores.
DISCOVERABLEEl listings items es visible para los compradores.

Para usar con la(s) definición(es): ListingsItemSubmissionResponse
El estado del envío del listings items.

ValorDescripción
ACCEPTEDEl envío de listados fue aceptado para su procesamiento.
INVALIDEl envío de listados no era válido y no fue aceptado para su procesamiento.