GenerateAWBData¶
Crea una guía aérea (AWB) y devuelve su número y sus cargos. Para recibir también la etiqueta en PDF en la misma llamada, use GenerateAWBDataPrint.
URL¶
POST https://ocelot.servientrega.us/api/KiwiService20/kwapi/GenerateAWBData
POST https://ocelotkiwi.azurewebsites.net/api/KiwiService20/kwapi/GenerateAWBData
Parámetros¶
Se envían como JSON (Content-Type: application/json).
| Nombre | Tipo | Obligatorio | Reglas |
|---|---|---|---|
userId |
texto | Sí | Su usuario de Kiwi (el mismo con el que pide el token) |
password |
texto | Sí | Su contraseña de Kiwi. Distingue mayúsculas y minúsculas |
reference |
texto | Sí | Su número interno del envío o del pedido |
sender |
texto | Sí | Nombre del remitente |
senderAddress |
texto | Sí | Dirección del remitente |
senderPhone |
texto | Sí | Teléfono del remitente |
senderCity |
texto | Sí | Ciudad del remitente. Para envíos desde fuera de Estados Unidos, use MIAMI |
senderState |
texto | Sí | Estado del remitente. Para envíos desde fuera de Estados Unidos, use FL |
senderCountry |
texto | Sí | País del remitente, código ISO de 2 letras. Para envíos desde fuera de Estados Unidos, use US |
senderZip |
texto | Sí | Código postal de 5 dígitos. Para envíos desde fuera de Estados Unidos, use 33172 |
senderMail |
texto | No | Correo del remitente |
recipient |
texto | Sí | Nombre del destinatario |
recipientAddress |
texto | Sí | Dirección del destinatario |
recipientPhone |
texto | Sí | Teléfono del destinatario |
recipientCity |
texto | Sí | Nombre de la ciudad de destino, como aparece en el listado de ciudades de destino, o su código oficial |
recipientState |
texto | Condicional | Departamento, provincia o estado. Obligatorio si recipientCity es un nombre; opcional con el código oficial |
recipientId |
texto | Condicional | Número de identificación del destinatario. Obligatorio para Ecuador (EC); se valida el dígito de verificación |
recipientMail |
texto | No | Correo del destinatario. Recomendado: ayuda en la entrega de última milla |
destinationCountry |
texto | Sí | País de destino, código ISO de 2 letras: CO Colombia, EC Ecuador |
units |
número | Sí | Siempre 1 |
weight |
número | Sí | Peso en libras. De 0.001 a 110, hasta 3 decimales |
unitWeight |
texto | No | Envíe LB. Este método no convierte unidades: weight se toma siempre en libras y las medidas en pulgadas |
declaredValue |
número | Sí | Valor declarado en USD, hasta 2 decimales |
contentShipping |
texto | Sí | Descripción del contenido |
long |
número | Sí | Largo en pulgadas, hasta 2 decimales |
wide |
número | Sí | Ancho en pulgadas, hasta 2 decimales |
high |
número | Sí | Alto en pulgadas, hasta 2 decimales |
shippingType |
texto | Sí | SPX, DOC, CTC o BFR. Vea Tipos de envío y posiciones arancelarias |
tariffPosition |
texto | Sí | Posición arancelaria. Vea Tipos de envío y posiciones arancelarias |
AWBNumber |
número | Sí | 0, salvo que Servientrega USA le haya asignado un rango de números de guía |
Nota
Use punto (.) como separador decimal en todos los números.
Ejemplo de petición¶
curl -X POST "https://ocelot.servientrega.us/api/KiwiService20/kwapi/GenerateAWBData" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d @awb.json
curl -X POST "https://ocelotkiwi.azurewebsites.net/api/KiwiService20/kwapi/GenerateAWBData" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d @awb.json
awb.json:
{
"userId": "<YOUR_USERNAME>",
"password": "<YOUR_PASSWORD>",
"reference": "ORDER-10001",
"sender": "JOHN SAMPLE",
"senderAddress": "100 SAMPLE ST",
"senderPhone": "3055550100",
"senderCity": "MIAMI",
"senderState": "FL",
"senderCountry": "US",
"senderZip": "33172",
"senderMail": "sender@example.com",
"recipient": "MARIA EJEMPLO",
"recipientAddress": "CALLE 100 # 10-20 APTO 301",
"recipientPhone": "3005550100",
"recipientCity": "BARRANQUILLA",
"recipientState": "ATLANTICO",
"recipientId": "",
"recipientMail": "recipient@example.com",
"destinationCountry": "CO",
"units": 1,
"weight": 2.820,
"unitWeight": "LB",
"declaredValue": 146.78,
"contentShipping": "CLOTHING AND ACCESSORIES",
"long": 10.00,
"wide": 8.00,
"high": 4.00,
"shippingType": "SPX",
"tariffPosition": "98.07.20.00.00",
"AWBNumber": 0
}
Ejemplo de respuesta¶
{
"result": true,
"entities": [
{
"shippingId": 8800061,
"freightValue": 11.00,
"overFreightValue": 0.00,
"taxValue": 0.00,
"valueOthers": 0.00,
"totalValue": 11.00,
"volumeInvoice": 0.000
}
],
"messages": [
"Record created successfully",
"Time execution:1564 ms."
],
"notificationType": 3
}
| Campo | Significado |
|---|---|
shippingId |
Número de guía. Úselo para imprimir la etiqueta y para rastrear el envío |
freightValue |
Flete |
overFreightValue |
Sobreflete |
taxValue |
Impuestos |
valueOthers |
Otros cargos |
totalValue |
Total |
volumeInvoice |
Volumen calculado con las medidas enviadas (long, wide, high) |
Notas¶
- Revise
notificationTypeymessages: vea Respuestas. - Para obtener la etiqueta en PDF, llame a PrintAWB o a PrintAWBLabel con el
shippingId.