Referencia de Product Type Definitions API v2020-09-01
Acceso programático a atributos y requisitos de datos para Product Type en el catálogo de Amazon.
Descripción general
La Selling Partner API para definiciones de tipos de productos proporciona acceso programático a atributos y requisitos de datos para tipos de productos en el catálogo de Amazon. Use esta API para devolver el esquema JSON para un tipo de producto que luego puede usar con otras Selling Partner API , como la Selling Partner API para artículos de listados, la Selling Partner API para artículos de catálogo y la Selling Partner API para feeds (para feeds de listas basados en JSON).
Para obtener más información, consulte la Guía de casos de uso de Product Type Definitions 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
searchDefinitionsProductTypes
getDefinitionsProductType
Caminos
GET /definitions/2020-09-01/productTypes
Operación: searchDefinitionsProductTypes
Descripción
Busque y devuelva una lista de tipos de productos de Amazon que tengan definiciones disponibles.
Planes de uso:
| tipo de plan | Tasa (solicitudes por segundo) | Explosión |
|---|---|---|
| Default | 5 | 10 |
| Selling partner specific | Variable | Variable |
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. Los límites de tarifas para algunos selling partners variarán de la tarifa predeterminada y la ráfaga que se muestra en la tabla anterior. Para obtener más información, consulte Planes de uso y límites de tarifas en la API de Selling Partner .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Query | keywords opcional | Una lista delimitada por comas de palabras clave para buscar tipos de productos. | array (csv) |
| Query | marketplaceIds requerido | Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. | array (csv) |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Se recuperó con éxito una lista de tipos de productos de Amazon que tienen definiciones disponibles. 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. | ProductTypeList |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : 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 .
consume
application/json
produce
application/json
GET /definitions/2020-09-01/productTypes/{productType}
Operación: getDefinitionsProductType
Descripción
Recuperar una definición de tipo de producto de Amazon.
Planes de uso:
| tipo de plan | Tasa (solicitudes por segundo) | Explosión |
|---|---|---|
| Default | 5 | 10 |
| Selling partner specific | Variable | Variable |
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. Los límites de tarifas para algunos selling partners variarán de la tarifa predeterminada y la ráfaga que se muestra en la tabla anterior. Para obtener más información, consulte Planes de uso y límites de tarifas en la API de Selling Partner .
Parámetros
| Tipo | Nombre | Descripción | Esquema | Por defecto |
|---|---|---|---|---|
| Path | productType requerido | El nombre del tipo de producto de Amazon. | string | - |
| Query | sellerId opcional | Un identificador de selling partner. Cuando se proporcionan, los requisitos y valores específicos del seller se completan dentro del esquema de definición del tipo de producto, como las marcas asociadas con el selling partner. | string | - |
| Query | marketplaceIds requerido | Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. Nota: este parámetro está limitado a un ID de marketplace en este momento. | array (csv) | - |
| Query | productTypeVersion opcional | La versión del tipo de producto de Amazon que se va a recuperar. El valor predeterminado es "LATEST",. Las versiones preliminares de las definiciones de tipo de producto se pueden recuperar con "RELEASE_CANDIDATE". Si no hay una versión preliminar disponible actualmente, se proporcionará la versión en vivo "LATEST". | string | "LATEST" |
| Query | requirements opcional | El nombre del conjunto de requisitos para recuperar los requisitos. | enum ( Requirements ) | "LISTING" |
| Query | requirementsEnforced opcional | Identifica si el esquema de definición de tipo de producto impone los atributos requeridos para un conjunto de requisitos. Los requisitos no aplicados permiten la validación estructural de atributos individuales sin que todos los atributos requeridos estén presentes (como para actualizaciones parciales). | enum ( RequirementsEnforced ) | "ENFORCED" |
| Query | locale opcional | Configuración regional para recuperar etiquetas de visualización y otros detalles de presentación. El valor predeterminado es el idioma predeterminado del primer marketplace en la solicitud. | enum ( Locale ) | "DEFAULT" |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Se recuperó con éxito una definición de tipo de producto de Amazon. 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. | ProductTypeDefinition |
| 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. | ErrorList |
Para códigos de estado de error, descripciones y esquemas adicionales, 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. | ErrorList |
| 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. | 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): identificador de referencia de solicitud único. | 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): identificador de referencia de solicitud único. | ErrorList |
| 415 | La payload 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. | 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): identificador de referencia de solicitud único. | 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): identificador de referencia de solicitud único. | ErrorList |
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 |
ErrorList
Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.
SchemaLink
| Nombre | Descripción | Esquema |
|---|---|---|
| link requerido | Link para recuperar el esquema. | link |
| checksum requerido | Hash de suma de comprobación del esquema (Base64 MD5). Se puede usar para verificar el contenido del esquema, identificar cambios entre versiones del esquema y para el almacenamiento en caché. | string |
Link
| Nombre | Descripción | Esquema |
|---|---|---|
| resource requerido | Recurso URI para el Link. | string |
| verb requerido | Método HTTP para la operación de Link. | enum ( Verb ) |
ProductTypeDefinition
Una definición de tipo de producto representa los atributos y requisitos de datos para un tipo de producto en el catálogo de Amazon. Las definiciones de tipo de producto se usan indistintamente entre la Selling Partner API para elementos de listados, la Selling Partner API para elementos de catálogo y los feeds de listados basados en JSON en la Selling Partner API para feeds.
| Nombre | Descripción | Esquema |
|---|---|---|
| metaSchema opcional | Link al metaesquema que describe el vocabulario utilizado por el esquema de tipo de producto. | SchemaLink |
| schema requerido | Link al esquema que describe los atributos y requisitos para el tipo de producto. | SchemaLink |
| requirements requerido | Nombre del conjunto de requisitos representado en esta definición de tipo de producto. | enum ( Requirements ) |
| requirementsEnforced requerido | Identifica si el esquema de definición de tipo de producto impone los atributos requeridos para un conjunto de requisitos. Los requisitos no aplicados permiten la validación estructural de atributos individuales sin que todos los atributos requeridos estén presentes (como para actualizaciones parciales). | enum ( RequirementsEnforced ) |
| propertyGroups requerido | Asignación de nombres de grupos de propiedades a grupos de propiedades. Los grupos de propiedades representan agrupaciones lógicas de propiedades de esquema que se pueden utilizar con fines informativos o de visualización. | < string, PropertyGroup > mapa |
| locale requerido | Configuración regional de los elementos de visualización contenidos en la definición del tipo de producto. | string |
| marketplaceIds requerido | Identificadores del marketplace de Amazon para los que se aplica la definición de tipo de producto. | < string > array |
| tipo de producto requerido | El nombre del tipo de producto de Amazon al que se aplica esta definición de tipo de producto. | string |
| productType requerido | Los detalles de la versión para el tipo de producto de Amazon. | ProductTypeVersion |
PropertyGroup
Un grupo de propiedades representa una agrupación lógica de propiedades de esquema que se pueden utilizar con fines informativos o de visualización.
| Nombre | Descripción | Esquema |
|---|---|---|
| title opcional | La etiqueta de visualización del grupo de propiedades. | string |
| description opcional | La descripción del grupo de propiedades. | string |
| propertyNames opcional | Los nombres de las propiedades de esquema para el grupo de propiedades. | < string > array |
ProductTypeVersion
Los detalles de la versión para un tipo de producto de Amazon.
| Nombre | Descripción | Esquema |
|---|---|---|
| version requerido | Identificador de versión. | string |
| latest requerido | Cuando es verdadero, la versión indicada por el identificador de versión es la última disponible para el tipo de producto de Amazon. | booleano |
| releaseCandidate opcional | Cuando es verdadero, la versión indicada por el identificador de versión es la versión preliminar (candidato de lanzamiento) para el tipo de producto de Amazon. | booleano |
ProductType
Un tipo de producto de Amazon con una definición disponible.
| Nombre | Descripción | Esquema |
|---|---|---|
| name requerido | El nombre del tipo de producto de Amazon. | string |
| marketplaceIds requerido | Los identificadores del marketplace de Amazon para los que está disponible la definición del tipo de producto. | < string > array |
ProductTypeList
Una lista de tipos de productos de Amazon con definiciones disponibles.
| Nombre | Esquema |
|---|---|
| productTypes requerido | < ProductType > array |
Locale
Configuración regional para recuperar etiquetas de visualización y otros detalles de presentación. El valor predeterminado es el idioma predeterminado del primer marketplace en la solicitud.
Tipo : enum
| Valor | Descripción |
|---|---|
| DEFAULT | Configuración regional predeterminada del marketplace de Amazon solicitado. |
| ar | Arábica |
| ar_AE | Árabe (EAU) |
| de | Alemán |
| de_DE | Alemán (Alemania) |
| en | Inglés |
| en_AE | Inglés (EAU) |
| en_AU | Inglés (Australia) |
| en_CA | Inglés (Canadá) |
| en_GB | Inglés (reino unido) |
| en_IN | Inglés (India) |
| en_SG | Inglés (Singapur) |
| en_US | Inglés (Estados Unidos) |
| es | Español |
| es_ES | Español (España) |
| es_MX | Español (México) |
| es_US | Español (Estados Unidos) |
| fr | Francés |
| fr_CA | Francés (Canadá) |
| fr_FR | Francés (Francia) |
| it | italiano |
| it_IT | italiano (Italia) |
| ja | japonés |
| ja_JP | Japonés (Japón) |
| nl | Holandés |
| nl_NL | Holandés (Países Bajos) |
| pl | Polaco |
| pl_PL | Polaco (Polonia) |
| pt | portugués |
| pt_BR | Portugués (Brasil) |
| pt_PT | Portugués (Portugal) |
| sv | sueco |
| sv_SE | Sueco (Suecia) |
| tr | turco |
| tr_TR | Turco (Turquía) |
| zh | Chino |
| zh_CN | Chino (simplificado) |
| zh_TW | Chino (tradicional) |
Verb
Método HTTP para la operación de Link.
Tipo : enum
| Valor | Descripción |
|---|---|
| GET | Se accede al recurso proporcionado con el método HTTP GET. |
RequirementsEnforced
Tipo : enum
Para usar con la(s) definición(es): ProductTypeDefinition
Identifica si el esquema de definición de tipo de producto impone los atributos requeridos para un conjunto de requisitos. Los requisitos no aplicados permiten la validación estructural de atributos individuales sin que todos los atributos requeridos estén presentes (como para actualizaciones parciales).
| Valor | Descripción |
|---|---|
| ENFORCED | Solicite el esquema con los atributos requeridos y requeridos condicionalmente aplicados (usado para la validación completa de la payload). |
| NOT_ENFORCED | Esquema de solicitud con atributos requeridos y requeridos condicionalmente no aplicados (usado para validación de payload parcial, como para atributos únicos). |
Para usar con la(s) operación(es): getDefinitionsProductType
Identifica si el esquema de definición de tipo de producto impone los atributos requeridos para un conjunto de requisitos. Los requisitos no aplicados permiten la validación estructural de atributos individuales sin que todos los atributos requeridos estén presentes (como para actualizaciones parciales).
| Valor | Descripción |
|---|---|
| ENFORCED | Solicite el esquema con los atributos requeridos y requeridos condicionalmente aplicados (usado para la validación completa de la payload). |
| NOT_ENFORCED | Esquema de solicitud con atributos requeridos y requeridos condicionalmente no aplicados (usado para validación de payload parcial, como para atributos únicos). |
Requirements
Tipo : enum
Para usar con la(s) definición(es): ProductTypeDefinition
Nombre del conjunto de requisitos representado en esta definición de tipo de producto.
| 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. |
Para usar con la(s) operación(es): getDefinitionsProductType
El nombre del conjunto de requisitos para recuperar los requisitos.
| 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. |
Updated over 1 year ago