API: Método hacerEnvio()

URL

Descripción

Este método se encarga de realizar un envío con los parámetros enviados.

Formatos Soportados

  • text/php, text/xml, text/json, text/csv

Tipo de petición

  • POST

Petición

Parámetros

Los parámetros que se envían se agrupan en un array múltiple que pasamos a describir:

  • propiedades: Array con propiedades de la conexión:
    • version: Control interno de versiones del API. (1.0 por defecto)
    • moneda: Moneda en la que vamos a recibir los datos.
  • datosEnvio: Colección de arrays con los datos del envío.
    • desde: Array con datos de la dirección de origen del envío.
      • nombre: Nombre de la persona que envía.
      • direccion: Dirección origen del envío.
      • ciudad: Ciudad origen del envío.
      • cp: Código Postal origen del envío
      • pais: País origen del envío
      • telefono: Teléfono de contacto de la persona que envía
    • hasta: Array con datos de la dirección destino del envío
      • nombre: Nombre del receptor del envío.
      • direccion: Dirección destino del envío.
      • ciudad: Ciudad destino del envío.
      • cp: Código Postal destino del envío.
      • pais: País destino del envío.
      • telefono: Teléfono de contacto del destinatario.
    • paquetes: Array con datos de los paquetes que se envían.
      • peso: Peso del paquete.
      • x: Ancho del paquete.
      • y: Largo del paquete.
      • z: Alto del paquete.
    • costeMercancia: Coste de la mercancía, para el seguro.
    • referencia: Referencia identificativa del envío
    • agencia: ID de la agencia a consultar. Este ID se puede obtener del método consultarPrecio().
    • imprimir: ¿Desea imprimir las etiquetas? (1=si, 0=no).

Ejemplo

Ejemplo de la petición utilizando el plugin de PHP que podéis descargar y probar desde aquí.

// Origen del paquete 
$desde['nombre']="Usuario Uno";
$desde['direccion']="Calle de la Reina";
$desde['ciudad']="Lugo";
$desde['cp']='27002';
$desde['pais']='ES';
$desde['telefono']='982222222';
 
// Destino del paquete
$hasta['nombre']="Usuario Dos";
$hasta['direccion']="Plaza de España";
$hasta['ciudad']="Madrid";
$hasta['cp']='28080';
$hasta['pais']='ES';
$hasta['telefono']='911111111';
 
// Paquete o paquetes a enviar
$paquete[0]['peso']=3;
$paquete[0]['x']=1;
$paquete[0]['y']=3.65;
$paquete[0]['z']=25;
 
// Si quieres asegurar la mercancia establece la cantidad, sino asumimos 0
$valor=0;
 
// Establece la referencia de tu envio, podrás hacer traking con ella
$referencia='REF13258999999';
 
// ID de la Agencia con la que se hace el envío
$agencia=1;
 
// Si el método de la agencia lo permite puedes imprimir la etiqueta (1) o no (0)
$imprimir=1;
 
$envio=new enviosBidobido(array('formato'=>'text/xml','idioma'=>'es','codificacion'=>'utf-8', 'user'=>'usuario', 'pass'=>'password', 'server'=>'http://api.bidobido.com:81'));
 
// Hacer el envío
$vuelta=$envio->hacerEnvio($desde,$hasta,$paquete,$valor,$referencia,$agencia,$imprimir);

Respuesta

Parámetros

  • precio: Coste que se ha cobrado por el envío.
  • referencia: Referencia del envio (para hacer tracking por ejemplo).
  • paquete: Datos específicos del paquete.
    • tracking: ID de tracking.
    • imagen: URL donde se encuentra la imagen de la etiqueta a imprimir.

text/php

Array
(
        [respuesta] => Array
        (
            [precio] => 6.26
            [referencia] => REF13258999999
            [paquete] => Array
            (
                    [tracking] => "1Z8F57W59195968613"
                    [imagen] => "http://bidobido.desarrollo/_img/upload/3/etiquetas/1Z8F57W591983386282.gif"
            )
        )
)

text/json

{
	"respuesta":
	{
		"precio":"6.26",
		"referencia":"REF13258999999",
		"paquete":
		[{
			"tracking":"1Z8F57W59195968613",
			"imagen":"http:\/\/bidobido.desarrollo\/_img\/upload\/3\/etiquetas\/1Z8F57W591959686132.gif"
		}]
	}
}

text/xml

<respuesta>
	<precio>6.26</precio>
	<referencia>REF13258999999</referencia>
	<paquete>
		<tracking>1Z8F57W59195968613</tracking>
		<imagen>http://bidobido.desarrollo/_img/upload/3/etiquetas/1Z8F57W591983386282.gif</imagen>
	</paquete>
</respuesta>

Comentarios