Guía de casos de uso de la API de envío de gestión logística directa del proveedor v1
Cómo ayudar a los proveedores del programa de gestión logística directa (DF) a utilizar la API de envíos para gestionar sus operaciones de gestión logística directa.
Versión de API: v1
¿Qué es la API de envíos de gestión logística directa?
Vendors can use the Direct Fulfillment Shipping API to exchange shipment related documents with Amazon. Vendors can request shipping labels, receive shipping labels, send shipment confirmations, get packing slips, and retrieve customer invoices.
Ten en cuenta que las facturas de clientes son específicas de la región de la India.
Están disponibles las siguientes operaciones:
Operación | Método HTTP | Path | Descripción |
---|---|---|---|
submitShippingLabelRequest
|
POST | /vendor/directFulfillment/shipping/v1/shippingLabels |
Enviar solicitudes de etiquetas de envío únicas o múltiples. |
getShippingLabels
|
GET | /vendor/directFulfillment/shipping/v1/shippingLabels |
Obtener una lista de etiquetas de envío según el criterio del filtro. Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide. |
getShippingLabel
|
GET |
|
Obtener una etiqueta de envío por número de pedido. Nota: las etiquetas de envío caducarán 90 días después de su creación mediante una solicitud de envío de etiqueta de envío, por lo que no se deben solicitar etiquetas de envío con más de 90 días de antigüedad. |
submitShipmentConfirmations
|
POST | /vendor/directFulfillment/shipping/v1/shipmentConfirmations |
Enviar una o varias confirmaciones de envío a Amazon. |
submitShipmentStatusUpdates
|
POST | /vendor/directFulfillment/shipping/v1/shipmentStatusUpdates |
Enviar una actualización del estado del envío. Solo proveedores de transportistas propiedad del proveedor. |
getPackingSlips
|
GET | /vendor/directFulfillment/shipping/v1/packingSlips |
Obtener una lista de comprobantes de envío según el intervalo de fechas de creación. Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide. |
getPackingSlip
|
GET | /vendor/directFulfillment/shipping/v1/packingSlips/{purchaseOrderNumber} |
Obtener el comprobante de envío de un pedido específico por número de pedido. Nota: la obtención de datos solo puede retroceder seis meses, lo que significa que createdBefore no puede ser anterior a seis meses en el pasado. |
getCustomerInvoices
|
GET | /vendor/directFulfillment/shipping/v1/customerInvoices |
Obtener una lista de facturas de clientes en función de los criterios de filtro. Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide. |
getCustomerInvoice
|
GET | /vendor/directFulfillment/shipping/v1/customerInvoices/{purchaseOrderNumber} |
Obtener una factura de cliente por número de pedido de compra. Nota: la obtención de datos solo puede retroceder seis meses, lo que significa que createdBefore no puede ser anterior a seis meses en el pasado. |
submitShippingLabelRequest
The submitShippingLabelRequest
operation allows vendors to request shipping label information from Amazon for each purchase order. You can send multiple shipping label requests in bulk in one API call by adhering to the schema. When shipment labels are created by Amazon, they will be available to download using the getShippingLabel
operation.
Comprobación de las solicitudes de etiquetas de envío enviadas correctamente
Vendors can verify the status of their shipping label requests using the Direct Fulfillment Transaction Status API. Allow the system up to 15 min to show the status after submission. If the transaction status is not updated after 30 minutes, open a Contact Us case in Vendor Central.
Proceso de integración con la API de solicitud de etiquetas de envío
En el siguiente diagrama se muestra el proceso para enviar solicitudes de etiquetas de envío.
Requisitos empresariales
Amazon debe recibir una solicitud de etiqueta de envío después de que el proveedor haya confirmado la aceptación del pedido mediante la API de confirmación del pedido.
Si utilizas etiquetas de envío propias de Amazon, el envío de la información del artículo o paquete en la solicitud es opcional.
Requisitos empresariales específicos de país
No existen requisitos específicos de país.
Solicitud de submitShippingLabelRequest
To request shipping labels, call the submitShippingLabelRequest
operation and pass the following parameter:
Parámetro del cuerpo:
Nombre |
Descripción |
Obligatorio |
---|---|---|
shippingLabelRequests |
Solicitar una o varias etiquetas de envío. Type: <
|
Sí |
Ejemplo de solicitud:
POST "https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels"
{
"shippingLabelRequests": [
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"containers": [
{
"containerType": "carton",
"containerIdentifier": "123",
"trackingNumber": "XXXX",
"dimensions": {
"length": "12",
"width": "12",
"height": "12",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "B07DFVDRAB",
"packedQuantity": {
"amount": 1,
"unitOfMeasure": "Each"
}
}
]
}
]
}
]
}
Respuesta de submitShippingLabelRequest
Una respuesta correcta incluye lo siguiente:
Nombre |
Descripción |
Obligatorio |
---|---|---|
transactionId
|
GUID para identificar esta transacción. Este valor puede utilizarse con la API de estado de transacciones para obtener el estado de esta transacción. Tipo: cadena |
No |
Ejemplo de respuesta:
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
getShippingLabels
The getShippingLabels
operation returns shipping labels for all orders which meet the filter criteria specified in the request. You must have already requested shipping labels using the submitShippingLabelRequest
operation before you use this API to get shipping labels available to you for fulfillment. Amazon recommends that vendors check for shipping labels at least once per hour during business hours. Depending on your business volume, you can choose to check more frequently. You can get up to 100 shipping labels in one API call. If there are more than 100 shipping labels you can use the nextToken value to get the next set of shipping labels.
Token de datos restringidos para autorización
This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide.
En el siguiente diagrama se muestra el proceso de integración cuando se recuperan etiquetas de envío:
Solicitud de getShippingLabels
To retrieve a list of shipping labels, call the getShippingLabels
operation and pass the following parameters:
Parámetros de consulta:
Nombre | Descripción | Obligatorio |
---|---|---|
shipFromPartyId |
El WarehouseID del proveedor desde el que se gestionará el pedido. Si no se especifica, el resultado contendrá los pedidos de todos los almacenes. Tipo: cadena |
No |
limit |
El límite del número de registros devueltos. Mínimo: 1 Máximo: 100 Tipo: entero |
No |
createdAfter |
Las etiquetas de envío que estén disponibles después de esta fecha y hora se incluirán en el resultado. Deben estar en formato de fecha/hora ISO-8601. Tipo: cadena (fecha-hora) |
Sí |
createdBefore |
Las etiquetas de envío que estén disponibles antes de esta fecha y hora se incluirán en el resultado. Deben tener el formato de fecha y hora ISO-8601. Tipo: cadena (fecha-hora) |
Sí |
sortOrder |
Ordenar en orden ascendente (ASC ) o descendente (DESC ) por fecha de creación del pedido. Type: enum (
|
No |
nextToken |
Se utiliza para la paginación cuando hay más etiquetas de envío que el límite de tamaño de resultado especificado. El valor del token se devuelve en la llamada anterior a la API. Tipo: cadena |
No |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC
Respuesta de getShippingLabels
Una respuesta correcta incluye lo siguiente:
Nombre | Descripción | Obligatorio |
---|---|---|
pagination |
Si se devuelven más de 100 etiquetas de envío, nextToken se devuelve en la respuesta de la paginación. Tipo: cadena |
No |
shippingLabels |
Lista de etiquetas de envío. Type: <
|
No |
Ejemplo de respuesta:
{
"pagination": {
"nextToken": "MDAwMDAwMDAwMQ=="
},
"shippingLabels": [
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG001",
"trackingNumber": "1Z6A34Y60369738804",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here "
}
]
},
{
"purchaseOrderNumber": "2JK3S9VD",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG002",
"trackingNumber": "1Z6A34Y60369738805",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here "
}
]
}
]
}
Obtener la etiqueta de envío
The getShippingLabel
operation returns information about the shipping label that you specify using the purchase order number. The response includes complete shipping label information for the purchase order, including label type, purchase order details and ship method.
You can also use this API to get details for any shipping label (in the time range of seven days from a rolling window of the last six months, after the vendor went live on API).
En el siguiente diagrama se muestra el proceso de integración para recuperar una etiqueta de envío específica:
¿Hasta cuándo debe solicitarse la etiqueta de envío?
Las etiquetas ZPL y PNG solo deben solicitarse el día en que se vayan a enviar los pedidos.
Requisitos empresariales específicos de país
No existen requisitos específicos de país para las respuestas de etiquetas de envío.
Solicitud de getShippingLabel
To request a shipping label, call the getShippingLabel
operation and pass the following parameter:
Parámetro de ruta:
Nombre | Descripción | Obligatorio |
---|---|---|
purchaseOrderNumber
|
El número de pedido del que deseas devolver la etiqueta de envío. Debe ser el mismo purchaseOrderNumber que el que se especifica en el pedido. Tipo: cadena |
Sí |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels/2JK3S9VC
Respuesta de getShippingLabel
Una respuesta correcta incluye lo siguiente:
Nombre | Descripción | Obligatorio |
---|---|---|
purchaseOrderNumber
|
Este campo contendrá el número de pedido de este pedido. Tipo: cadena |
Sí |
sellingParty
|
ID del vendedor o proveedor. Type:
|
Sí |
shipFromParty
|
Código de almacén del proveedor. Type: PartyIdentification |
Sí |
labelFormat
|
Formato de la etiqueta. enum ( LabelFormat ) |
Sí |
labelData
|
Proporciona los detalles de los paquetes de este envío. Type: <
|
Sí |
Ejemplo de respuesta:
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG001",
"trackingNumber": "1Z6A34Y60369738804",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here"
}
]
}
submitShipmentConfirmations
The submitShipmentConfirmations
operation lets vendors submit shipment confirmations to Amazon. Your shipment confirmation allows us to efficiently track your shipments and inform our customers. It contains information about the items being shipped, including purchase order number, ship date, estimated delivery date, and tracking number.
Las confirmaciones de envío nos permiten colaborar más eficazmente con los transportistas en el seguimiento de tus envíos.
La falta de confirmaciones de envío válidas puede dar lugar a:
-
Visibilidad inadecuada sobre los envíos.
-
Errores al conciliar los envíos físicos con los pedidos de compra.
-
Seguimiento manual para resolver discrepancias.
Comprobación de confirmaciones de envío enviadas correctamente
Vendors can verify the status of their shipment confirmations via Vendor Central > Orders > Direct Fulfillment Orders or using the Direct Fulfillment Transaction Status API. Allow the system up to 10 min to determine the status after submission. If Vendor Central is not showing the correct values for the shipment confirmation, open a Contact Us case in Vendor Central. Refer to the Business Requirements section for information about creating shipment confirmations.
En el siguiente diagrama se muestra el proceso de integración para el envío de confirmaciones de envío:
Requisitos empresariales
Debes usar esta API para confirmar el envío de un pedido en un plazo de 4 horas a partir del envío del pedido desde tu almacén.
En el caso de envíos denegados, establece el valor del campo shipmentStatus
en FLOOR_DENIAL
.
Todas las líneas de pedido del pedido de compra deben incluirse en la confirmación de envío. No se permite la gestión logística parcial del pedido. Los proveedores deben rechazar el pedido como “Denegación de piso” si alguna de las líneas de pedido no está disponible para su envío.
El itemSequenceNumber
de un artículo debe ser el mismo que el recibido en el mensaje de pedido.
Es obligatorio el buyerProductIdentifier
o el vendorProductIdentifier
para enviar la confirmación de envío. Debes enviar el mismo valor que recibiste en el pedido.
Para los transportistas propiedad del proveedor, el envío de scacCode
es obligatorio.
Si Amazon proporciona la etiqueta de envío, la sección de contenedores es opcional, ya que Amazon tiene acceso a la información del paquete. Es obligatorio enviar la sección de artículos.
El contenedor en una confirmación de envío debe tener un shipMethod
especificado.
Requisitos empresariales específicos de país
Ninguno
Solicitud de submitShipmentConfirmations
To submit shipment confirmations, call the submitShipmentConfirmations
operation and pass the following parameter:
Parámetro del cuerpo:
Nombre | Descripción | Obligatorio |
---|---|---|
shipmentConfirmations |
Lista de envíos confirmados Type: <
|
Sí |
Ejemplo de solicitud:
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shipmentConfirmations
{
"shipmentConfirmations": [
{
"purchaseOrderNumber": "PO00050003",
"shipmentDetails": {
"shippedDate": "2019-08-07T19:56:45.632Z",
"shipmentStatus": "SHIPPED",
"isPriorityShipment": true,
"estimatedDeliveryDate": "2019-08-07T19:56:45.632Z"
},
"sellingParty": {
"partyId": "VENDORCODE"
},
"shipFromParty": {
"partyId": "VENDORWAREHOUSECODE"
},
"items": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "ASIN001",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 2,
"buyerProductIdentifier": "ASIN002",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 3,
"buyerProductIdentifier": "ASIN003",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 4,
"buyerProductIdentifier": "ASIN004",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
],
"containers": [
{
"containerType": "carton",
"containerIdentifier": "123",
"trackingNumber": "TRACK001",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "ASIN001",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "234",
"trackingNumber": "TRACK002",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 2,
"buyerProductIdentifier": "ASIN002",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "ABCD",
"trackingNumber": "TRACK003",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 3,
"buyerProductIdentifier": "ASIN003",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "id12",
"trackingNumber": "TRACK004",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 4,
"buyerProductIdentifier": "ASIN004",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
}
]
}
]
}
Respuesta de submitShipmentConfirmations
Una respuesta correcta incluye lo siguiente:
Nombre | Descripción | Obligatorio |
---|---|---|
transactionId |
GUID para identificar esta transacción. Este valor puede utilizarse con la API de estado de transacciones para obtener el estado de esta transacción. Tipo: cadena |
Sí |
Ejemplo de respuesta:
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
submitShipmentStatusUpdates
Importante
Solo los proveedores VOC (Vendor Own Carrier, transportista propiedad del proveedor) pueden utilizar las actualizaciones de estado de los envíos. Esto se refiere a proveedores que utilizan sus propios servicios de transporte para entregar el envío y no utilizan transportistas de Amazon para transportar el envío al cliente. En última instancia, los proveedores asumirán los costes de transporte y la responsabilidad de entregar el envío al cliente.
The submitShipmentStatusUpdates
operation allows vendors to update the transportation status event for shipments that are on route to the final customer. VOC vendors are required to update shipment status (commonly known as scans) during the transportation phase.
Esta información se remitirá a los clientes de Amazon en la página "Mis pedidos" y mejorará así la visibilidad en el proceso de seguimiento y entrega de los pedidos.
No actualizar el estado del envío puede resultar en KPI operativos deficientes, como: una velocidad de escaneo baja y, en última instancia, la suspensión del almacén.
Comprobación de actualizaciones de estado de envíos enviadas correctamente
Vendors can verify the status of their shipment status updates via Vendor Central > Orders > Direct Fulfillment Orders or by using the Direct Fulfillment Transaction Status API. Allow the system up to 10 min to determine the status after submission. If Vendor Central is not showing the correct values for the shipment confirmation, open a Contact Us case in Vendor Central. Refer to the Business Requirements section for information about creating shipment confirmations.
En el siguiente diagrama se muestra el proceso de integración para el envío de actualizaciones de estado del envío:
Requisitos empresariales
Debes usar esta API solo si eres un proveedor de VOC (transportista propio del proveedor), lo que significa que utilizas tu propio transportista para transportar el envío al cliente.
Solo debes utilizar esta API para actualizar el estado de un envío una vez que se haya confirmado a través de la API de confirmación de envío o la confirmación de envío de Vendor Central.
El trackingNumber
de la API de estado de envío debe coincidir al 100 % con el trackingNumber
indicado en la confirmación de envío; de lo contrario, la actualización del estado de envío fallará.
Una llamada a la API de actualización del estado de envío debe corresponder a un paquete físico. Puedes actualizar el estado de envío de varios paquetes en una sola llamada a la API, agrupándolos en lotes como una serie de actualizaciones del estado de envío.
Un pedido de gestión logística directa puede dar lugar a la entrega de varios paquetes físicos al cliente. Por lo tanto, se requieren varias actualizaciones del estado de envío para reflejar el estado de entrega completo de todo el pedido.
Los proveedores deben enviar el estado del envío siempre que sea posible, siguiendo las directrices de Amazon sobre el estado del envío.
En el caso de los pedidos con entrega programada, los proveedores deben enviar la matriz shipmentSchedule
que especifica la hora y el plazo de entrega estimado.
Requisitos empresariales específicos de país
Ninguno
Explicación de los campos adicionales
statusCode
and reasonCode
Estos campos son códigos estándar utilizados en las normas EDI (por ejemplo, ISA X12 y EDIFACT) que se utilizan para proporcionar un evento de estado específico y el motivo del evento de estado. Se espera una combinación específica de statusCode
y reasonCode
que determine un evento en la fase de transporte del envío al cliente final.
Estos son los códigos de estado y motivo que admitimos y su equivalencia con Vendor Central actual:
Código de estado EDIFACT | Código de motivo EDIFACT | Descripción operativa | Equivalencia con la IU de Vendor Central |
---|---|---|---|
404 | 117 | El envío se ha retrasado debido a un accidente grave | DELAYED |
301 | 000 | El envío se ha entregado al cliente | DELIVERED |
101 | 000 | El envío ha salido del centro logístico | DEPARTED\_FROM\_FC |
201 | 000 | El envío ha llegado a las instalaciones del transportista | IN\_TRANSIT |
409 | 000 | El transportista ha perdido el envío | LOST |
302 | 000 | El envío está listo para la entrega | OUT\_FOR\_DELIVERY |
407 | 000 | El destinatario se ha negado a aceptar el envío | REJECTED |
416 | 000 | El envío no puede entregarse y será destruido | UNDELIVERABLE |
Código de estado X12 | Código de motivo X12 | Descripción operativa | Equivalencia con la IU de Vendor Central |
---|---|---|---|
DE | AF | El envío se ha retrasado debido a un accidente grave | DELAYED |
D1 | NS | El envío se ha entregado al cliente | DELIVERED |
XB | NS | El envío ha salido del centro logístico | DEPARTED\_FROM\_FC |
O1 | NS | El envío ha llegado a las instalaciones del transportista | IN\_TRANSIT |
CA | PL | El transportista ha perdido el envío | LOST |
OD | NS | El envío está listo para la entrega | OUT\_FOR\_DELIVERY |
A7 | AM | El destinatario se ha negado a aceptar el envío | REJECTED |
AP | BG | El envío no puede entregarse y será destruido | UNDELIVERABLE |
Solicitud de submitShipmentStatusUpdates
To submit shipment status updates, call the submitShipmentStatusUpdates
operation and pass the following parameter:
Parámetro del cuerpo:
Nombre | Descripción | Obligatorio |
---|---|---|
shipmentStatusUpdates |
Lista de envíos confirmados. Type: <
|
Sí |
Ejemplo de solicitud:
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates
{
"shipmentStatusUpdates": [
{
"purchaseOrderNumber": "DX00050015",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"statusUpdateDetails": {
"trackingNumber": "TRACK005",
"statusCode": "D1",
"reasonCode": "NS",
"statusDateTime": "2020-08-07T19:56:45Z",
"statusLocationAddress": {
"city": "Any Town",
"postalCode": "98101",
"stateOrRegion": "Washington",
"countryCode": "US"
}
}
}
]
}
Respuesta de submitShipmentStatusUpdates
Una respuesta correcta incluye lo siguiente:
Nombre | Descripción | Obligatorio |
---|---|---|
transactionId |
GUID para identificar esta transacción. Este valor puede utilizarse con la API de estado de transacciones para obtener el estado de esta transacción. Tipo: cadena |
Sí |
Ejemplo de respuesta:
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
getPackingSlips
The getPackingSlips
operation returns a list of packing slips for the orders which meet the criteria specified. If you need to get a packing slip for a specific order, use the getPackingSlip
operation instead.
Token de datos restringidos para autorización
This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide.
Debes utilizar esta API para obtener los comprobantes de envío de los pedidos disponibles para su gestión logística. Amazon recomienda que los proveedores comprueben los pedidos al menos una vez cada hora durante el horario comercial. En función del volumen empresarial, puedes optar por realizar comprobaciones con mayor frecuencia. Puedes obtener hasta 100 comprobantes de envío en una llamada a la API. Si hay más de 100 comprobantes de envío, puedes utilizar el valor de nextToken como parámetro en tu siguiente solicitud para obtener el siguiente conjunto.
En el siguiente diagrama se muestra el proceso de integración cuando se recuperan comprobantes de envío:
Solicitud de getPackingSlips
To retrieve packing slips, call the getPackingSlips
operation and pass the following parameters:
Parámetros de consulta:
Nombre | Descripción | Obligatorio |
---|---|---|
shipFromPartyId |
El proveedor warehouseId para la gestión logística del pedido. Si no se especifica, el resultado contendrá los pedidos de todos los almacenes. Tipo: cadena |
No |
limit |
El límite del número de registros devueltos. Mínimo: 1 Máximo: 100 Tipo: entero |
No |
createdAfter |
Los comprobantes de envío que estén disponibles después de esta fecha y hora se incluirán en el resultado. Deben estar en formato de fecha/hora ISO-8601. Tipo: cadena (fecha-hora) |
Sí |
createdBefore |
Los comprobantes de envío que estén disponibles antes de esta fecha y hora se incluirán en el resultado. Deben estar en formato de fecha/hora ISO-8601. Tipo: cadena (fecha-hora) |
Sí |
sortOrder |
Ordenar ASC o DESC por la fecha de creación del comprobante de envío. Type: enum (
|
No |
nextToken |
Se utiliza para la paginación cuando hay más comprobantes de envío que el límite de tamaño de resultado especificado. El valor del token se devuelve en la llamada anterior a la API. Tipo: cadena |
No |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/packingSlips?createdBefore=2020-06-12T12:00:00-08:00&createdAfter=2020-06-12T00:00:00-08:00&limit=2&sortOrder=DESC
Respuesta de getPackingSlips
Una respuesta correcta incluye lo siguiente:
Nombre | Descripción | Obligatorio |
---|---|---|
pagination |
Si se devuelven más de 100 pedidos, nextToken se devuelve en la respuesta de la paginación. Tipo: cadena |
No |
packingSlips |
Incluye detalles de los comprobantes de envío. Type: <
|
No |
Ejemplo de respuesta:
{
"payload": {
"pagination": {
"nextToken": "NEBxNEBxNEBxNR=="
},
"packingSlips": [
{
"purchaseOrderNumber": "UvgABdBjQ",
"content": "base64 encoded string",
"contentType": "application/pdf"
}, {
"purchaseOrderNumber": "VvgCDdBjR",
"content": "base64 encoded string",
"contentType": "application/pdf"
}
]
}
}
getPackingSlip
The getPackingSlip
operation returns information about the specific packing slip that you specify using the purchase order number. The response includes a base64 encoded string of the packing slip. The content type will always be "application/pdf".
En el siguiente diagrama se muestra el proceso de integración cuando se recupera un comprobante de envío:
Solicitud de getPackingSlip
To return a packing slip, call the getPackingSlip
operation and pass the following parameter:
Parámetro de ruta:
Nombre | Descripción | Obligatorio |
---|---|---|
purchaseOrderNumber |
El purchaseOrderNumber del comprobante de envío que quieras. Tipo: cadena |
Sí |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com /vendor/directFulfillment/shipping/v1/packingSlips/UkP3YkKDr
Respuesta de getPackingSlip
Una respuesta correcta incluye lo siguiente:
Nombre | Descripción | Obligatorio |
---|---|---|
purchaseOrderNumber |
Número de pedido del envío al que está destinado el comprobante de envío. Tipo: cadena |
No |
packingSlip |
Información del comprobante de envío. Type:
|
No |
Ejemplo de respuesta:
{
"payload": {
"purchaseOrderNumber": "UvgABdBjQ",
"content": "base64 encoded string",
"contentType": "application/pdf"
}
}
Obtenga facturas de clientes
The getCustomerInvoices
operation returns customer invoices for all purchase orders which meet the filter criteria you specify. The use of this API is mandatory only in the India region and not required in any other region. Amazon recommends that vendors check for customer invoices at least once per hour during business hours. Depending on your business volume, you can choose to check more frequently. You can get up to 100 customer invoices in one API call. If there are more than 100 customer invoices you can use the nextToken
value as a parameter in the next request to get the next set of customer invoices.
Token de datos restringidos para autorización
This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide.
En el siguiente diagrama se muestra el proceso de integración cuando se recuperan facturas de clientes:
Solicitud de getCustomerInvoices
To return customer invoices, call the getCustomerInvoices
operation and pass the following parameters:
Parámetros de consulta:
Nombre | Descripción | Obligatorio |
---|---|---|
shipFromPartyId |
El proveedor warehouseId para la gestión logística del pedido. Si no se especifica, el resultado contendrá los pedidos de todos los almacenes. Tipo: cadena |
No |
limit |
El límite del número de registros devueltos. Mínimo: 1 Máximo: 10 Tipo: entero |
No |
createdAfter |
Los pedidos que estén disponibles después de esta fecha y hora se incluirán en el resultado. Deben estar en formato de fecha/hora ISO-8601. Tipo: cadena (fecha-hora) |
Sí |
createdBefore |
Los pedidos que estén disponibles antes de esta fecha y hora se incluirán en el resultado. Deben estar en formato de fecha/hora ISO-8601. Tipo: cadena (fecha-hora) |
Sí |
sortOrder |
Ordena de forma ascendente o descendente por fecha de creación del pedido. Type: enum (
|
No |
nextToken |
Se utiliza para la paginación cuando hay más pedidos que el límite de tamaño de resultado especificado. El valor del token se devuelve en la llamada anterior a la API. Tipo: cadena |
No |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/customerInvoices?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC
Respuesta de getCustomerInvoices
Una respuesta correcta incluye lo siguiente:
Nombre | Descripción | Obligatorio |
---|---|---|
pagination |
Si se devuelven más de 100 facturas de clientes, nextToken se devuelve en la respuesta para la paginación. Tipo: cadena |
No |
customerInvoices |
Lista de facturas de clientes. Type: <
|
No |
Ejemplo de respuesta:
{
"pagination": {
"nextToken": "MDAwMDAwMDAwMQ=="
},
"customerInvoices": [
{
"purchaseOrderNumber": "PO98676856",
"content": "base 64 content goes here"
}
]
}
Obtenga la factura del cliente
The getCustomerInvoice
operation returns information about the customer invoice that you specify using the purchase order number. The response includes complete customer invoice information for that purchase order.
También puedes utilizar esta API para obtener detalles de cualquier factura de cliente (dentro de los 7 días de un plazo continuo de los últimos 6 meses, después de que el proveedor haya lanzado la API).
En el siguiente diagrama se muestra el proceso de integración para devolver una factura de cliente:
Requisitos empresariales específicos de país
Solo en la región de la India se debe utilizar la API de factura de cliente.
Solicitud de getCustomerInvoice
To return a customer invoice, call the getCustomerInvoice
operation and pass the following parameter:
Parámetro de ruta:
Nombre | Descripción | Obligatorio |
---|---|---|
purchaseOrderNumber |
Número de pedido del envío por el que se va a devolver la factura. Tipo: cadena |
Sí |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels/2JK3S9VC
Respuesta de getCustomerInvoice
Una respuesta correcta incluye lo siguiente:
Nombre | Descripción | Obligatorio |
---|---|---|
purchaseOrderNumber |
El número de pedido de ese pedido. Tipo: cadena |
Sí |
content |
La factura de cliente codificada en Base64. Tipo: cadena |
Sí |
Ejemplo de respuesta:
{
"payload": {
"purchaseOrderNumber": "PO98676856",
"content": "base 64 encoded string"
}
}
Updated 23 days ago