Guía de casos de uso de Easy Ship API v2022-03-23

Cómo utilizar la Easy Ship API.

Versión de la API: v2022-03-23

¿Cuál es el Easy Ship API?

La Selling Partner API para facilitar la Nave le permite crear aplicaciones para los sellers para gestionar y enviar paquetes de Amazon Easy Ship orders.

Características Clave

Conseguir espacios de tiempo disponibles.
Programar y reprogramar Easy Ship packages para Easy Ship orders.
Impresión de etiquetas de envío, facturas y documentos de garantía.

Tutorial: Programar una Easy Ship package

Este tutorial sirve como una guía sobre cómo usar la Easy Ship API para programar un paquete para un Easy Ship order.

Paso 1. Conseguir espacios de tiempo disponibles

Llame a la operación listHandoverSlots para obtener una lista de espacios de tiempo disponibles para Easy Ship order no programada. Asegúrese de lo siguiente:

El Amazon Order Id especificado debe ser un order de Easy Ship y estar sin enviar.
La solicitud debe incluir el peso deseado y dimensiones del paquete.

No Easy Ship orders y los orders en estado Pendiente devolverá una respuesta de error.

Pedido

Llame a la operación listHandoverSlots.

Ejemplo de solicitud:

POST https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/timeSlot
{
  "amazonOrderId": "933-1443575-9112638",
  "marketplaceId": "A21TJRUUN4KGV",
  "packageDimensions": {
    "length": 20.0,
    "width": 10.0,
    "height": 12.0,
    "unit": "Cm",
    "identifier": "test"
  },
  "packageWeight": {
    "value": 100.0,
    "unit": "G"
  }
}

Respuesta

Una respuesta correcta incluye la lista de espacios de tiempo disponibles. Cada ranura de tiempo se especifica el método por el cual el seller tiene que entregar el paquete a un Amazon transportista. Ver apoyó la entrega de métodos para obtener más detalles. Asegúrese de guardar el slotId, startTime, y endTime de la ranura deseada para el siguiente paso.

Respuesta ejemplo:

{
  "amazonOrderId": "933-1443575-9112638",
  "timeSlots": [
    {
      "handoverMethod": "Pickup",
      "slotId": "AQc48yxSAAAAADZG0qQAAAAA6kkAAAAAAAA=",
      "startTime": "2022-03-09T23:30:00Z",
      "endTime": "2022-03-10T02:00:00Z"
    },
    {
      "handoverMethod": "Pickup",
      "slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
      "startTime": "2022-03-10T02:00:00Z",
      "endTime": "2022-03-10T04:30:00Z"
    }
  ]
}

Paso 2. Crear una Easy Ship package

Llame a la operación createScheduledPackage para crear un paquete para una Easy Ship order no programada. Asegúrese de lo siguiente:

El Amazon Order Id especificado debe ser un order de Easy Ship y estar sin enviar.
La solicitud debe incluir el peso deseado y dimensiones del paquete.

No Easy Ship orders y los order en estado Pendiente devolverá una respuesta de error.

Pedido

Llame a la operación createScheduledPackage.

Ejemplo de solicitud:

POST https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/package
{
  "amazonOrderId": "933-1443575-9112638",
  "marketplaceId": "A21TJRUUN4KGV",
  "packageDetails": {
    "packageTimeSlot": {
      "slotId": "AQc48yxSAAAAADZG0qQAAAAA6kkAAAAAAAA=",
      "startTime": "2022-03-09T23:30:00Z",
      "endTime": "2022-03-10T02:00:00Z"
    }
  }
}

Respuesta

Una respuesta correcta incluye el paquete del peso y las dimensiones, detalles de factura (si está presente), el intervalo de tiempo seleccionados, y el estado del paquete.

Respuesta ejemplo:

{
  "packageDimensions": {
    "identifier": "test",
    "unit": "Cm",
    "length": 20,
    "width": 10,
    "height": 12
  },
  "packageWeight": {
    "unit": "G",
    "value": 50
  },
  "invoice": {
    "invoiceNumber": "IN-456",
    "invoiceDate": "1.636404098172E9"
  },
  "scheduledPackageId": {
    "amazonOrderId": "933-1443575-9112638",
    "packageId": "b4be5116-98b1-6f20-a47b-03de178cfb4f"
  },
  "packageStatus": "ReadyForPickup",
  "packageTimeSlot": {
    "slotId": "AQc48yxSAAAAADZG0qQAAAAA6kkAAAAAAAA=",
    "startTime": "2022-03-09T23:30:00Z",
    "endTime": "2022-03-10T02:00:00Z"
  },
  "trackingDetails": {
    "trackingId": "2045079155"
  }
}

Tutorial: reprogramar un Easy Ship package

Este tutorial sirve como una guía sobre cómo usar la Easy Ship API para programar un paquete para una Easy Ship order. Actualmente solo se permitirá un seller para actualizar el intervalo de tiempo seleccionados para un Easy Ship package. Para ambas operaciones en este tutorial, el especificado Amazon Order Id ya debe haber sido programada y el Easy Ship package debe estar en un estado válido. Ver Tutorial: Comprobar el estado de una Easy Ship package para obtener más detalles.

Paso 1. Conseguir espacios de tiempo disponibles para reprogramar

Llame a la operación listHandoverSlots para obtener una lista de espacios de tiempo disponibles para un Easy Ship order programado.

Pedido

Llame a la operación listHandoverSlots.

Ejemplo de solicitud:

POST https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/timeSlot
{
  "amazonOrderId": "933-1443575-9112638",
  "marketplaceId": "A21TJRUUN4KGV",
  "packageDimensions": {
    "length": 20.0,
    "width": 10.0,
    "height": 12.0,
    "unit": "Cm",
    "identifier": "test"
  },
  "packageWeight": {
    "value": 100.0,
    "unit": "G"
  }
}

Respuesta

Una respuesta correcta incluye la lista de espacios de tiempo disponibles. Asegúrese de guardar el slotId, startTime, y endTime de la ranura deseada para el siguiente paso.

Respuesta ejemplo:

{
  "amazonOrderId": "933-1443575-9112638",
  "timeSlots": [
    {
      "handoverMethod": "Pickup",
      "slotId": "AQc48yxSAAAAADZG0qQAAAAA6kkAAAAAAAA=",
      "startTime": "2022-03-09T23:30:00Z",
      "endTime": "2022-03-10T02:00:00Z"
    },
    {
      "handoverMethod": "Pickup",
      "slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
      "startTime": "2022-03-10T02:00:00Z",
      "endTime": "2022-03-10T04:30:00Z"
    }
  ]
}

Paso 2. Actualización Easy Ship package

Llame a la operación updateScheduledPackages de actualización de la ranura de tiempo para un Easy Ship package.

Pedido

Llame a la operación updateScheduledPackages.

Ejemplo de solicitud:

PATCH https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/package
{
  "marketplaceId":"A21TJRUUN4KGV",
  "updatePackageDetailsList":[
    {
      "scheduledPackageId":{
        "amazonOrderId":"933-1443575-9112638",
        "packageId":"b4be5116-98b1-6f20-a47b-03de178cfb4f"
      },
      "packageTimeSlot":{
        "slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
        "startTime": "2022-03-10T02:00:00Z",
        "endTime": "2022-03-10T04:30:00Z"
      }
    }
  ]
}

Respuesta

Una respuesta correcta incluye los detalles de paquete y la actualización de la ranura de tiempo.

Respuesta ejemplo:

{
  "packages": [
    {
      "packageDimensions": {
        "identifier": "test",
        "unit": "Cm",
        "length": 20,
        "width": 10,
        "height": 12
      },
      "packageWeight": {
        "unit": "G",
        "value": 50
      },
      "invoice": {
        "invoiceNumber": "IN-456",
        "invoiceDate": "1.636404098172E9"
      },
      "scheduledPackageId": {
        "amazonOrderId": "933-1443575-9112638",
        "packageId": "b4be5116-98b1-6f20-a47b-03de178cfb4f"
      },
      "packageStatus": "ReadyForPickup",
      "packageTimeSlot": {
        "slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
        "startTime": "2022-03-10T02:00:00Z",
        "endTime": "2022-03-10T04:30:00Z"
      },
      "trackingDetails": {
        "trackingId": "2045079155"
      }
    }
  ]
}

Tutorial: Comprobar el estado de una Easy Ship package

Este tutorial sirve como una guía sobre cómo usar la Easy Ship API para comprobar el estado de una Easy Ship package. Esta operación permite a un seller para ver el especificado el peso, las dimensiones, la ranura de tiempo, y otros detalles de una Easy Ship package.

El estado de un paquete se actualiza a medida que se producen eventos para el paquete. Los ejemplos de algunos de tales eventos incluyen

Un paquete es entregado a un Amazon transportista.
Un paquete ha sido entregado a un comprador.
Un paquete ha sido cancelado.
Un paquete se pierde en el tránsito.

Es útil para comprobar el estado actual de un paquete antes de reprogramación debido a que los paquetes no pueden ser cambiadas después de haber sido entregado a un Amazon transportista. La reprogramación de las operaciones de un error con el InvalidOrderState código si se intenta en un Easy Ship package en un estado no válido. A ver packageStatus para todos los diferentes estados de un paquete.

Paso 1. Obtener una Easy Ship package

Llame a la operación getScheduledPackage para obtener los detalles de un Easy Ship package.

Pedido

Llame a la operación getScheduledPackage.

Ejemplo de solicitud:

GET https://sellingpartnerapi-eu.amazon.com/easyShip/2022-03-23/package?marketplaceId=A21TJRUUN4KGV&amazonOrderId=933-6451079-5067861

Respuesta

Una respuesta correcta incluye los detalles del paquete.

Respuesta ejemplo:

{
  "packageDimensions":{
    "unit":"Cm",
    "length":20,
    "width":10,
    "height":12
  },
  "packageWeight":{
    "unit":"G",
    "value":50
  },
  "invoice":{
    "invoiceNumber":"IN-442"
  },
  "scheduledPackageId":{
    "amazonOrderId":"933-6451079-5067861",
    "packageId":"88be1771-923c-d581-5e29-e8a310916185"
  },
  "packageStatus":"ReadyForPickup",
  "packageTimeSlot":{
    "slotId": "AQef4K2CAAAAAGdIAEAAAAAA6kkAAAAAAAA=",
    "startTime": "2022-03-10T02:00:00Z",
    "endTime": "2022-03-10T04:30:00Z"
  },
  "trackingDetails": {
    "trackingId": "2045079155"
  }
}

Cómo manejar el order items que requieren los números de serie

Algunos de los artículos en Amazon Easy Ship fin de exigir a los números de serie que Amazon se puede generar en los documentos de garantía para ellos. El uso de la operación getOrderItems para averiguar qué elementos requieren números de serie.

Paso 1. Obtener la lista de los orders que requieren números de serie

Llame a la operación getOrderItems, especificando la Amazon Order ID por el order en el que desea crear un paquete programado.

Amazon devuelve los elementos en order, marcando los elementos que requieren de un número de serie con SerialNumberRequired=true.

Paso 2. Programación Easy Ship packages con números de serie

Llame a la operación createScheduledPackage, utilizando PackageItems para especificar los números de serie de todos los elementos marcados SerialNumberRequired=true en el Paso 1. No se especifican los números de serie de los artículos marcados con SerialNumberRequired=false.

Amazon genera documentos de garantía para los artículos que especifica los números de serie. Para obtener información acerca de cómo obtener los documentos que Amazon se genera cuando se crea un paquete programado, consulte Cómo obtener la factura, la etiqueta de envío, y los documentos de garantía.

Cómo obtener etiquetas de envío, facturas y documentos de garantía

Amazon se genera una factura cuando un comprador hace un Amazon Easy Ship order en la India. Cuando se llama a la operación CreateScheduledPackage para programar una Amazon Easy Ship de la ranura de tiempo de la order, Amazon genera una etiqueta de envío. Si se incluyen los números de serie de los artículos que especifique en su llamada CreateScheduledPackage, Amazon también genera los documentos de garantía para los artículos. En este tema se explica cómo obtener las facturas, etiquetas de envío, y la garantía por la programada Amazon Easy Ship orders.

Paso 1. Enviar una Easy Ship Feed Solicitud

Presentar una Feed solicitud para solicitar los documentos para su Easy Ship orders. Una vez que una Feed solicitud ha sido procesado con éxito, puede descargar el report de procesamiento para obtener el report de referencia de identificación. Esto puede ser utilizado en el próximo paso para descargar el solicitado Easy Ship documents.

Siga el Tutorial: Someter un Feed a presentar una Easy Ship feed. El tutorial explica todos los pasos desde la presentación de la feed document para la verificación de la feed solicitud ha sido completada con éxito.

FeedContent. Uso EasyshipDocuments.xsd para formar el contenido del feed document. A continuación verá un ejemplo.
FeedType. Especificar POST_EASYSHIP_DOCUMENTS cuando se llama a la operación createFeed.
ReportReferenceId. Si no hay ningún error en el proceso de Feed report, el valor devuelto puede ser utilizado en el siguiente paso. A continuación verá un ejemplo.

Ejemplo de Easy Ship Feed de documentos:

  <?xml version="1.0" encoding="utf-8" ?>
  <AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
    <Header>
      <DocumentVersion>1.01</DocumentVersion>
      <MerchantIdentifier>ABCDEFG007V</MerchantIdentifier>
    </Header>
    <MessageType>EasyShipDocument</MessageType>
    <Message>
      <MessageID>1</MessageID>
      <EasyShipDocument>
        <AmazonOrderID>933-6451079-5067861</AmazonOrderID>
        <DocumentType>ShippingLabel</DocumentType>
        <DocumentType>Invoice</DocumentType>
        <DocumentType>Warranty</DocumentType>
      </EasyShipDocument>
    </Message>
  </AmazonEnvelope>

Ejemplo de report de procesamiento de Easy Ship Feed:

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <EasyShipProcessingReport>
    <FeedSubmissionID>98765432100</FeedSubmissionID>
    <MessagesProcessed>1</MessagesProcessed>
    <MessagesSuccessful>1</MessagesSuccessful>
    <MessagesWithError>0</MessagesWithError>
    <DocumentReportReferenceID>123456789000</DocumentReportReferenceID>
  </EasyShipProcessingReport>

Paso 2. Consigue el PDF

Obtener un archivo PDF que contiene la factura, la etiqueta de envío, y la garantía (si está disponible) documentos para la Amazon Easy Ship order.

Llame a la operación getReport. Cuando se especifica el reportId parámetro, utilice el ReportReferenceId valor desde el Paso 1. Enviar una solicitud Easy Ship Feed .

La operación devuelve un valor reportDocumentId que puede pasar en la getReportDocument en el siguiente paso.
Llame a la operación getReportDocument, especificando la operación reportDocumentId del paso anterior. Ver Recuperar un report para más detalles.

Marketplace de apoyo

Easy Ship operations son sólo disponible en algunos marketplaces y de apoyo para operaciones específicas varía en cada marketplace. Consulte la tabla siguiente para las operaciones de marketplace.

Soporte del Marketplace

marketplace	Región	Apoyó La Entrega De Los Métodos De	Obtener Ranuras De Tiempo	Crear Paquete	Paquete De Actualización	Obtener El Estado Del paquete	La Etiqueta De Envío	Factura	Garantía
México	NA	Recogida sólo	Sólo para Orders no programados	Compatible	No Se Admite	Compatible	Compatible	No Se Admite	No Se Admite
La India	La UE	Recogida sólo	Programado & Orders No Programados	Compatible	Compatible	Compatible	Compatible	Compatible	Compatible
Turquía	La UE	Pickup & Al	Sólo para Orders no programados	Compatible	No Se Admite	Compatible	Compatible	No Se Admite	No Se Admite
Australia	FE	Recogida sólo	Sólo para Orders no programados	Compatible	No Se Admite	Compatible	Compatible	No Se Admite	No Se Admite
Singapur	FE	Recogida sólo	Sólo para Orders no programados	Compatible	No Se Admite	Compatible	Compatible	No Se Admite	No Se Admite

Updated over 1 year ago