#
Webpack
#
1. Generar Envío
POST /api/shipping/create
El método permite generar un envío.
REQUEST
#
provider_data
provider: (Tipo de dato: string). Nombre del OOLL (Webpack). Campo obligatorio.
API_KEY: (Tipo de dato: string). Api key para autorizar el envío de request. Campo obligatorio.
#
shippment_data
origen.postal.calle: (Tipo de dato: string). Campo obligatorio.
origen.postal.numero:(Tipo de dato: string). Campo obligatorio.
origen.postal.piso:(Tipo de dato: string). Campo opcional.
origen.postal.depto:(Tipo de dato: string). Campo opcional.
origen.postal.firstName:(Tipo de dato: string). Primer nombre remitente. Campo obligatorio.
origen.postal.lastName:(Tipo de dato: string). Apellido del remitente. Campo obligatorio.
origen.postal.localidad: (Tipo de dato: string). Nombre de la ciudad de origen (Ej: Banfield). Campo obligatorio.
origen.postal.region: (Tipo de dato: string). Provincia a la cual pertenece la ciudad de origen (Ej: Buenos Aires). Campo obligatorio.
origen.postal.codigoPostal: (Tipo de dato: string). Código postal la ciudad de origen (Ej: Buenos Aires). Campo obligatorio.
destino.postal.firstName:(Tipo de dato: string). Primer nombre destinatario. Campo obligatorio.
destino.postal.lastName:(Tipo de dato: string). Apellido del destinatario. Campo obligatorio.
destino.postal.calle: (Tipo de dato: string). Campo obligatorio.
destino.postal.numero:(Tipo de dato: string). Campo obligatorio.
destino.postal.piso:(Tipo de dato: string). Campo opcional.
destino.postal.depto:(Tipo de dato: string). Campo opcional.
destino.postal.localidad: (Tipo de dato: string). Nombre de la ciudad de destino (Ej: Burzaco). Campo obligatorio.
destino.postal.region: (Tipo de dato: string). Provincia a la cual pertenece la ciudad de destino (Ej: Buenos Aires). Campo obligatorio.
destino.postal.codigoPostal: (Tipo de dato: string). Código Postal de la ciudad de destino. Campo obligatorio.
remitente.email:(Tipo de dato: string). Campo obligatorio.
remitente.telefonos: (Tipo de dato: string). Campo obligatorio.
destinatario.email: (Tipo de dato: string). Campo obligatorio.
destinatario.telefonos: (Tipo de dato: string). Campo obligatorio.
bultos.kilos: (Tipo de dato: string). Peso en gramos. Campo obligatorio.
bultos.altoCm: (Tipo de dato: string). Altura en Cm. Campo obligatorio.
bultos.anchoCm: (Tipo de dato: string). Ancho en Cm. Campo obligatorio.
bultos.largoCm: (Tipo de dato: string). Largo en Cm. Campo obligatorio.
idCliente: (Tipo de dato: string). Número de la orden. Campo obligatorio.
modalidad_envio: (Tipo de dato: string). Tiempo de entrega del envío, por ejemplo, "next_day". Campo obligatorio.
tipoServicio: (Tipo de dato: string). Tipo de servicio e envío que se va a emplear, por ejemplo, "cross_docking". Campo obligatorio.
{
"provider_data": {
"provider": "Webpack",
"API_KEY": "WA-VRAKoz6P9vKQspjj7lC2C7OIC"
},
"shippment_data": {
"origen": {
"postal": {
"codigoPostal": "1407",
"calle": "Burgos",
"numero": "120",
"piso": "2",
"depto": "C",
"localidad": "Almagro",
"region": "Buenos Aires",
"pais": "",
"entreCalle": "",
"firstName": "Jorge",
"lastName": "Fernández"
}
},
"fecha_alta": "",
"tipoServicio": "cross_docking",
"tipo_paquete": "",
"id_externo": "",
"modalidad_envio": "next_day",
"direccion_envio": "",
"correo": "",
"currency": "",
"type": "",
"destino": {
"sucursal": {
"id": ""
},
"postal": {
"codigoPostal": "1025",
"calle": "20 de Septiembre",
"numero": "1756",
"piso": "2",
"depto": "C",
"localidad": "Villa Devoto",
"region": "Buenos Aires",
"pais": "",
"entreCalle": "",
"firstName": "Juana",
"lastName": "González"
}
},
"remitente": {
"nombreCompleto": "",
"email": "remitente@andreani.com",
"documentoTipo": "",
"documentoNumero": "",
"telefonos": "113332244"
},
"destinatario": {
"nombreCompleto": "",
"email": "destinatario@andreani.com",
"documentoTipo": "",
"documentoNumero": "",
"telefonos": "1112345678"
},
"productoAEntregar": "",
"bultos": {
"kilos": "500",
"largoCm": "30",
"altoCm": "40",
"anchoCm": "10",
"volumenCm": "",
"valorDeclaradoSinImpuestos": "",
"valorDeclaradoConImpuestos": "",
"detalle": "",
"idCliente": "6543"
}
}
}
RESPONSE
numeroDeEnvio: Número de orden. Se utiliza para la obtención de etiqueta y el tracking (Estado de envío).
tracking_number: Número de tracking. Es el identificador del envío que figurará en la etiqueta.
{
response: "Success",
providerStatus: "Creado",
numeroDeEnvio: "6543",
tracking_number: "WM6543",
sucursalDeDistribucion: {
id: null,
descripcion: "",
},
sucursalDeRendicion: null,
sucursalDeImposicion: null,
numeroDePermisionaria: null,
descripcionServicio: null,
etiqueta: "",
}
#
2. Obtener etiqueta
GET /api/shipping/etiqueta/:id
Se emplea para rastrear obtener la etiqueta en formato ZPL.
REQUEST
- id: Número de envío obtenido en "Generar envío". Va en el id de la url como ruta parametrizada. Campo obligatorio.
Todos estos campos van en el header:
provider: Nombre del OOLL (Webpack). Campo obligatorio.
apiKey: Api key para autorizar el envío de request. Campo obligatorio.
provider: Webpack
apiKey: WA-VRAKoz6P9vKQspjj7lC2C7OIC
RESPONSE
Devuelve la etiqueta en formato ZPL.
#
3. Obtener tracking (Estado de envío)
GET /api/shipping/:id
Se emplea para rastrear el envío y obtener su status.
REQUEST
- id: Número de envío obtenido en "Generar envío". Va en el id de la url como ruta parametrizada. Campo obligatorio.
Todos estos campos van en el header:
provider: Nombre del OOLL (Webpack). Campo obligatorio.
apiKey: Api key para autorizar el envío de request. Campo obligatorio.
provider: Webpack
apiKey: WA-VRAKoz6P9vKQspjj7lC2C7OIC
RESPONSE
- providerStatus: Define el status del envío.
{
"response": "Success",
"providerStatus": "Entregado",
"numeroDeEnvio": "20000000001",
"sucursalDeDistribucion": {
"id": null,
"descripcion": null
},
"sucursalDeRendicion": null,
"sucursalDeImposicion": null,
"numeroDePermisionaria": null,
"descripcionServicio": "",
"etiqueta": ""
}