Guía de casos de uso de FBA Small and Light API

Cómo utilizar la FBA Small and Light API

Versión API: v1

¿Qué es la Small and Light API?

La API Small and Light permite a los desarrolladores acceder al programa Small and Light FBA. Puede utilizar la API para:

  • Determine si un seller SKU es elegible para el programa Small and Light.
  • Determine si un seller SKU está inscrito en el programa Small and Light.
  • Inscriba un seller SKU en el programa.
  • Cancele la inscripción de un seller SKU del programa.

Esta API no admite la consulta de varios marketplaces en la misma solicitud. Si se proporcionan varios marketplaces en la solicitud, la API seleccionará el primer marketplace de la lista.

Terminología

  • SKU : Unidad de mantenimiento de existencias. Identifica la lista de un seller para un ASIN en un marketplace determinado.

requisitos previos

Para completar cualquiera de los tutoriales necesitarás:

Tutorial: Comprobar la elegibilidad de un seller SKU para el programa Small and Light

Este tutorial le muestra cómo averiguar si un seller SKU es elegible para inscribirse en el programa Small and Light para un marketplace determinado. Si un seller SKU no es elegible para el programa, las respuestas de error indicarán los motivos de no elegibilidad. Para inscribir un seller SKU en el programa Small and Light, vaya a Tutorial: Inscríbase en el programa Small and Light .

requisitos previos

Para completar este tutorial necesitarás:

Obtenga la elegibilidad de SKU del seller para el programa Small and Light

Llama la operacióngetSmallAndLightEligibilityBySellerSKU pasando los siguientes parámetros:

ParámetroDescripciónRequerido
marketplaceIdsEl marketplace para el que se recupera el estado de elegibilidad. Nota : solo acepta un único marketplace.

Número máximo: 1

Tipo:< string > array
sellerSKUEl SKU del seller que identifica el artículo.

Tipo: string

Ejemplo de solicitud

GET https://sellingpartnerapi-na.amazon.com/fba/smallAndLight/v1/eligibilities/exampleSellerSKU?marketplaceIds= ATVPDKIKX0DER 

Respuesta

Una respuesta exitosa tiene el código 200 e incluye los objetos a continuación.

NombreDescripciónRequerido
marketplaceIdUn identificador de marketplace.

Tipo: MarketplaceId
sellerSKUIdentifica un artículo en el marketplace dado. SellerSKU está calificado por el seller SellerId, que se incluye con cada operación que envíe.

Tipo: SellerSku
statusEl estado de elegibilidad de artículos Small and Light.

Tipo: SmallAndLightEligibilityStatus

Una respuesta fallida tiene un código que no es 2xx e incluye los objetos a continuación. Si el SKU del seller no es elegible para el programa, una respuesta 404 proporcionará los errores de no elegibilidad.

NombreDescripciónRequerido
errorsNo se determinó la razón por la cual la solicitud falló y la elegibilidad para el programa.

Tipo: array
Error
NombreDescripciónRequerido
codeUn código de error que identifica el tipo de error que ocurrió.

Tipo: string
messageUn mensaje que describe la condición de error en un formato legible por humanos.

Tipo: string
detailsInformación adicional que puede ayudar a la persona que llama a comprender o solucionar el problema.

Tipo: string
No

Ejemplo de respuesta exitosa

HTTP/1.1 200 OK

{
  "marketplaceId": "ATVPDKIKX0DER",
  "sellerSKU": "exampleSellerSKU",
  "status": "ELIGIBLE"
}

Ejemplo de respuesta fallida

HTTP/1.1 404 Not Found

{
  "errors": [
    {
      "code": "INVALID_ASIN_PRICE",
      "message": "The product's selling price is too high."
    },
    {
      "code": "INVALID_PACKAGE_WEIGHT",
      "message": "The product's package weight does not meet the required criteria."
    }
  ]
}

Tutorial: comprobar si un seller SKU está inscrito en el programa Small and Light

Este tutorial le muestra cómo averiguar si un seller SKU está inscrito en el programa Small and Light para un marketplace determinado. Para inscribir un seller SKU en el programa Small and Light, vaya a Tutorial: Inscríbase en el programa Small and Light . Para cancelar la inscripción de un seller SKU del programa Small and Light, vaya a Tutorial: Cancelar la inscripción del programa Small and Light .

requisitos previos

Para completar este tutorial necesitarás:

Obtenga los detalles de inscripción de Small and Light para un seller SKU

Llama agetSmallAndLightEnrollmentBySellerSKU operación pasando los siguientes parámetros:

ParámetroDescripciónRequerido
marketplaceIdsEl marketplace para el que se recupera el estado de inscripción. Nota : solo acepta un único marketplace.

Recuento máximo: 1

Tipo: array
sellerSKUEl SKU del seller que identifica el artículo.

Tipo: string

Ejemplo de solicitud

GET https://sellingpartnerapi-na.amazon.com/fba/smallAndLight/v1/enrollments/exampleSellerSKU?marketplaceIds= ATVPDKIKX0DER

Respuesta

Una respuesta exitosa tiene el código 200 e incluye los objetos a continuación.

NombreDescripciónRequerido
marketplaceIdUn identificador de marketplace.

Tipo: MarketplaceId
sellerSKUIdentifica un artículo en el marketplace dado. SellerSKU está calificado por el seller SellerId, que se incluye con cada operación que envíe.

Tipo: SellerSKU
statusEl estado de registro de artículos Small and Light. del artículo.

Tipo: SmallAndLightEnrollmentStatus

Una respuesta fallida tiene un código que no es 2xx e incluye los objetos a continuación.

NombreDescripciónRequerido
errorsUna lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.

Tipo: array
No
Error
NombreDescripciónRequerido
codeUn código de error que identifica el tipo de error que ocurrió.

Tipo: string
messageUn mensaje que describe la condición de error en un formato legible por humanos.

Tipo: string
detailsInformación adicional que puede ayudar a la persona que llama a comprender o solucionar el problema.

Tipo: string
No

Ejemplo de respuesta exitosa

HTTP/1.1 200 OK

{
  "marketplaceId": "ATVPDKIKX0DER",
  "sellerSKU": "exampleSellerSKU",
  "status": "NOT_ENROLLED"
}

Ejemplo de respuesta fallida

HTTP/1.1 400 Not Found

{
  "errors": [
    {
      "code": "ServiceUnavailable",
      "message": "Service is temporarily unavailable."
    }
  ]
}

Tutorial: Inscríbase en el programa Small and Light

Este tutorial le muestra cómo inscribir un seller SKU en el programa Small and Light para un marketplace determinado. Para cancelar la inscripción de un seller SKU del programa Small and Light, vaya a Tutorial: Cancelar la inscripción del programa Small and Light .

requisitos previos

Para completar este tutorial necesitarás:

Inscriba un seller SKU en el programa Small and Light

Llama la operaciónputSmallAndLightEnrollmentBySellerSKU operación pasando los siguientes parámetros:

ParámetroDescripciónRequerido
marketplaceIdsEl marketplace en el que inscribir el artículo. Nota : solo acepta un único marketplace.

Número máximo: 1

Tipo: array
sellerSKUEl SKU del seller que identifica el artículo.

Tipo: string

Ejemplo de solicitud

PUT https://sellingpartnerapi-na.amazon.com/fba/smallAndLight/v1/enrollments/exampleSellerSKU?marketplaceIds= ATVPDKIKX0DER

Respuesta

Una respuesta exitosa tiene el código 200 e incluye los objetos a continuación.

NombreDescripciónRequerido
marketplaceIdUn identificador de marketplace.

Tipo: MarketplaceId
sellerSKUIdentifica un artículo en el marketplace dado. SellerSKU está calificado por el seller SellerId, que se incluye con cada operación que envíe.

Tipo: SellerSKU
statusEl estado de registro de artículos Small and Light. del artículo.

Tipo: SmallAndLightEnrollmentStatus

Una respuesta fallida tiene un código que no es 2xx e incluye los objetos a continuación. Una respuesta 404 proporcionará los errores de inelegibilidad, si los hubiere.

NombreDescripciónRequerido
errorsUna lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.

Tipo: array
No
Error
NombreDescripciónRequerido
codeUn código de error que identifica el tipo de error que ocurrió.

Tipo: string
messageUn mensaje que describe la condición de error en un formato legible por humanos.

Tipo: string
detailsInformación adicional que puede ayudar a la persona que llama a comprender o solucionar el problema.

Tipo: string
No

Ejemplo de respuesta exitosa

HTTP/1.1 200 OK

{
  "marketplaceId": "ATVPDKIKX0DER",
  "sellerSKU": "exampleSellerSKU",
  "status": "ENROLLED"
}

Ejemplo de respuesta fallida

HTTP/1.1 404 Not Found

{
  "errors": [
    {
      "code": "INVALID_ASIN_PRICE",
      "message": "The product's selling price is too high."
    },
    {
      "code": "INVALID_PACKAGE_WEIGHT",
      "message": "The product's package weight does not meet the required criteria."
    }
  ]
}

Tutorial: Darse de baja del programa Small and Light

Este tutorial le muestra cómo cancelar la inscripción de un seller SKU del programa Small and Light para un marketplace determinado. Para inscribir un seller SKU en el programa Small and Light, vaya a Tutorial: Inscríbase en el programa Small and Light .

requisitos previos

Para completar este tutorial necesitarás:

Eliminar un seller SKU del programa Small and Light

Llama la operacióndeleteSmallAndLightEnrollmentBySellerSKU pasando los siguientes parámetros:

ParámetroDescripciónRequerido
marketplaceIdsEl marketplace en el que eliminar el artículo del programa Small and Light. Nota : solo acepta un único marketplace.

Número máximo: 1

Tipo: array
sellerSKUEl SKU del seller que identifica el artículo.

Tipo: string

Ejemplo de solicitud

DELETE https://sellingpartnerapi-na.amazon.com/fba/smallAndLight/v1/enrollments/exampleSellerSKU?marketplaceIds= ATVPDKIKX0DER

Respuesta

Una respuesta exitosa tiene el código 204 con un cuerpo de respuesta vacío. Una respuesta fallida tiene un código que no es 2xx e incluye los objetos a continuación.

NombreDescripciónRequerido
errorsUna lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.

Tipo: array
No
Error
NombreDescripciónRequerido
codeUn código de error que identifica el tipo de error que ocurrió.

Tipo: string
messageUn mensaje que describe la condición de error en un formato legible por humanos.

Tipo: string
detailsInformación adicional que puede ayudar a la persona que llama a comprender o solucionar el problema.

Tipo: string
No

Ejemplo de respuesta exitosa

HTTP/1.1 204 OK

{
}

Ejemplo de respuesta fallida

HTTP/1.1 400 Not Found

{
  "errors": [
    {
      "code": "ServiceUnavailable",
      "message": "Service is temporarily unavailable."
    }
  ]
}