Referencia de Easy Ship API v2022-03-23
Ayude a los sellers a administrar y enviar Amazon Easy Ship orders.
Descripción general
La Selling Partner AP para Easy Ship lo ayuda a crear aplicaciones que ayudan a los sellers a administrar y enviar pedidos de Amazon Easy Ship.
Sus aplicaciones Easy Ship pueden:
- Obtenga franjas horarias disponibles para programar la entrega de los paquetes.
- Programe, reprograme y cancele Easy Ship orders.
- Imprime etiquetas, facturas y garantías.
Consulte la tabla de soporte del marketplace para conocer las diferencias en las operaciones de Easy Ship por marketplace.
Información de versión
Versión : 2022-03-23
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
listHandoverSlots
getScheduledPackage
createScheduledPackage
updateScheduledPackages
createScheduledPackageBulk
Rutas
POST /easyShip/2022-03-23/timeSlot
Operación: listHandoverSlots
Descripción
Devuelve los intervalos de tiempo disponibles para que los Easy Ship orders se programen en función del peso y las dimensiones del paquete que especifica el seller.
Esta operación está disponible para pedidos programados y no programados según el soporte del marketplace. Consulte Obtener franjas horarias en la tabla de soporte del Marketplace .
Esta operación puede devolver intervalos de tiempo que tienen métodos de transferencia de recogida o entrega; consulte Métodos de transferencia admitidos en la Tabla de soporte de Marketplace .
Plan de uso:
| Tasa (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit El header de respuesta 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 burst para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y burst 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 Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Body | ListHandoverSlotsRequest opcional | El esquema de solicitud para la operación listHandoverSlots. | ListHandoverSlotsRequest |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 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. | ListHandoverSlotsRequest |
| 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 |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. 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 |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : 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-RequestId (string) : Identificador de referencia de solicitud único. | ErrorList |
| 503 | Sobrecarga temporal o mantenimiento del servidor. 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 .
GET /easyShip/2022-03-23/package
Operación: getScheduledPackage
Descripción
Devuelve información sobre un paquete, incluidas las dimensiones, el peso, la información del intervalo de tiempo para la entrega, la información de la factura y el artículo, y el estado.
Plan de uso:
| Tasa (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit El header de respuesta 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 burst para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y burst 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 Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Query | amazonOrderId requerido | Un identificador de pedido definido por Amazon. Identifica el pedido que el seller quiere entregar usando Amazon Easy Ship. minLongitud : 1 longitud máxima : 255 | string |
| Query | marketplaceId requerido | Un identificador del marketplace en el que vende el seller. minLongitud : 1 longitud máxima : 255 | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 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. | Package |
| 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 |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. 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 |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : 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-RequestId (string) : Identificador de referencia de solicitud único. | ErrorList |
| 503 | Sobrecarga temporal o mantenimiento del servidor. 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 .
POST /easyShip/2022-03-23/package
Operación: createScheduledPackage
Descripción
Programa un Easy Ship order y devuelve la información del paquete programado.
Esta operación hace lo siguiente:
- Especifica el intervalo de tiempo y el método de entrega para programar la entrega del pedido.
- Actualiza el estado del Easy Ship order.
- Genera una etiqueta de envío y una factura. Vocación
createScheduledPackagetambién genera un documento de garantía si especifica un valorSerialNumber. Para obtener estos documentos, consulte Cómo obtener facturas, etiquetas de envío y documentos de garantía . - Muestra el estado de los Easy Ship orders cuando llama al funcionamiento
getOrdersde la Selling Partner API para pedidos y examinar laEasyShipShipmentStatuspropiedad en el body de respuesta.
Consulte las columnas Etiqueta de envío , Factura y Garantía en la Tabla de soporte del marketplace para ver qué documentos son compatibles en cada marketplace.
Plan de uso:
| Tasa (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit El header de respuesta 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 burst para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y burst 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 Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Body | CreateScheduledPackageRequest requerido | El esquema de solicitud para la operación createScheduledPackage. | CreateScheduledPackageRequest |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 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. | Package |
| 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 |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. 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 |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : 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-RequestId (string) : Identificador de referencia de solicitud único. | ErrorList |
| 503 | Sobrecarga temporal o mantenimiento del servidor. 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 .
PATCH /easyShip/2022-03-23/package
Operación: updateScheduledPackages
Descripción
Actualiza la franja horaria de entrega del paquete indicada por el especificado scheduledPackageId. Puede obtener el nuevo valor slotId de la franja horaria llamando al operación listHandoverSlots antes de realizar otra llamada patch.
Consulte la columna Paquete de actualización en la tabla de soporte del marketplace para ver en qué marketplaces se admite esta operación.
Plan de uso:
| Tasa (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit El header de respuesta 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 burst para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y burst 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 Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Body | Solicitud de actualización de paquetes programados opcional | El esquema de solicitud para la operación updateScheduledPackages. | Solicitud de actualización de paquetes programados |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Success 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. | Paquetes |
| 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 |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. 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 |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : 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-RequestId (string) : Identificador de referencia de solicitud único. | ErrorList |
| 503 | Sobrecarga temporal o mantenimiento del servidor. 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 .
POST /easyShip/2022-03-23/packages/bulk
Operación: createScheduledPackageBulk
Descripción
Esta operación programa automáticamente una franja horaria para todos los amazonOrderIdse proporciona como entrada, generando las etiquetas de envío asociadas, junto con otros documentos de cumplimiento según el marketplace (consulte la tabla de soporte de documentos del marketplace ).
Los desarrolladores que llamen a esta operación pueden asignar opcionalmente un packageDetails objeto, permitiéndoles ingresar un intervalo de tiempo preferido para cada pedido en su solicitud. En este caso, Amazon intentará programar los paquetes respectivos utilizando su configuración opcional. Por otro lado, es decir , si no se proporciona la franja horaria, Amazon elegirá la franja horaria más temprana posible.
Con respecto al formato de archivo de la etiqueta de envío, los desarrolladores externos pueden elegir entre PDF o ZPL, y Amazon creará la etiqueta en consecuencia.
Esta operación devuelve un array compuesta por los paquetes programados y una URL de corta duración que apunta a un archivo zip que contiene las etiquetas de envío generadas y los demás documentos habilitados para su marketplace. Si al menos no se puede programar un pedido, Amazon agrega el rejectedOrders list en la respuesta, que contiene una entrada para cada pedido que no pudimos procesar. Cada entrada se compone de un mensaje de error que describe el motivo de la falla, para que los sellers puedan tomar medidas.
La siguiente tabla muestra las tasas máximas de solicitudes y bursts admitidas:
Plan de uso:
| Tasa (solicitudes por segundo) | Burst |
|---|---|
| 1 | 5 |
El x-amzn-RateLimit-Limit El header de respuesta 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 burst para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y burst 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 Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Body | CreateScheduledPackagesRequest requerido | El body de la solicitud para la API POST /easyShip/2022-03-23/packages/bulk. | CreateScheduledPackagesRequest |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Success Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | CreateScheduledPackagesResponse |
| 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): ID de referencia de solicitud única. | ErrorList |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. 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): ID de referencia de solicitud única. | 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): ID de referencia de solicitud única. | 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): ID de referencia de solicitud única. | ErrorList |
| 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. x-amzn-RequestId (string): ID de referencia de solicitud única. | ErrorList |
| 500 | Your rate limit (solicitudes per second) for this operation. Note: For this status code, the rate limit header is deprecated and no longer returned.. 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): ID de referencia de solicitud única. | 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): ID de referencia de solicitud única. | ErrorList |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
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 |
|---|---|---|
| 415 | La payload de la solicitud está en un formato no admitido. Headers: x-amzn-RequestId (string): Identificador de referencia de solicitud único. | ErrorList |
Definiciones
PackageIdentifier
Identificador opcional creado por el seller que está impreso en la etiqueta de envío para ayudar al seller a identificar el paquete.
Tipo : string
PackageStatus
El estado del paquete.
Tipo : enum
| Valor | Descripción |
|---|---|
| ReadyForPickup | El paquete está listo para ser recogido. |
| PickedUp | El paquete ha sido recogido. |
| AtOriginFC | El paquete está en su centro logístico de origen. |
| AtDestinationFC | El paquete está en su centro logístico de destino. |
| Delivered | El paquete ha sido entregado. |
| Rejected | El paquete ha sido rechazado. |
| Undeliverable | El paquete no se puede entregar. |
| ReturnedToSeller | El paquete ha sido devuelto al seller. |
| LostInTransit | El paquete se ha perdido en tránsito. |
| LabelCanceled | La etiqueta del paquete ha sido cancelada. |
| DamagedInTransit | El paquete ha sido dañado en tránsito. |
| OutForDelivery | El paquete está fuera para la entrega. |
PackageId
Un identificador definido por Amazon para el paquete programado.
Tipo : string
TrackingDetails
Representación de metadatos de seguimiento.
| Nombre | Descripción | Esquema |
|---|---|---|
| trackingId opcional | El identificador de seguimiento del paquete programado. | String |
HandoverMethod
Identifica el método por el cual un seller entregará un paquete a Amazon Logistics.
Tipo : enum
| Valor | Descripción |
|---|---|
| Pickup | Un transportista de Amazon Logistics recogerá los paquetes en la dirección de recogida del seller. |
| Dropoff | El seller deberá dejar los paquetes en una ubicación designada. |
OrderScheduleDetails
Este objeto permite a los usuarios especificar un pedido para programarlo. Solo se requiere el amazonOrderId.
| Nombre | Descripción | Esquema |
|---|---|---|
| amazonOrderId requerido | Un identificador de pedido definido por Amazon. Identifica el pedido que el seller quiere entregar usando Amazon Easy Ship. | AmazonOrderId |
| packageDetails opcional | Detalles del paquete. Incluye packageItems, packageTimeSlot, y packageIdentifier. | PackageDetails |
AmazonOrderId
Un identificador de pedido definido por Amazon. Identifica el pedido que el seller quiere entregar usando Amazon Easy Ship.
Tipo : string
Dimension
El valor numérico de la dimensión especificada.
Tipo : número (flotante)
Mínimo : 0.01
Dimensions
Las dimensiones del paquete programado.
| Nombre | Descripción | Esquema |
|---|---|---|
| length opcional | La dimensión de longitud. | Dimension |
| width opcional | La dimensión del ancho. | Dimension |
| height opcional | La dimensión de la altura. | Dimension |
| unit opcional | La unidad de medida utilizada para medir la longitud. | UnitOfLength |
| identifier opcional | Identificador para las dimensiones del paquete personalizado. | String |
ListHandoverSlotsRequest
El esquema de solicitud para la operación listHandoverSlots.
| Nombre | Descripción | Esquema |
|---|---|---|
| marketplaceId requerido | Una string de hasta 255 caracteres. | String |
| amazonOrderId requerido | Un identificador de pedido definido por Amazon. Identifica el pedido que el seller quiere entregar usando Amazon Easy Ship. | AmazonOrderId |
| packageDimensions requerido | Las dimensiones del paquete programado. | Dimensiones |
| packageWeight requerido | El peso del paquete programado. | Peso |
ListHandoverSlotsResponse
El esquema de respuesta de la operación listHandoverSlots.
| Nombre | Descripción | Esquema |
|---|---|---|
| amazonOrderId requerido | Un identificador de pedido definido por Amazon. Identifica el pedido que el seller quiere entregar usando Amazon Easy Ship. | AmazonOrderId |
| timeSlots requerido | Una lista de franjas horarias. | TimeSlots |
InvoiceData
Número de factura y fecha.
Item
Información sobre el identificador del artículo y el número de serie.
| Nombre | Descripción | Esquema |
|---|---|---|
| orderItemId opcional | El identificador de artículo de pedido definido por Amazon. | orderItemId |
| orderItemSerialNumbers opcional | Una lista de números de serie para los artículos asociados con el OrderItemId valor. | OrderItemSerialNumbers |
Items
Una lista de elementos contenidos en el paquete.
Tipo : array < Item >
Artículos máximos : 500
OrderItemId
El identificador de artículo de pedido definido por Amazon.
Tipo : string
longitud máxima : 255
OrderItemSerialNumber
Un número de serie para un artículo asociado con el valor OrderItemId.
Tipo : string
longitud máxima : 255
OrderItemSerialNumbers
Una lista de números de serie para los artículos asociados con el valor OrderItemId.
Tipo : < Número de serie del artículo de pedido > array
Artículos máximos : 100
Package
Un paquete. Este objeto contiene todos los detalles del Easy Ship package programado, incluido el identificador del paquete, los atributos físicos como las dimensiones y el peso, el intervalo de tiempo seleccionado para entregar el paquete al transportista, el estado del paquete y los detalles de seguimiento/factura.
| Nombre | Descripción | Esquema |
|---|---|---|
| scheduledPackageId requerido | Identifica el paquete programado para ser actualizado. | ScheduledPackageId |
| packageDimensions requerido | Las dimensiones del paquete programado. | Dimensions |
| packageWeight requerido | El peso del paquete programado. | Weight |
| packageItems opcional | Una lista de elementos contenidos en el paquete. | Items |
| packageTimeSlot requerido | Una ventana de tiempo para entregar un Easy Ship package a Amazon Logistics. | TimeSlot |
| packageIdentifier opcional | Identificador opcional creado por el seller que está impreso en la etiqueta de envío para ayudar al seller a identificar el paquete. | PackageIdentifier |
| invoice opcional | Número de factura y fecha. | InvoiceData |
| packageStatuse opcional | El estado del paquete. | PackageStatus |
| trackingDetails opcional | Representación de metadatos de seguimiento. | TrackingDetails |
Packages
Una lista de paquetes.
| Nombre | Esquema |
|---|---|
| packages requerido | < Package > array |
PackageDetails
Detalles del paquete. Incluye packageItems, packageTimeSlot, y packageIdentifier.
| Nombre | Descripción | Esquema |
|---|---|---|
| packageItems opcional | Una lista de elementos contenidos en el paquete. | Items |
| packageTimeSlot requerido | Una ventana de tiempo para entregar un Easy Ship package a Amazon Logistics. | TimeSlot |
| packageIdentifier opcional | Identificador opcional creado por el seller que está impreso en la etiqueta de envío para ayudar al seller a identificar el paquete. | PackageIdentifier |
RejectedOrder
Un pedido que no pudimos programar en su nombre. Contiene su id e información sobre el error.
| Nombre | Descripción | Esquema |
|---|---|---|
| amazonOrderId requerido | Un identificador de pedido definido por Amazon. Identifica el pedido que el seller quiere entregar usando Amazon Easy Ship. | AmazonOrderId |
| error opcional | Respuesta de error devuelta cuando la solicitud no tiene éxito. | Error |
TimeSlot
Una ventana de tiempo para entregar un Easy Ship package a Amazon Logistics.
| Nombre | Descripción | Esquema |
|---|---|---|
| slotId requerido | Un identificador definido por Amazon para un intervalo de tiempo. | String |
| startTime opcional | La fecha y hora de inicio de la franja horaria. | DateTime |
| endTime opcional | La fecha y hora de finalización del intervalo de tiempo. | DateTime |
| handoverMethod opcional | El método por el cual un seller entregará un paquete a Amazon Logistics. | HandoverMethod |
TimeSlots
Una lista de franjas horarias.
Tipo : array < TimeSlot >
Artículos mínimos : 1
Artículos máximos : 500
ScheduledPackageId
Identifica el paquete programado para ser actualizado.
| Nombre | Descripción | Esquema |
|---|---|---|
| amazonOrderId requerido | Un identificador de pedido definido por Amazon. Identifica el pedido que el seller quiere entregar usando Amazon Easy Ship. | AmazonOrderId |
| packageId opcional | Un identificador definido por Amazon para el paquete programado. | PackageId |
CreateScheduledPackageRequest
El esquema de solicitud para la operación createScheduledPackage.
| Nombre | Descripción | Esquema |
|---|---|---|
| amazonOrderId requerido | Un identificador de pedido definido por Amazon. Identifica el pedido que el seller quiere entregar usando Amazon Easy Ship. | AmazonOrderId |
| marketplaceId requerido | Una string de hasta 255 caracteres. | String |
| packageDetails requerido | Detalles del paquete. Incluye packageItems, packageTimeSlot, y packageIdentifier. | PackageDetails |
UpdateScheduledPackagesRequest
El esquema de solicitud para el updateScheduledPackages operación.
| Nombre | Descripción | Esquema |
|---|---|---|
| marketplaceId requerido | Una string de hasta 255 caracteres. | String |
| updatePackageDetailsList requerido | Una lista de detalles de actualización del paquete. | UpdatePackageDetailsList |
UpdatePackageDetails
Solicitud de actualización de la franja horaria de un paquete.
| Nombre | Descripción | Esquema |
|---|---|---|
| scheduledPackageId requerido | Identifica el paquete programado para ser actualizado. | ScheduledPackageId |
| packageTimeSlot requerido | Una ventana de tiempo para entregar un Easy Ship package a Amazon Logistics. | TimeSlot |
UpdatePackageDetailsList
Una lista de detalles de actualización del paquete.
Tipo : <UpdatePackageDetails> array
Artículos mínimos : 1
Artículos máximos : 500
String
Una string de hasta 255 caracteres.
Tipo : string
minLongitud : 1
longitud máxima : 255
DateTime
Un valor de fecha y hora en formato ISO 8601.
Tipo : string (fecha-hora)
UnitOfLength
La unidad de medida utilizada para medir la longitud.
Tipo : enum
| Valor | Descripción |
|---|---|
| Cm | centímetros |
UnitOfWeight
La unidad de medida utilizada para medir el peso.
Tipo : enum
| Valor | Descripción |
|---|---|
| Grams | Gramos |
| G | Gramos |
CreateScheduledPackagesRequest
El body de la solicitud para la API POST /easyShip/2022-03-23/packages/bulk.
| Nombre | Descripción | Esquema |
|---|---|---|
| marketplaceId requerido | Una string de hasta 255 caracteres. | String |
| orderScheduleDetailsList requerido | un array que permite a los usuarios especificar los pedidos que se programarán. | < OrderScheduleDetails > array |
| labelFormat requerido | El formato de archivo en el que se creará la etiqueta de envío. | LabelFormat |
CreateScheduledPackagesResponse
El esquema de respuesta para la API de programación masiva. Regresa por la API de programación masiva que contiene un array de paquetes programados, una lista opcional de pedidos que no pudimos programar por el motivo y una URL prefirmada para un archivo ZIP que contiene las etiquetas de envío asociadas más los documentos habilitados para su marketplace.
| Nombre | Descripción | Esquema |
|---|---|---|
| scheduledPackages opcional | Una lista de paquetes. Referirse a Package objeto. | < Package > array |
| rejectedOrders opcional | Una lista de pedidos que no pudimos programar en su nombre. Cada elemento contiene el motivo y los detalles del error. | array |
| printableDocumentsUrl opcional | Una URL prefirmada para el documento zip que contiene las etiquetas de envío y los documentos habilitados para su marketplace. | URL |
URL
Una URL prefirmada para el documento zip que contiene las etiquetas de envío y los documentos habilitados para su marketplace.
Tipo : string
LabelFormat
El formato de archivo en el que se creará la etiqueta de envío.
Tipo : enum
| Valor | Descripción |
|---|---|
| - | |
| ZPL | - |
Weight
El peso del paquete programado.
| Nombre | Descripción | Esquema |
|---|---|---|
| value opcional | El peso del paquete. | WeightValue |
| unit opcional | La unidad de medida utilizada para medir el peso. | UnitOfWeight |
WeightValue
El peso del paquete.
Tipo : number (float)
Mínimo : 11.0
ErrorList
Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.
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 |
Updated over 1 year ago